springroll.pbskids.LearningAnalytics Class

Defined in: springroll.pbskids.LearningAnalytics:43

Module: Container

Handle the Learning Analytics events

Constructor

`springroll.pbskids.LearningAnalytics`

(

[domain='http://progresstracker.pbskids.org']
[resource='game']

)

Defined in springroll.pbskids.LearningAnalytics:43

Parameters:

[domain='http://progresstracker.pbskids.org'] String optional

The domain for the end-point this should only be set for mobile devices or testing otherwise it uses a root-relative end-point and will use the progresstracker on the current domain
[resource='game'] String optional

The type of resource

Properties

_enabled
_timer
autoFlush
BATCH_SIZE static
enabled
EVENT_KEYS static
eventKeys
KEY_PREFIX static
platform
queue
SERVICE_PATHS static
sessionId

`appendChannelId`

(

eventData

)

LearningAnalytics

private

Defined in appendChannelId:349

Adds the current super vision channel id to the event JSON data

Parameters:

eventData Object

The event object data

Returns:

LearningAnalytics:

Instance for chaining

`appendContentOrigin`

(

eventData

)

LearningAnalytics

private

Defined in appendContentOrigin:367

Adds the current Super Vision content origin to the event JSON data

Parameters:

eventData Object

The event object data

Returns:

LearningAnalytics:

Instance for chaining

`appendPlatformDetails`

(

eventData

)

LearningAnalytics

private

Defined in appendPlatformDetails:306

Insert platform in JSON Data

Parameters:

eventData Object

The event object data

Returns:

LearningAnalytics:

Instance for chaining

`appendSessionId`

(

eventData

)

LearningAnalytics

private

Defined in appendSessionId:293

Insert Game SessionId in JSON Data

Parameters:

eventData Object

The event object

Returns:

LearningAnalytics:

Instance for chaining

`appendTimeStamp`

(

eventData

)

LearningAnalytics

private

Defined in appendTimeStamp:385

Add the timestamp to the event JSON data

Parameters:

eventData Object

The event object data

Returns:

LearningAnalytics:

Instance for chaining

`appendUserData`

(

eventData

)

LearningAnalytics

private

Defined in appendUserData:320

Insert user information in JSON Data

Parameters:

eventData Object

The event object data

Returns:

LearningAnalytics:

Instance for chaining

`checkStatus`

()

private

Defined in checkStatus:240

Check the online status internally on a timer Auto calling function to keep updating online staus

`destroy`

()

Defined in destroy:468

Cleanup and don't use after this

`end`

()

Defined in end:222

End the current queue

`flushAll`

()

Defined in flushAll:284

Flush the queue

`pushEvent`

(

eventData

)

Object

Defined in pushEvent:399

Push a learning event

Parameters:

eventData Object

The event object data
- game_id String
  
  The GUID for the game
- event_id String
  
  The GUID for the event
- event_data Object
  
  The data for event