Convergence JavaScript Client API Documentation 1.0.0-rc.12
Dev Guide
Options
Menu

Class ActivityParticipant

The ActivityParticipant represents an individual user session that has joined a particular Activity.

Hierarchy

  • ActivityParticipant

Index

Properties

Accessors

Methods

Properties

activity

activity: Activity

The Activity this participant belongs too.

local

local: boolean

A flag indicating if the participant represents the local user / session.

sessionId

sessionId: string

The session id of the participant.

user

user: DomainUser

The username of the participant.

Accessors

state

  • get state(): Map<string, any>

  • Returns Map<string, any>

    The current state of this participant within this activity.

Methods

clone

  • Clones this ActivityParticipant, optionally making changes while cloning.

    Parameters

    • modifications: { activity?: Activity; local?: boolean; sessionId?: string; state?: Map<string, any>; user?: DomainUser } = {}

      Optional overrides to the properties of the ActivityParticipant.

      • activity?: Activity
      • local?: boolean
      • sessionId?: string
      • state?: Map<string, any>
      • user?: DomainUser

    Returns ActivityParticipant