Documentation

Class: Participant

Participant

A Participant represents a remote Client in a Conversation.
Properties:
Name Type Description
attributes any Object with custom attributes for Participant
conversation Conversation The Conversation the remote Client is a Participant of
dateCreated Date The Date this Participant was created
dateUpdated Date The Date this Participant was last updated
identity String The identity of the remote Client
isTyping Boolean Whether or not this Participant is currently typing
lastReadMessageIndex Number | null Latest read Message index by this Participant. Note that just retrieving messages on a client endpoint does not mean that messages are read, please consider reading about Read Horizon feature to find out how to mark messages as read.
lastReadTimestamp Date Date when Participant has updated his read horizon
sid String The server-assigned unique identifier for the Participant
type Participant#Type The type of Participant
Fires:

Methods

getUser()

Gets User for this participant and subscribes to it. Supported only for chat type of Participants
Returns:
Type
Promise.<User>

remove()

Remove Participant from the Conversation.
Returns:
Type
Promise.<void>

updateAttributes(attributes)

Edit participant attributes.
Parameters:
Name Type Description
attributes any new attributes for Participant.
Returns:
Type
Promise.<Participant>

Type Definitions

Type

The type of Participant
Type:
  • 'chat' | 'sms' | 'whatsapp'

UpdateReason

The update reason for updated event emitted on Participant
Type:
  • 'attributes' | 'dateCreated' | 'dateUpdated' | 'roleSid' | 'lastReadMessageIndex' | 'lastReadTimestamp'

Events

typingEnded

Fired when Participant ended to type.
Type: Participant

typingStarted

Fired when Participant started to type.
Type: Participant

updated

Fired when Participant's fields has been updated.
Type: Object
Properties:
Name Type Description
participant Participant Updated Participant
updateReasons Array.<Participant#UpdateReason> Array of Participant's updated event reasons