Options
Menu

Class ActivitySessionJoinedEvent

The ActivitySessionJoinedEvent is fired when a remote session joins an Activity.

Hierarchy

  • ActivitySessionJoinedEvent

Implements

Index

Properties

activity

activity: Activity

The Activity that this event relates to.

local

local: boolean

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

name

name: string = ActivitySessionJoinedEvent.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.

participant

participant: ActivityParticipant

The participant that this event relates to.

sessionId

sessionId: string

The session id of the session that originated this event.

user

The username of the user originated this event.

StaticEVENT_NAME

EVENT_NAME: string = "session_joined"

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