scormService - Documentation

AngularJS Service for SCORM wrapper library.

Source:

services/scorm-service.js, line 1

See:

https://docs.angularjs.org/api/ng/type/angular.Module#service

Members

(static) heartbeatDelay :number

Heartbeat interval (in milliseconds).

Default Value:

1500000

Source:

services/scorm-service.js, line 49

Type:

number

(private, static) scorm

Service for SCORM Wrapper Library. https://github.com/pipwerks/scorm-api-wrapper

Source:

services/scorm-service.js, line 16

To Do:

Check whether this is actually used by anything.

(private, static, nullable) entryStatus :string

Internal storage for SCORM entry status.

Source:

services/scorm-service.js, line 24

Type:

string

(private, static) saved :Object

Internal storage for SCORM service data.

Source:

services/scorm-service.js, line 32

Type:

Object

Methods

(static) inIframe() → {boolean}

Checks whether game was loaded in an iframe

Source:

services/scorm-service.js, line 56

Returns:

Type:: boolean

(static) init()

Initialize SCORM service and listeners.

Source:

services/scorm-service.js, line 69

Listens to Events:

window.event:message

(static) isConnected() → {boolean}

Check whether SCORM service is connected.

Source:

services/scorm-service.js, line 160

Returns:

Type:: boolean

(static) provideEntryStatus() → (nullable) {string}

Get stored value from module:scormService.entryStatus

Source:

services/scorm-service.js, line 166

Returns:

Type:: string

(static) provideSavedScore() → (nullable) {number}

Get stored SCORM score.

Source:

services/scorm-service.js, line 173

Returns:

Type:: number

(static) provideLessonStatus() → (nullable) {string}

Get stored SCORM lesson_status.

Source:

services/scorm-service.js, line 180

Returns:

Type:: string

(static) provideUser() → {Object}

Get stored SCORM user.

Source:

services/scorm-service.js, line 187

Returns:

Type:: Object

(static) initScores()

Initialize scores in SCORM service.

Source:

services/scorm-service.js, line 218

(static) setScore(number)

Sent set message for score to SCORM service.

Source:

services/scorm-service.js, line 233

Parameters:

Name	Type	Description
`number`	`number`	The score value.

(static) getScore()

Send get message for score from SCORM service.

Source:

services/scorm-service.js, line 247

See:

module:scormService.provideSavedScore

(static) getLessonStatus()

Send get message for lesson status from SCORM service.

Source:

services/scorm-service.js, line 272

See:

module:scormService.provideLessonStatus

(static) getEntryStatus()

Send get message for entry status from SCORM service.

Source:

services/scorm-service.js, line 299

See:

module:scormService.provideEntryStatus

(static) getUser()

Send get message for user from SCORM service.

Source:

services/scorm-service.js, line 331

See:

module:scormService.provideUser

(static) checkCompletion() → {boolean}

Check whether lesson status is completed.

Source:

services/scorm-service.js, line 346

Returns:

Type:: boolean

(static) setCompletion(complete)

Send set message for completion status to SCORM service.

Source:

services/scorm-service.js, line 352

Parameters:

Name	Type	Description
`complete`	`boolean`	The completion state.

(static) startHeartbeat()

Start SCORM heartbeat.

Source:

services/scorm-service.js, line 370

See:

module:scormService.heartbeatDelay

(static) stopHeartbeat()

Stop SCORM heartbeat.

Source:

services/scorm-service.js, line 384

(static) getVersion()

Send version message to SCORM service.

Source:

services/scorm-service.js, line 393

(static) get(model)

Send get message for an arbitrary data model element from SCORM service.

Source:

services/scorm-service.js, line 406

Parameters:

Name	Type	Description
`model`	`string`	SCORM data model element.

(static) set(model, value)

Send set message for an arbitrary data model element from SCORM service.

Source:

services/scorm-service.js, line 421

Parameters:

Name	Type	Description
`model`	`string`	SCORM data model element.
`value`	`*`	Value for SCORM element.

(static) save()

Calls pipwerks.SCORM.data.save() which calls LMSCommit(). Instructs the LMS to persist all data to this point in the session.

Source:

services/scorm-service.js, line 435

(static) finish()

Closes parent $window if parent $window is top most $window. Closing $window triggers pipwerks.SCORM.connection.terminate().

Source:

services/scorm-service.js, line 447

(private, static) versionCallback()

Handler for SCORM version message.

Source:

services/scorm-service.js, line 109

(private, static) getHandler(data)

Handler for SCORM get messages.

Source:

services/scorm-service.js, line 125

Parameters:

Name Type Description

data

Object

Message object.

Name	Type	Description
`model`	`string`	SCORM data model element.
`value`	`*`	Value for SCORM element.

(private, static) setHandler(data)

Handler for SCORM set messages.

Source:

services/scorm-service.js, line 197

Parameters:

Name Type Description

data

Object

Message object.

Name	Type	Description
`model`	`string`	SCORM data model element.
`value`	`*`	Value for element.

(private, static) getScoreCallback(data)

Callback for SCORM get message for score. Used by module:scormService.getHandler

Source:

services/scorm-service.js, line 263

Parameters:

Name Type Description

data

Object

Message object.

Name	Type	Description
`value`	`number`	Score value.

(private, static) lessonStatusCallback(data)

Callback for SCORM get messages for lesson status. Used by module:scormService.getHandler

Source:

services/scorm-service.js, line 288

Parameters:

Name Type Description

data

Object

Message object.

Name	Type	Description
`value`	`string`	Lesson status value.

(private, static) entryStatusCallback(data)

Callback for SCORM get messages for entry status. Used by module:scormService.getHandler

Source:

services/scorm-service.js, line 315

Parameters:

Name Type Description

data

Object

Message object.

Name	Type	Description
`value`	`string`	Entry status value.