Interface: Activity
Properties
additionalParameters?
optionalreadonlyadditionalParameters:unknown
Additional activity parameters that were set.
Source
beginIso8601Timestamp
beginIso8601Timestamp:
string
The value of new Date().toISOString() immediately before the activity begins
Source
beginTimestamp
beginTimestamp:
number
The value of performance.now() immediately before the activity begins
Source
dataStores?
optionaldataStores:IDataStore[]
Optional stores to use for saving data. The implementation of the store is not provided by the @m2c2kit/core library.
Source
id
id:
string
Short identifier of this activity
Source
name
name:
string
Human-friendly name of this activity
Source
publishUuid
publishUuid:
string
Persistent unique identifier (UUID) of the activity. Required for games. Optional or empty string if a survey.
Source
sessionUuid
sessionUuid:
string
The activity's parent session unique identifier. This is newly generated each session.
Source
studyId?
optionalstudyId:string
The ID of the study (protocol, experiment, or other aggregate) that contains the repeated administrations of this activity. The ID should be short, url-friendly, human-readable text (no spaces, special characters, or slashes), e.g., nyc-aging-cohort.
Source
studyUuid?
optionalstudyUuid:string
Unique identifier (UUID) of the study (protocol, experiment, or other aggregate) that contains the administration of this activity.
Source
type
type:
ActivityType
The type of activity: Game or Survey
Source
uuid
uuid:
string
The activity's unique identifier. This is newly generated each session. The UUID for an activity will vary across sessions.
Source
Methods
init()
init():
Promise<void>
Initializes the activity.
Returns
Promise<void>
Remarks
All code to create the activity's appearance and behavior must
be placed in this method. This method is asynchronous, and must be
awaited. When writing a new game by extending the Game class, this
method will be overridden, but the base method must still be called with
await super.init().
Deprecated
use Game.initialize() instead.
Source
initialize()
initialize():
Promise<void>
Initializes the activity.
Returns
Promise<void>
Remarks
All code to create the activity's appearance and behavior must
be placed in this method. This method is asynchronous, and must be
awaited. When writing a new game by extending the Game class, this
method will be overridden, but the base method must still be called with
await super.initialize().
Source
onCancel()
onCancel(
callback,options?):void
Executes a callback when the activity is canceled.
Parameters
• callback
function to execute.
• options?: CallbackOptions
options for the callback.
Returns
void
Source
onData()
onData(
callback,options?):void
Executes a callback when the activity generates data.
Parameters
• callback
function to execute.
• options?: CallbackOptions
options for the callback.
Returns
void
Source
onEnd()
onEnd(
callback,options?):void
Executes a callback when the activity ends.
Parameters
• callback
function to execute.
• options?: CallbackOptions
options for the callback.
Returns
void
Source
onStart()
onStart(
callback,options?):void
Executes a callback when the activity starts.
Parameters
• callback
function to execute.
• options?: CallbackOptions
options for the callback.
Returns
void
Source
setParameters()
setParameters(
additionalParameters):void
Sets additional activity parameters if defaults are not sufficient.
Parameters
• additionalParameters: unknown
Returns
void
Source
start()
start():
Promise<void>
Starts the activity
Returns
Promise<void>
Source
stop()
stop():
void
Stops the activity
Returns
void