Skip to main content

Interface: ActivityResultsEvent

Dispatched when new data is created by an activity.

Remarks

Event contains all the data created by an activity, with separate properties for the newly created data. ActivityResultsEvent inherits "data" from ActivityResults, which contains the complete data up to this point (both new and existing data).

Extends

Properties

activityConfiguration

activityConfiguration: unknown

Parameters under which the activity was run.

Inherited from

ActivityResults.activityConfiguration

Source

ActivityResults.ts:14


activityConfigurationSchema

activityConfigurationSchema: JsonSchema

JSON schema describing the activity parameters.

Inherited from

ActivityResults.activityConfigurationSchema

Source

ActivityResults.ts:16


activityMetrics?

optional activityMetrics: ActivityMetric[]

Metrics describing internal application performance.

Inherited from

ActivityResults.activityMetrics

Source

ActivityResults.ts:18


data

data: ActivityKeyValueData

All the data created by the activity.

Inherited from

ActivityResults.data

Source

ActivityResults.ts:10


dataSchema

dataSchema: JsonSchema

JSON schema describing the structure of the data.

Inherited from

ActivityResults.dataSchema

Source

ActivityResults.ts:12


handled?

optional handled: boolean

Has the event been taken care of by the listener and not be dispatched to other targets?

Inherited from

ActivityEvent.handled

Source

M2Event.ts:26


iso8601Timestamp

iso8601Timestamp: string

ISO 8601 timestamp of the event. Specifically, value of "new Date().toISOString()" executed on the device when the ActivityResultsEvent occurred.

Overrides

ActivityEvent.iso8601Timestamp

Source

ActivityResultsEvent.ts:26


newData

newData: ActivityKeyValueData

New data created by the activity, which dispatched this event

Source

ActivityResultsEvent.ts:16


newDataSchema

newDataSchema: JsonSchema

JSON schema describing the new data

Source

ActivityResultsEvent.ts:18


sequence?

optional sequence: number

Sequence number of event.

Remarks

Sequence number is guaranteed to reflect order of events, but not necessarily contiguous, e.g., could be 1, 2, 5, 10, 11, 24.

Inherited from

ActivityEvent.sequence

Source

M2Event.ts:35


target

target: Activity

The object on which the event occurred. If the event has gone through serialization, the string will be the object's UUID (if an M2Node) or class name.

Inherited from

ActivityEvent.target

Source

ActivityEvent.ts:6


timestamp

timestamp: number

Timestamp of the event, from performance.now()

Inherited from

ActivityEvent.timestamp

Source

M2Event.ts:28


type

type: string

Type of event.

Inherited from

ActivityEvent.type

Source

M2Event.ts:22