Options
Menu

Class ActivityStateDeltaEvent

The ActivityStateSetEvent is fired when a remote session sets one or elements from its state within the Activity.

Hierarchy

  • ActivityStateDeltaEvent

Implements

Index

Properties

activity

activity: Activity

The Activity that this event relates to.

complete

complete: boolean

Indicates if the full state map was set.

local

local: boolean

Will be true if this event is from the local user / session; false otherwise.

name

name: string = ActivityStateDeltaEvent.EVENT_NAME

The name of the event that was fired. This is commonly used to filter when using the ConvergenceEventEmitter.events stream.

Note that the name is only guaranteed to be unique within the class / subsystem that is firing it. Names might be reused across classes and subsystems.

oldValues

oldValues: Map<string, any>

The previous values of any state that was removed or set.

removed

removed: string[]

The keys of state that was removed.

sessionId

sessionId: string

The session id of the session that originated this event.

user

The username of the user originated this event.

values

values: Map<string, any>

The state that was modified.

StaticEVENT_NAME

EVENT_NAME: string = "state_delta"

The event name that all instances of this class will use.