Class: SCORM

Constructor

new SCORM(API, reporter)

SCORM constructor

Parameters:

Name	Type	Description
`API`	object	The global SCORM API object
`reporter`	module:report/Reporter.Reporter	The `Reporter` associated to this SCORM object

Source: report/SCORM.js, line 42

Members

API :object

SCORM API object used to communicate with the LMS

Type:

object

Source: report/SCORM.js, line 250

core :string

Prefix used in core SCORM keys. Should be 'cmi.core.' for 1.2 and 'cmi.' for 2004

Type:

string

Source: report/SCORM.js, line 245

is2004 :boolean

True when the API is of type SCORM 2004, false for SCORM 1.2

Type:

boolean

Source: report/SCORM.js, line 230

prefix :string

Prefix to be used in SCORM function names. Should be 'LMS' for SCORM 1.2

Type:

string

Source: report/SCORM.js, line 240

reporter :module:report/Reporter.Reporter

The Reporter associated to this SCORM object

Type:

module:report/Reporter.Reporter

Source: report/SCORM.js, line 235

studentId :string

The student ID retrieved from the SCORM API

Type:

string

Source: report/SCORM.js, line 255

studentName :string

The student name retrieved from the SCORM API

Type:

string

Source: report/SCORM.js, line 260

(static) DISCOVER_MAX_TRIES :number

Maximum recursive attempts allowed to find the global SCORM API object

Type:

number

Source: report/SCORM.js, line 270

Methods

commit() → {boolean}

Commits current pending data to the SCORM API

Source: report/SCORM.js, line 161

Returns:

Type:: boolean

commitInfo()

Commits the current information to the SCORM API

Source: report/SCORM.js, line 145

getScormType() → {string}

Gets the SCORM type of this SCORM object

Source: report/SCORM.js, line 224

Returns:

Type:: string

getTimeExpression(millis) → {string}

Gets a string expression of the given time (in milliseconds) suitable for a SCORM transaction.

Parameters:

Name	Type	Description
`millis`	number	The amount of time, in milliseconds

Source: report/SCORM.js, line 208
See: http://www.ostyn.com/standards/scorm/samples/ISOTimeForSCORM.htm

Returns:

An ISO8601 valid expression

Type:: string

getValue(key) → {string}

Gets a specific value from the SCORM API

Parameters:

Name	Type	Description
`key`	string	A SCORM valid key

Source: report/SCORM.js, line 192

Returns:

The value associated with the provided key, or null if not found

Type:: string

initialize() → {boolean}

Initializes communication with the SCORM API

Source: report/SCORM.js, line 106

Returns:

Type:: boolean

setValue(key, value) → {string}

Sends a specific value to the SCORM API

Parameters:

Name	Type	Description
`key`	string	A SCORM valid key
`value`	string \| number	The value associated with this key

Source: report/SCORM.js, line 177

Returns:

Type:: string

terminate() → {boolean}

Terminates communication with the SCORM API

Source: report/SCORM.js, line 132

Returns:

Type:: boolean

(static) getSCORM(reporter) → {module:report/SCORM.SCORM}

Checks for the presence of a SCORM API on the current browser session.

Parameters:

Name	Type	Description
`reporter`	module:report/Reporter.Reporter	The `Reporter` linked to the requested SCORM object

Source: report/SCORM.js, line 83

Returns:

A valid SCORM object, or null if no SCORM API was found.

Type:: module:report/SCORM.SCORM

(static) scanForAPI(win, tries) → {object}

Recursive function used to find the SCORM "API" object

Parameters:

Name	Type	Description
`win`	object	The 'window' object to scan for global SCORM API objects
`tries`	number	Recursive attempts currently achieved

Source: report/SCORM.js, line 67

Returns:

The global SCORM API object, or null if not found

Type:: object