Options
Menu

Class ChatJoinedEvent

Emitted when the current user joins a Chat. The primary reason for this event is situations in which a user has multiple active sessions (e.g. using the app on two different devices) and one of the sessions joins a ChatChannel. Since the other session doesn't yet have access to the ChatChannel, applications can listen for this event to update their membership status.

Note that this is emitted from the ChatService as opposed to a Chat.

Hierarchy

  • ChatJoinedEvent

Implements

Index

Properties

Properties

chatId

chatId: string

The id of the chat that was just joined.

name

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

NAME

NAME: "joined" = "joined"