Chat Context

Last updated 2021/10/13 09:53:14

ChatContext enables developers to implement the chat function in the flexible classroom.

isHost

isHost: boolean,

Whether the local user is the teacher or teaching assistant.

getHistoryChatMessage

getHistoryChatMessage: (data: {
    nextId: string;
    sort: number;
})=>Promise<any>,

Fetches the message history.

Example:getHistoryChatMeassage({nextId:"idstring", sort: 1})

Parameter	Description
`nextId`	You can fetch message history in batches with this parameter. When you call this method for the first time, leave this parameter empty or set it as null. You can set this parameter as the `nextId` that you get in the response of the previous method call.
`sort`	`0`: Fetch message history in ascending order. `1`: Fetch message history in descending order.

messageList

messageList: array,

The message list.

sendMessage

sendMessage: (message: any) => Promise<{
    id: string,
    ts: number,
    text: any,
    account: string,
    sender: boolean,
    messageId: string,
    fromRoomName: string,
}>,

Sends a message.

Parameter	Description
`message`	The message.

muteChat

muteChat: () => void,

Disables the chat function.

unmuteChat

unmuteChat: () => void,

Enables the chat function.

chatCollapse

chatCollapse: boolean,

Whether is the chat box is folded.

toggleChatMinimize

toggleChatMinimize(): void

Folds or expands the chat box.

unreadMessageCount

unreadMessageCount: number,

The number of unread messages.

canChatting

canChatting: boolean,

Whether the chat function is enabled.

addChatMessage

addChatMessage: (args: any) => void

Adds a message to the message list.

Parameter	Description
`args`	Passes in the object which is returned in the method of sending a message.

Is this page helpful?

Yes