Documentation

SCORM

Source: SCORM.js:40

This class detects if JClic.js is running in an SCORM environment and, if true,
exposes the methods needed to notify the results of activities.
Both SCORM 1.2 and 2004 are supported.

Constructor

new SCORM( API: object, reporter: module:report/Reporter.Reporter, ): SCORM

SCORM constructor

Parameters

Instance Methods

initialize(): boolean

SCORM.js:104

Initializes communication with the SCORM API

Returns

  • boolean

terminate(): boolean

SCORM.js:130

Terminates communication with the SCORM API

Returns

  • boolean

commitInfo()

SCORM.js:143

Commits the current information to the SCORM API

commit(): boolean

SCORM.js:159

Commits current pending data to the SCORM API

Returns

  • boolean

setValue(key: string, value: string | number): string

SCORM.js:175

Sends a specific value to the SCORM API

Parameters

  • key (string) — A SCORM valid key
  • value (string | number) — The value associated with this key

Returns

  • string

getValue(key: string): string

SCORM.js:190

Gets a specific value from the SCORM API

Parameters

  • key (string) — A SCORM valid key

Returns

  • string

getTimeExpression(millis: number): string

SCORM.js:206

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

Parameters

  • millis (number) — The amount of time, in milliseconds

Returns

  • string

getScormType(): string

SCORM.js:222

Gets the SCORM type of this SCORM object

Returns

  • string

Static Methods

scanForAPI(win: object, tries: number): object

static
SCORM.js:65

Recursive function used to find the SCORM "API" object

Parameters

  • win (object) — The 'window' object to scan for global SCORM API objects
  • tries (number) — Recursive attempts currently achieved

Returns

  • object

getSCORM( reporter: module:report/Reporter.Reporter, ): module:report/SCORM.SCORM

static
SCORM.js:81

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

Parameters

Returns

Instance Fields

is2004: boolean

SCORM.js:232

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

reporter: module:report/Reporter.Reporter

SCORM.js:237

The Reporter associated to this SCORM object

prefix: string

SCORM.js:242

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

core: string

SCORM.js:247

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

API: object

SCORM.js:252

SCORM API object used to communicate with the LMS

studentId: string

SCORM.js:257

The student ID retrieved from the SCORM API

studentName: string

SCORM.js:262

The student name retrieved from the SCORM API

Static Fields

DISCOVER_MAX_TRIES: number

static
SCORM.js:268

Maximum recursive attempts allowed to find the global SCORM API object