Class: Reporter

Constructor

new Reporter(ps)

Reporter constructor

Parameters:

Name	Type	Description
`ps`	module:JClicPlayer.JClicPlayer	The `JClicPlayer` used to retrieve localized messages

Source: report/Reporter.js, line 46

Members

MAX_USERID_PROMPT_ATTEMPTS :number

Maximum number of incorrect UserID attempts

Type:

number

Source: report/Reporter.js, line 566

SCORM

A valid SCORM bridge, or null if no SCORM API detected.

Source: report/Reporter.js, line 501

bUserBased :boolean

true if the system is connected to a database with user's data.
When false, a generic ID will be used.

Type:

boolean

Source: report/Reporter.js, line 560

currentSession :module:report/SessionReg.SessionReg

Currently active session

Type:

module:report/SessionReg.SessionReg

Source: report/Reporter.js, line 550

descriptionDetail :string

Additional info to display after the reporter's description

Type:

string

Source: report/Reporter.js, line 535

descriptionKey :string

Description of this reporting system

Type:

string

Source: report/Reporter.js, line 530

groupCodeFilter :string

Optional filter key to be used in the group selection dialog

Type:

string

Source: report/Reporter.js, line 520

info :module:report/Reporter.ReporterInfo

The ReporterInfo used to calculate and store global results.

Type:

module:report/Reporter.ReporterInfo

Source: report/Reporter.js, line 491

initiated :boolean

true if the system was successfully initiated, false otherwise

Type:

boolean

Source: report/Reporter.js, line 555

ps :module:JClicPlayer.JClicPlayer

The JClicPlayer used to retrieve messages

Type:

module:JClicPlayer.JClicPlayer

Source: report/Reporter.js, line 496

sessionContext :string

A second optional key to be reported as a field in session records

Type:

string

Source: report/Reporter.js, line 515

sessionKey :string

Optional key to be added as a field in session records

Type:

string

Source: report/Reporter.js, line 510

sessions :Array.<module:report/SessionReg.SessionReg>

Array of sessions included in this report

Type:

Array.<module:report/SessionReg.SessionReg>

Source: report/Reporter.js, line 545

started :external:Date

Starting date and time of this report

Type:

external:Date

Source: report/Reporter.js, line 540

userCodeFilter :string

Another optional filter key to be used in the user selection dialog

Type:

string

Source: report/Reporter.js, line 525

userId :string

User ID currently associated with this reporting system

Type:

string

Source: report/Reporter.js, line 505

(static) CLASSES :object

Static list of classes derived from Reporter. It should be filled by Reporter classes at declaration time.

Type:

object

Source: report/Reporter.js, line 725

Methods

end() → {external:Promise}

Closes this reporting system

Source: report/Reporter.js, line 370

Returns:

A Promise object to be fullfilled when all pending tasks are finished.

Type:: external:Promise

endActivity(score, numActions, solved)

This method should be called when the current activity finishes. Data about user's final results
on the activity will then be saved.

Parameters:

Name	Type	Description
`score`	number	The final score, usually in a 0-100 scale.
`numActions`	number	The total number of actions done by the user to solve the activity
`solved`	boolean	`true` if the activity was finally solved, `false` otherwise.

Source: report/Reporter.js, line 452

endSequence()

Finalizes the current sequence

Source: report/Reporter.js, line 379

endSession()

Finalizes the current session

Source: report/Reporter.js, line 389

getBooleanProperty(key, +) → {boolean}

Gets a specific boolean property from this reporting system

Parameters:

Name	Type	Description
`key`	string	Requested property
`+`	boolean	defaultValue - Default return when requested property does not exist

Source: report/Reporter.js, line 116

Returns:

Type:: boolean

getCurrentSequenceInfo() → {module:report/SequenceReg.SequenceRegInfo}

Gets information about the current sequence

Source: report/Reporter.js, line 477

Returns:

Type:: module:report/SequenceReg.SequenceRegInfo

getCurrentSequenceTag() → {string}

Gets the name of the current sequence

Source: report/Reporter.js, line 485

Returns:

Type:: string

getData() → {object}

Builds a complex object containing all the results reported while playing activities

Source: report/Reporter.js, line 304

Returns:

The current results

Type:: object

getGroupData(_groupId) → {external:Promise}

Gets extended data associated with a specific group or organization. This
is a method intended to be implemented in subclasses.

Parameters:

Name	Type	Description
`_groupId`	string	The requested group ID

Source: report/Reporter.js, line 157

Returns:

When fulfilled, an object with group data is returned.

Type:: external:Promise

getGroups() → {external:Promise}

Gets the list of groups or organizations currently registered in the system. This
method should be implemented by classes derived of Reporter.

Source: report/Reporter.js, line 126

Returns:

When fulfilled, an array of group data is returned as a result

Type:: external:Promise

getInfo() → {module:report/Reporter.ReporterInfo}

Returns the info element associated to this Reporter.

Source: report/Reporter.js, line 96

Returns:

Type:: module:report/Reporter.ReporterInfo

getProperty(key, +) → {string}

Gets a specific property from this reporting system

Parameters:

Name	Type	Description
`key`	string	Requested property
`+`	string	defaultValue - Default return value when requested property does not exist

Source: report/Reporter.js, line 106

Returns:

Type:: string

getUserData(_userId) → {external:Promise}

Gets extended data associated with a specific user. This is a method intended to be
implemented in subclasses.

Parameters:

Name	Type	Description
`_userId`	string	The requested user ID

Source: report/Reporter.js, line 147

Returns:

When fulfilled, an object with user data is returned.

Type:: external:Promise

getUsers(+) → {external:Promise}

Gets the list of users currently registered in the system, optionally filtered by
a specific group ID. This method should be implemented by classes derived of Reporter.

Parameters:

Name	Type	Description
`+`	string	groupId - Optional group ID to be used as a filter criteria

Source: report/Reporter.js, line 137

Returns:

When fulfilled, an object with a collection of user data records
is returned

Type:: external:Promise

init(optionsopt) → {external:Promise}

Initializes this report system with an optional set of parameters.
Returns a Promise, fulfilled when the reporter is fully initialized.

Parameters:

Name	Type	Attributes	Description
`options`	object	<optional>	Initial settings passed to the reporting system

Source: report/Reporter.js, line 348

Returns:

Type:: external:Promise

newAction(type, +, +, ok)

Reports a new action done by the user while playing the current activity

Parameters:

Name	Type	Description
`type`	string	Type of action (`click`, `write`, `move`, `select`...)
`+`	string	source - Description of the object on which the action is done.
`+`	string	dest - Description of the object reporter acts as a target of the action (usually in pairings)
`ok`	boolean	`true` if the action was OK, `false`, `null` or `undefined` otherwhise

Source: report/Reporter.js, line 466

newActivity(act)

This method should be invoked when the user starts a new activity

Parameters:

Name	Type	Description
`act`	module:Activity.Activity	The `Activity` reporter has just started

Source: report/Reporter.js, line 438

newGroup(_gd)

Creates a new group (method to be implemented in subclasses)

Parameters:

Name	Type	Description
`_gd`	object

Source: report/Reporter.js, line 398

newSequence(ase)

This method should be invoked when a new sequence starts

Parameters:

Name	Type	Description
`ase`	module:bags/ActivitySequenceElement.ActivitySequenceElement	The `ActivitySequenceElement` referenced by this sequence.

Source: report/Reporter.js, line 425

newSession(jcp)

This method should be invoked when a new session starts.

Parameters:

Name	Type	Description
`jcp`	module:project/JClicProject.JClicProject	The `JClicProject` this session refers to.

Source: report/Reporter.js, line 414

newUser(_ud)

Creates a new user (method to be implemented in subclasses)

Parameters:

Name	Type	Description
`_ud`	object

Source: report/Reporter.js, line 406

promptForNewGroup() → {external:Promise}

Allows the current user to create a new group, and asks his name

Source: report/Reporter.js, line 175

Returns:

When fulfilled, the chosen name for the new group is returned.

Type:: external:Promise

promptForNewUser() → {external:Promise}

Allows the current user to create a new user ID, and asks his ID and password

Source: report/Reporter.js, line 185

Returns:

When fulfilled, an object with the new user ID and password
is returned.

Type:: external:Promise

promptGroupId() → {external:Promise}

Allows the current user to select its group or organization from the current groups list

Source: report/Reporter.js, line 194

Returns:

Type:: external:Promise

promptUserId(+) → {external:Promise}

Asks for a valid user ID fulfilling the promise if found, rejecting it otherwise

Parameters:

Name	Type	Description
`+`	boolean	forcePrompt - Prompt also if `userId` is already defined (default is `false`)

Source: report/Reporter.js, line 229

Returns:

Type:: external:Promise

userBased() → {boolean}

Checks if this reporting system manages its own database of users and groups. Defaults to false

Source: report/Reporter.js, line 165

Returns:

Type:: boolean

(static) getReporter(className, ps) → {module:report/Reporter.Reporter}

Creates a new Reporter of the requested class
The resulting object must be prepared to operate with a call to its init method.

Parameters:

Name	Type	Description
`className`	string	Class name of the requested reporter. When `null`, a basic Reporter is created.
`ps`	module:JClicPlayer.JClicPlayer	The `JClicPlayer` used to retrieve localized messages

Source: report/Reporter.js, line 77

Returns:

Type:: module:report/Reporter.Reporter

(static) registerClass(reporterName, reporterClass) → {module:report/Reporter.Reporter}

Registers a new type of reporter

Parameters:

Name	Type	Description
`reporterName`	string	The name used to identify this reporter
`reporterClass`	function	The reporter class, usually extending Reporter

Source: report/Reporter.js, line 65

Returns:

The provided reporter class

Type:: module:report/Reporter.Reporter