Properties

Properties

constant static

State  string

The possible states of a SparkCommunications.Messenger.Participant.

Properties

Name Type Optional Description

Active

 

 

The participant has joined the chat and is actively participating.

Pending

 

 

The local user has sent this participant an invitation from this endpoint but they have not yet joined the chat.

isAdmin  boolean

This will be set to true when the participant is an admin in the chat. This only applies when the 'isOneToOne' field is false for the chat. This value will never change.

regId  string

The regId of the participant. It is the responsibility of the application to relate the regId of a participant to a user within the ecosystem.

state  SparkCommunications.Messenger.Participant.State

The current state of the participant.