SessionReg

Source: SessionReg.js:38

This class encapsulates data of a user's working session, usually associated to a single JClicProject
It's main component is sequences, an array of SequenceReg objects.

Constructor

new SessionReg(
project: module:project/JClicProject.JClicProject,
code?: string,
): SessionReg

SessionReg constructor

Parameters

project (module:project/JClicProject.JClicProject) — The JClicProject referenced by this session.
code (string, optional) — Optional code to be used by this SessionReg

Instance Methods

`getData(recalcInfo: boolean, includeEmpty: boolean): object`

SessionReg.js:61

Builds a complex object with the results of all activities done during this working session

Parameters

recalcInfo (boolean) — When true, global variables (number of sequences, score, total time...)
will be recalculated from the data stored in the SequenceReg objects.
includeEmpty (boolean) — When true, sequences without reported activities will be also included in the results

Returns

object

`getInfo(): module:report/SessionReg.SessionRegInfo`

SessionReg.js:89

Returns the info element associated to this SessionReg.

Returns

module:report/SessionReg.SessionRegInfo

`end()`

SessionReg.js:96

Closes this session

`endSequence()`

SessionReg.js:103

This method should be called when the current working session finishes.

`newSequence( ase: module:bags/ActivitySequenceElement.ActivitySequenceElement, )`

SessionReg.js:114

This method should be invoked when a new sequence starts

Parameters

ase (module:bags/ActivitySequenceElement.ActivitySequenceElement) — The ActivitySequenceElement referenced by this sequence.

`newActivity(act: module:Activity.Activity)`

SessionReg.js:125

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

Parameters

act (module:Activity.Activity) — The Activity that has just started

`endActivity(score: number, numActions: number, solved: boolean)`

SessionReg.js:142

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

Parameters

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.

`newAction(type: string, +: string, +: string, ok: boolean)`

SessionReg.js:156

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

Parameters

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 that acts as a target of the action (used in pairings)
ok (boolean) — true if the action was OK, false, null or undefined otherwise