ChatClient

Events

View as Markdown

Events

member.joined

  • member.joined(member)

A new member joined the chat.

Parameters

NameType
memberChatMember

member.left

  • member.left(member)

A member left the chat.

Parameters

NameType
memberChatMember

member.updated

  • member.updated(member)

A member updated its state.

Parameters

NameType
memberChatMember

message

  • message(message)

A new message has been received.

Parameters

NameType
messageChatMessage

Type Aliases

ChatMemberEntity

An object representing a Chat Member with only the state properties of ChatMember.

Properties

  • Readonly channel: string

The channel of this member.

  • Readonly id: string

The id of this member.

  • Readonly state: Record<any, any>

The state of this member.

ChatMessageEntity

An object representing a Chat Message with only the state properties of ChatMessage.

Properties

  • Readonly content: any

The content of this message.

  • Readonly id: string

The id. of this message

The member which sent this message.

  • Readonly meta?: any

Any metadata associated with this message.

  • Readonly publishedAt: Date

The date and time at which this message was published.