Class: Data

Help4.widget.learning.Data(params)

Data handler for learning widget.

Constructor

new Data(params)

Parameters:
Name Type Description
params Help4.widget.learning.Data.Params
Properties:
Name Type Description
showLearningCenter boolean whether the learning center shall be shown
learningCenterUrl string URL to external learning center
learningAppCommunityUrl string URL to learning community
assets Help4.jscore.DataContainer container of learning assets
__widget Help4.widget.learning.Widget
__backend * see Help4.widget.learning.Backend
Source:

Extends

Methods

(protected) ____defineDataFunctions()

Overrides:
Source:

(protected) ____defineProperty(args)

Parameters:
Name Type Description
args Object
Properties
Name Type Attributes Default Description
type string <optional>
 'param' for Help4.jscore.DataBase
key string
info Help4.jscore.ControlBase.Param
funGet Help4.jscore.ControlBase.FunGet
funSet Help4.jscore.ControlBase.FunSet
Overrides:
Source:

(protected) ____defineStaticProperties()

auto define all to be cleaned properties
Overrides:
Source:
Throws:
Error

(protected) ____extendParams(dest, src) → {Object}

Parameters:
Name Type Description
dest Object
src Object
Overrides:
Source:
Returns:
Type
Object

(protected) ____getClassConfig() → {Help4.jscore.Base.Params}

Overrides:
Source:
Returns:
Type
Help4.jscore.Base.Params

(protected) ____getData() → {Object}

Overrides:
Source:
Returns:
Type
Object

(protected) ____mergeDerivedParams(level0, level1)

Parameters:
Name Type Description
level0 Help4.jscore.Base.Params
level1 Help4.jscore.Base.Params
Overrides:
Source:
Throws:
Error

(protected) ____resolveDerivedParams(classConfig)

Parameters:
Name Type Description
classConfig Help4.jscore.Base.Params
Overrides:
Source:

(protected) _destroyControl(…keys)

destroys class properties
Parameters:
Name Type Attributes Description
keys string <repeatable>
Overrides:
Source:

(protected) _fireEvent(event) → {Help4.jscore.Base}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

(async, protected) _fireEvent2(event) → {Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Overrides:
Source:
Returns:
Type
Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>

(protected) _fireEventSync(event) → {Array.<Help4.EmbeddedEvent.EventResponse>}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Overrides:
Source:
Returns:
Type
Array.<Help4.EmbeddedEvent.EventResponse>

(protected) _onAfterRetrieve(key)

called after a retrieve operation completed
Parameters:
Name Type Description
key string the value that has changed
Overrides:
Source:

(async, protected) _onRetrieveReady(key) → {Promise.<void>}

called after a retrieve operation completed; retrieve will await this function
Parameters:
Name Type Description
key string the value that has changed
Overrides:
Source:
Returns:
Type
Promise.<void>

activate() → {Promise.<void>}

update data on activate
Overrides:
Source:
Returns:
Type
Promise.<void>

addListenerSync(eventType, listener) → {Help4.jscore.Base}

add an event listener
Parameters:
Name Type Description
eventType string | Array.<string> event type to be observed
listener Help4.EmbeddedEvent.Listener the callback function
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

clean()

cleans all stored data
Overrides:
Source:

destroy()

destroys this instance
Overrides:
Source:

(generator) entries()

allows to iterate the existing data
Overrides:
Source:
Yields:
[number, *]}

initialize()

update data on initialize returns {Promise}
Overrides:
Source:

isDestroyed() → {boolean}

whether instance is destroyed
Overrides:
Source:
Returns:
Type
boolean

update() → {Promise.<void>}

update data on update
Overrides:
Source:
Returns:
Type
Promise.<void>

Type Definitions

Params

Type:
  • Object
Properties:
Name Type Description
widget Help4.widget.learning.Widget the owner widget
backend Help4.widget.learning.Backend the corresponding backend connector
Source: