Class ChatController

The ChatController class is a managing class to control the in-meeting chat related functions and states in an active meeting.

Hierarchy

ChatEventEmitter
- ChatController

Index

Constructors

constructor

Events

on

Methods

Constructors

constructor

new ChatController(): ChatController

Inherited from ChatEventEmitter.constructor
Returns ChatController

Events

on

on(event: CHAT_MESSAGE_RECEIVED, listener: ((messages: ChatMessage[]) => void)): any

Inherited from ChatEventEmitter.on

Occurs when a new chat message is received

Parameters
- event: CHAT_MESSAGE_RECEIVED
- listener: ((messages: ChatMessage[]) => void)
  - - (messages: ChatMessage[]): void
    - Parameters
      - messages: ChatMessage[]
      Returns void
Returns any

Methods

getCurrentChatPrivilege

getCurrentChatPrivilege(): ChatPrivilege

Gets the current chat privilege.

Returns ChatPrivilege
The current chat privilege

off

off(eventName: CHAT_MESSAGE_RECEIVED, listener: TEventCB): void

Inherited from ChatEventEmitter.off

Removes the specified listener from the listener array for the event named eventName.

Parameters
- eventName: CHAT_MESSAGE_RECEIVED
- listener: TEventCB
Returns void

once

once(eventName: CHAT_MESSAGE_RECEIVED, listener: TEventCB): void

Inherited from ChatEventEmitter.once

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

Parameters
- eventName: CHAT_MESSAGE_RECEIVED
- listener: TEventCB
Returns void

sendMessageToAll

sendMessageToAll(msg: string): Promise<ErrorCodeType>

Send a chat message to all meeting users in an active meeting.

description
A successful call of sendMessageToAll triggers the ChatEvent.CHAT_MESSAGE_RECEIVED event callback for the local and remote users.

Parameters
- msg: string
  
  The chat message to be sent
Returns Promise<ErrorCodeType>
0 means the API call is valid or fails otherwise

sendMessageToUser

sendMessageToUser(uid: any, msg: any): Promise<ErrorCodeType>

Sends a chat message to a specific meeting user in an active meeting.

description
A successful call of sendMessageToUser triggers the ChatEvent.CHAT_MESSAGE_RECEIVED event callback for the local and remote users.

Parameters
- uid: any
  
  The unique id of the specific meeting user
- msg: any
  
  The chat message to be sent
Returns Promise<ErrorCodeType>
0 means the API call is valid or fails otherwise

setChatPrivilege

setChatPrivilege(privilege: ChatPrivilege): Promise<ErrorCodeType>

Sets the meeting chat privilege.

Parameters
- privilege: ChatPrivilege
  
  The privilege of the meeting chat
Returns Promise<ErrorCodeType>
0 means the API call is valid or fails otherwise