Zoom Meeting Chat
- Description:
- Zoom Meeting Chat
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onChatMsgNotification |
function | Callback event used to inform the user once received the message sent by others. |
onChatStatusChangedNotification |
function | Callback event used to inform the user when the authority of chat changes in the meeting or webinar. |
onChatMsgDeleteNotification |
function | Callback event used to inform the user host/myself the message be deleted. |
onChatMessageEditNotification |
function | Chat message be edited callback. |
onShareMeetingChatStatusChanged |
function | Callback event used to inform the user when share meeting chat status changed. |
onFileSendStart |
function | Invoked when start send file. |
onFileReceived |
function | Invoked when receiving a file from another user. |
onFileTransferProgress |
function | Invoked when send or receive file status change. |
Returns:
- Type
- ZoomMeetingChat
- Description:
- Zoom Meeting Chat
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onChatMsgNotification |
function | Callback event used to inform the user once received the message sent by others. |
onChatStatusChangedNotification |
function | Callback event used to inform the user when the authority of chat changes in the meeting or webinar. |
onChatMsgDeleteNotification |
function | Callback event used to inform the user host/myself the message be deleted. |
onChatMessageEditNotification |
function | Chat message be edited callback. |
onShareMeetingChatStatusChanged |
function | Callback event used to inform the user when share meeting chat status changed. |
onFileSendStart |
function | Invoked when start send file. |
onFileReceived |
function | Invoked when receiving a file from another user. |
onFileTransferProgress |
function | Invoked when send or receive file status change. |
Returns:
- Type
- ZoomMeetingChat
Methods
(inner) CancelReceive() → {Number}
- Description:
- Cancel the file receive.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) CancelReceive() → {Number}
- Description:
- Cancel the file receive.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) CancelSend() → {Number}
- Description:
- Cancel the file send.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) CancelSend() → {Number}
- Description:
- Cancel the file send.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) DeleteChatMessage(msgID) → {Number}
- Description:
- Delete chat message by message id.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
msgID |
String | is the message id. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) DeleteChatMessage(msgID) → {Number}
- Description:
- Delete chat message by message id.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
msgID |
String | is the message id. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) GetAllChatMessageID() → {Array}
- Description:
- Get all chat message id.
- Source:
Returns:
- Type
- Array
(inner) GetAllChatMessageID() → {Array}
- Description:
- Get all chat message id.
- Source:
Returns:
- Type
- Array
(inner) GetChatMessageById(msgID) → {Object}
- Description:
- Get chat message by message ID.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
msgID |
String | is the message id. |
Returns:
If the function succeeds, the return value is a chat message object with the following properties:
- messageID: The message ID of the current message.
- senderUserId: The sender ID of the current message.
- senderDisplayName: The sender screen name of the current message.
- receiverUserId: The receiver ID of the current message.
- receiverDisplayName: The receiver screen name of the current message.
- content: The content of the current message.
- timeStamp: The timestamps of the current message.
- isChatToAll: Determine if the current message is sent to all.
- isChatToAllPanelist: Determine if the current message is sent to all the panelists.
- isChatToWaitingroom: Determine if the current message is sent to waiting room.
- chatMessageType: The chat message type of the current message.
- isComment: Determine if the current message is a reply to another message.
- isThread: Determine if the current message is part of a message thread, and can be directly replied to.
- segmentDetails: The chat message segment content and style detail of the current message.
- threadID: The current message's thread ID.
- Type
- Object
(inner) GetChatMessageById(msgID) → {Object}
- Description:
- Get chat message by message ID.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
msgID |
String | is the message id. |
Returns:
If the function succeeds, the return value is a chat message object with the following properties:
- messageID: The message ID of the current message.
- senderUserId: The sender ID of the current message.
- senderDisplayName: The sender screen name of the current message.
- receiverUserId: The receiver ID of the current message.
- receiverDisplayName: The receiver screen name of the current message.
- content: The content of the current message.
- timeStamp: The timestamps of the current message.
- isChatToAll: Determine if the current message is sent to all.
- isChatToAllPanelist: Determine if the current message is sent to all the panelists.
- isChatToWaitingroom: Determine if the current message is sent to waiting room.
- chatMessageType: The chat message type of the current message.
- isComment: Determine if the current message is a reply to another message.
- isThread: Determine if the current message is part of a message thread, and can be directly replied to.
- segmentDetails: The chat message segment content and style detail of the current message.
- threadID: The current message's thread ID.
- Type
- Object
(inner) GetChatStatus() → {Object}
- Description:
- Get the authority status to send current message.
- Source:
Returns:
If the function succeeds, the return value is an object of ChatStatus with the following properties:
- normal_meeting_status: The authority to chat in the normal meeting object with properties:
- can_chat: TRUE indicates that the user owns the authority to send message to chat.
- can_chat_to_all: TRUE indicates that the user owns the authority to send message to all.
- can_chat_to_individual: TRUE indicates that the user owns the authority to send message to an individual attendee in the meeting.
- is_only_can_chat_to_host: TRUE indicates that the user owns the authority to send message only to the host.
- webinar_attendee_status: The authority to chat for the normal attendee in the webinar object with properties:
- can_chat: TRUE indicates that the attendee can send message to chat.
- can_chat_to_all_panellist_and_attendee: TRUE indicates that the user owns the authority to send message to all the panelists and attendees.
- can_chat_to_all_panellist: TRUE indicates that the user owns the authority to send message to all the panelists.
- webinar_other_status: The authority to chat for the host, co-host and panelist to chat in webinar object with properties:
- can_chat_to_all_panellist: TRUE indicates that the user owns the authority to send message to all the panelists.
- can_chat_to_all_panellist_and_attendee: TRUE indicates that the user owns the authority to send message to all.
- can_chat_to_individual: TRUE indicates that the user owns the authority to send message to individual attendee.
- is_chat_off: TRUE indicates that it is disabled to chat in the specified meeting.
- is_webinar_attendee: TRUE indicates that the owner of the current message is the attendee of the webinar.
- is_webinar_meeting: TRUE indicates that the current meeting is webinar.
Otherwise failed, the return value is null.
- Type
- Object
(inner) GetChatStatus() → {Object}
- Description:
- Get the authority status to send current message.
- Source:
Returns:
If the function succeeds, the return value is an object of ChatStatus with the following properties:
- normal_meeting_status: The authority to chat in the normal meeting object with properties:
- can_chat: TRUE indicates that the user owns the authority to send message to chat.
- can_chat_to_all: TRUE indicates that the user owns the authority to send message to all.
- can_chat_to_individual: TRUE indicates that the user owns the authority to send message to an individual attendee in the meeting.
- is_only_can_chat_to_host: TRUE indicates that the user owns the authority to send message only to the host.
- webinar_attendee_status: The authority to chat for the normal attendee in the webinar object with properties:
- can_chat: TRUE indicates that the attendee can send message to chat.
- can_chat_to_all_panellist_and_attendee: TRUE indicates that the user owns the authority to send message to all the panelists and attendees.
- can_chat_to_all_panellist: TRUE indicates that the user owns the authority to send message to all the panelists.
- webinar_other_status: The authority to chat for the host, co-host and panelist to chat in webinar object with properties:
- can_chat_to_all_panellist: TRUE indicates that the user owns the authority to send message to all the panelists.
- can_chat_to_all_panellist_and_attendee: TRUE indicates that the user owns the authority to send message to all.
- can_chat_to_individual: TRUE indicates that the user owns the authority to send message to individual attendee.
- is_chat_off: TRUE indicates that it is disabled to chat in the specified meeting.
- is_webinar_attendee: TRUE indicates that the owner of the current message is the attendee of the webinar.
- is_webinar_meeting: TRUE indicates that the current meeting is webinar.
Otherwise failed, the return value is null.
- Type
- Object
(inner) GetMaxTransferFileSizeBytes() → {Number}
- Description:
- Get the maximum size for file transfer.
- Source:
Returns:
The maximum number of bytes for file transfer.
- Type
- Number
(inner) GetMaxTransferFileSizeBytes() → {Number}
- Description:
- Get the maximum size for file transfer.
- Source:
Returns:
The maximum number of bytes for file transfer.
- Type
- Number
(inner) GetReceiver() → {Number}
- Description:
- Get file receiver's user id.
- Source:
Returns:
The receiver user id. -1 specify the internel error of get user id. 0 specify the file send to all.
- Type
- Number
(inner) GetReceiver() → {Number}
- Description:
- Get file receiver's user id.
- Source:
Returns:
The receiver user id. -1 specify the internel error of get user id. 0 specify the file send to all.
- Type
- Number
(inner) GetSender() → {Number}
- Description:
- Get file sender's user id.
- Source:
Returns:
The receiver user id. -1 specify the internel error of get user id. 0 specify the file send to all.
- Type
- Number
(inner) GetSender() → {Number}
- Description:
- Get file sender's user id.
- Source:
Returns:
The receiver user id. -1 specify the internel error of get user id. 0 specify the file send to all.
- Type
- Number
(inner) GetShareMeetingChatStartedLegalNoticeContent() → {String}
- Description:
- Get the sharing in meeting chat started legal notices content.
- Source:
Returns:
- Type
- String
(inner) GetShareMeetingChatStartedLegalNoticeContent() → {String}
- Description:
- Get the sharing in meeting chat started legal notices content.
- Source:
Returns:
- Type
- String
(inner) GetShareMeetingChatStoppedLegalNoticeContent() → {String}
- Description:
- Get the sharing in meeting chat stopped legal notices content.
- Source:
Returns:
- Type
- String
(inner) GetShareMeetingChatStoppedLegalNoticeContent() → {String}
- Description:
- Get the sharing in meeting chat stopped legal notices content.
- Source:
Returns:
- Type
- String
(inner) GetTransferFileTypeAllowList() → {String}
- Description:
- Get the list of allowed file types in transfer.
- Source:
Returns:
The value of allowed file types in transfer, comma-separated if there are multiple values. Exe files are by default forbidden from being transferred.
- Type
- String
(inner) GetTransferFileTypeAllowList() → {String}
- Description:
- Get the list of allowed file types in transfer.
- Source:
Returns:
The value of allowed file types in transfer, comma-separated if there are multiple values. Exe files are by default forbidden from being transferred.
- Type
- String
(inner) IsChatMessageCanBeDeleted(msgID) → {Boolean}
- Description:
- Determine whether the message can be delete.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
msgID |
String | is the message id. |
Returns:
True indicates the message can be delete. Otherwise False.
- Type
- Boolean
(inner) IsChatMessageCanBeDeleted(msgID) → {Boolean}
- Description:
- Determine whether the message can be delete.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
msgID |
String | is the message id. |
Returns:
True indicates the message can be delete. Otherwise False.
- Type
- Boolean
(inner) IsFileTransferEnabled() → {Boolean}
- Description:
- Determine whether file transfer is enabled.
- Source:
Returns:
True indicates file transfer is enabled, otherwise false.
- Type
- Boolean
(inner) IsFileTransferEnabled() → {Boolean}
- Description:
- Determine whether file transfer is enabled.
- Source:
Returns:
True indicates file transfer is enabled, otherwise false.
- Type
- Boolean
(inner) IsMeetingChatLegalNoticeAvailable() → {Boolean}
- Description:
- Determine whether the legal notice for chat is available.
- Source:
Returns:
True indicates the legal notice for chat is available. Otherwise False.
- Type
- Boolean
(inner) IsMeetingChatLegalNoticeAvailable() → {Boolean}
- Description:
- Determine whether the legal notice for chat is available.
- Source:
Returns:
True indicates the legal notice for chat is available. Otherwise False.
- Type
- Boolean
(inner) IsShareMeetingChatLegalNoticeAvailable() → {Boolean}
- Description:
- Determine whether the legal notice for sharing in meeting chat is available.
- Source:
Returns:
True indicates the legal notice for chat is available. Otherwise False.
- Type
- Boolean
(inner) IsShareMeetingChatLegalNoticeAvailable() → {Boolean}
- Description:
- Determine whether the legal notice for sharing in meeting chat is available.
- Source:
Returns:
True indicates the legal notice for chat is available. Otherwise False.
- Type
- Boolean
(inner) SendLastBuildChatMsgTo() → {Number}
- Description:
- Send a chat message.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SendLastBuildChatMsgTo() → {Number}
- Description:
- Send a chat message.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SetChatMessageBuilder(content, receiver, threadId, type, positionStart, positionEnd, bClearStyles, bClear) → {Number}
- Description:
- Set the chat message builder which can help construct the message entity.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
content |
String | chat message content. |
receiver |
Number | who will receive the chat message. |
threadId |
String | the ID of the thread where the message will be posted. |
type |
Number | the chat message type. |
positionStart |
Number | the segment start position. |
positionEnd |
Number | the segment end position. |
bClearStyles |
Boolean | clear all set styles. not support for MAC platform |
bClear |
Boolean | clear all set properties. not support for MAC platform |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SetChatMessageBuilder(content, receiver, threadId, type, positionStart, positionEnd, bClearStyles, bClear) → {Number}
- Description:
- Set the chat message builder which can help construct the message entity.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
content |
String | chat message content. |
receiver |
Number | who will receive the chat message. |
threadId |
String | the ID of the thread where the message will be posted. |
type |
Number | the chat message type. |
positionStart |
Number | the segment start position. |
positionEnd |
Number | the segment end position. |
bClearStyles |
Boolean | clear all set styles. not support for MAC platform |
bClear |
Boolean | clear all set properties. not support for MAC platform |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SetOnChatMessageEditNotificationCB(onChatMessageEditNotification) → {Boolean}
- Description:
- Set onChatMessageEditNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onChatMessageEditNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnChatMessageEditNotificationCB(onChatMessageEditNotification) → {Boolean}
- Description:
- Set onChatMessageEditNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onChatMessageEditNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnChatMsgDeleteNotificationCB(onChatMsgDeleteNotification) → {Boolean}
- Description:
- Set onChatMsgDeleteNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onChatMsgDeleteNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnChatMsgDeleteNotificationCB(onChatMsgDeleteNotification) → {Boolean}
- Description:
- Set onChatMsgDeleteNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onChatMsgDeleteNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnChatMsgNotificationCB(onChatMsgNotification) → {Boolean}
- Description:
- Set onChatMsgNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onChatMsgNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnChatMsgNotificationCB(onChatMsgNotification) → {Boolean}
- Description:
- Set onChatMsgNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onChatMsgNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnChatStatusChangedNotificationCB(onChatStatusChangedNotification) → {Boolean}
- Description:
- Set onChatStatusChangedNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onChatStatusChangedNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnChatStatusChangedNotificationCB(onChatStatusChangedNotification) → {Boolean}
- Description:
- Set onChatStatusChangedNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onChatStatusChangedNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnFileReceivedCB(onFileReceived) → {Boolean}
- Description:
- Set onFileReceived callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFileReceived |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnFileReceivedCB(onFileReceived) → {Boolean}
- Description:
- Set onFileReceived callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFileReceived |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnFileSendStartCB(onFileSendStart) → {Boolean}
- Description:
- Set onFileSendStart callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFileSendStart |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnFileSendStartCB(onFileSendStart) → {Boolean}
- Description:
- Set onFileSendStart callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFileSendStart |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnFileTransferProgressCB(onFileTransferProgress) → {Boolean}
- Description:
- Set onFileTransferProgress callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFileTransferProgress |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnFileTransferProgressCB(onFileTransferProgress) → {Boolean}
- Description:
- Set onFileTransferProgress callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onFileTransferProgress |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnShareMeetingChatStatusChangedCB(onShareMeetingChatStatusChanged) → {Boolean}
- Description:
- Set onShareMeetingChatStatusChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onShareMeetingChatStatusChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnShareMeetingChatStatusChangedCB(onShareMeetingChatStatusChanged) → {Boolean}
- Description:
- Set onShareMeetingChatStatusChanged callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onShareMeetingChatStatusChanged |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetParticipantsChatPrivilege(privilege) → {Number}
- Description:
- Set the chat privilege of participants.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
privilege |
Number | The chat privilege of participants |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SetParticipantsChatPrivilege(privilege) → {Number}
- Description:
- Set the chat privilege of participants.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
privilege |
Number | The chat privilege of participants |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) StartReceive(path) → {Number}
- Description:
- Start receive the file.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
path |
String | The path to receive the file. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) StartReceive(path) → {Number}
- Description:
- Start receive the file.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
path |
String | The path to receive the file. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) TransferFile(filePath, userid) → {Number}
- Description:
- Send file to specify user in current session. this interface is related to chat privilege, see SDKChatPrivilege.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
filePath |
Number | The absolute path of the file. |
userid |
Number | Send the file to this user. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) TransferFile(filePath, userid) → {Number}
- Description:
- Send file to specify user in current session. this interface is related to chat privilege, see SDKChatPrivilege.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
filePath |
Number | The absolute path of the file. |
userid |
Number | Send the file to this user. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) TransferFileToAll(filePath) → {Number}
- Description:
- Send file to all users in current session. this interface is related to chat privilege, see SDKChatPrivilege.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
filePath |
Number | filePath The absolute path of the file. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) TransferFileToAll(filePath) → {Number}
- Description:
- Send file to all users in current session. this interface is related to chat privilege, see SDKChatPrivilege.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
filePath |
Number | filePath The absolute path of the file. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) getChatLegalNoticesExplained() → {String}
- Description:
- Get the chat legal notices explained.
- Source:
Returns:
The chat legal notices explained.
- Type
- String
(inner) getChatLegalNoticesExplained() → {String}
- Description:
- Get the chat legal notices explained.
- Source:
Returns:
The chat legal notices explained.
- Type
- String
(inner) getChatLegalNoticesPrompt() → {String}
- Description:
- Get the chat legal notices prompt.
- Source:
Returns:
The chat legal notices prompt.
- Type
- String
(inner) getChatLegalNoticesPrompt() → {String}
- Description:
- Get the chat legal notices prompt.
- Source:
Returns:
The chat legal notices prompt.
- Type
- String
Events
onChatMessageEditNotification
- Description:
- Chat message be edited callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
chatMsg |
Object | The chat message with the following properties: - messageID: The message ID of the current message. - senderUserId: The sender ID of the current message. - senderDisplayName: The sender screen name of the current message. - receiverUserId: The receiver ID of the current message. - receiverDisplayName: The receiver screen name of the current message. - content: The content of the current message. - timeStamp: The timestamps of the current message. - isChatToAll: Determine if the current message is sent to all. - isChatToAllPanelist: Determine if the current message is sent to all the panelists. - isChatToWaitingroom: Determine if the current message is sent to waiting room. - chatMessageType: The chat message type of the current message. - isComment: Determine if the current message is a reply to another message. - isThread: Determine if the current message is part of a message thread, and can be directly replied to. - segmentDetails: The chat message segment content and style detail of the current message. - threadID: The current message's thread ID. |
onChatMessageEditNotification
- Description:
- Chat message be edited callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
chatMsg |
Object | The chat message with the following properties: - messageID: The message ID of the current message. - senderUserId: The sender ID of the current message. - senderDisplayName: The sender screen name of the current message. - receiverUserId: The receiver ID of the current message. - receiverDisplayName: The receiver screen name of the current message. - content: The content of the current message. - timeStamp: The timestamps of the current message. - isChatToAll: Determine if the current message is sent to all. - isChatToAllPanelist: Determine if the current message is sent to all the panelists. - isChatToWaitingroom: Determine if the current message is sent to waiting room. - chatMessageType: The chat message type of the current message. - isComment: Determine if the current message is a reply to another message. - isThread: Determine if the current message is part of a message thread, and can be directly replied to. - segmentDetails: The chat message segment content and style detail of the current message. - threadID: The current message's thread ID. |
onChatMsgDeleteNotification
- Description:
- Chat message be deleted callback. This function is used to inform the user host/myself the message be deleted.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
msgID |
String | is the id of the deleted message. |
deleteBy |
Number | Indicates by whom the message was deleted. |
onChatMsgDeleteNotification
- Description:
- Chat message be deleted callback. This function is used to inform the user host/myself the message be deleted.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
msgID |
String | is the id of the deleted message. |
deleteBy |
Number | Indicates by whom the message was deleted. |
onChatMsgNotification
- Description:
- Chat message callback. This function is used to inform the user once received the message sent by others.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
chatMsg |
Object | An object pointer to the chat message with the following properties: - messageID: The message ID of the current message. - senderUserId: The sender ID of the current message. - senderDisplayName: The sender screen name of the current message. - receiverUserId: The receiver ID of the current message. - receiverDisplayName: The receiver screen name of the current message. - content: The content of the current message. - timeStamp: The timestamps of the current message. - isChatToAll: Determine if the current message is sent to all. - isChatToAllPanelist: Determine if the current message is sent to all the panelists. - isChatToWaitingroom: Determine if the current message is sent to waiting room. - chatMessageType: The chat message type of the current message. - isComment: Determine if the current message is a reply to another message. - isThread: Determine if the current message is part of a message thread, and can be directly replied to. - segmentDetails: The chat message segment content and style detail of the current message. - threadID: The current message's thread ID. |
content |
String | The chat message in json format. This parameter is currently invalid, hereby only for reservations. |
onChatMsgNotification
- Description:
- Chat message callback. This function is used to inform the user once received the message sent by others.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
chatMsg |
Object | An object pointer to the chat message with the following properties: - messageID: The message ID of the current message. - senderUserId: The sender ID of the current message. - senderDisplayName: The sender screen name of the current message. - receiverUserId: The receiver ID of the current message. - receiverDisplayName: The receiver screen name of the current message. - content: The content of the current message. - timeStamp: The timestamps of the current message. - isChatToAll: Determine if the current message is sent to all. - isChatToAllPanelist: Determine if the current message is sent to all the panelists. - isChatToWaitingroom: Determine if the current message is sent to waiting room. - chatMessageType: The chat message type of the current message. - isComment: Determine if the current message is a reply to another message. - isThread: Determine if the current message is part of a message thread, and can be directly replied to. - segmentDetails: The chat message segment content and style detail of the current message. - threadID: The current message's thread ID. |
content |
String | The chat message in json format. This parameter is currently invalid, hereby only for reservations. |
onChatStatusChangedNotification
- Description:
- The authority of chat changes callback. This function is used to inform the user when the authority of chat changes in the meeting or webinar.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
status |
Object | The chat status with the following properties: - normal_meeting_status: The authority to chat in the normal meeting object with properties: - can_chat: TRUE indicates that the user owns the authority to send message to chat. - can_chat_to_all: TRUE indicates that the user owns the authority to send message to all. - can_chat_to_individual: TRUE indicates that the user owns the authority to send message to an individual attendee in the meeting. - is_only_can_chat_to_host: TRUE indicates that the user owns the authority to send message only to the host. - webinar_attendee_status: The authority to chat for the normal attendee in the webinar object with properties: - can_chat: TRUE indicates that the attendee can send message to chat. - can_chat_to_all_panellist_and_attendee: TRUE indicates that the user owns the authority to send message to all the panelists and attendees. - can_chat_to_all_panellist: TRUE indicates that the user owns the authority to send message to all the panelists. - webinar_other_status: The authority to chat for the host, co-host and panelist to chat in webinar object with properties: - can_chat_to_all_panellist: TRUE indicates that the user owns the authority to send message to all the panelists. - can_chat_to_all_panellist_and_attendee: TRUE indicates that the user owns the authority to send message to all. - can_chat_to_individual: TRUE indicates that the user owns the authority to send message to individual attendee. - is_chat_off: TRUE indicates that it is disabled to chat in the specified meeting. - is_webinar_attendee: TRUE indicates that the owner of the current message is the attendee of the webinar. - is_webinar_meeting: TRUE indicates that the current meeting is webinar. |
onChatStatusChangedNotification
- Description:
- The authority of chat changes callback. This function is used to inform the user when the authority of chat changes in the meeting or webinar.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
status |
Object | The chat status with the following properties: - normal_meeting_status: The authority to chat in the normal meeting object with properties: - can_chat: TRUE indicates that the user owns the authority to send message to chat. - can_chat_to_all: TRUE indicates that the user owns the authority to send message to all. - can_chat_to_individual: TRUE indicates that the user owns the authority to send message to an individual attendee in the meeting. - is_only_can_chat_to_host: TRUE indicates that the user owns the authority to send message only to the host. - webinar_attendee_status: The authority to chat for the normal attendee in the webinar object with properties: - can_chat: TRUE indicates that the attendee can send message to chat. - can_chat_to_all_panellist_and_attendee: TRUE indicates that the user owns the authority to send message to all the panelists and attendees. - can_chat_to_all_panellist: TRUE indicates that the user owns the authority to send message to all the panelists. - webinar_other_status: The authority to chat for the host, co-host and panelist to chat in webinar object with properties: - can_chat_to_all_panellist: TRUE indicates that the user owns the authority to send message to all the panelists. - can_chat_to_all_panellist_and_attendee: TRUE indicates that the user owns the authority to send message to all. - can_chat_to_individual: TRUE indicates that the user owns the authority to send message to individual attendee. - is_chat_off: TRUE indicates that it is disabled to chat in the specified meeting. - is_webinar_attendee: TRUE indicates that the owner of the current message is the attendee of the webinar. - is_webinar_meeting: TRUE indicates that the current meeting is webinar. |
onFileReceived
- Description:
- Invoked when receiving a file from another user.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
receiverInfo |
Object | The class to receive the file object with the following properties: - messageID: The message identify of transfer file. - trans_status: The status of the file transfer. - time_stamp: The time stamp of the file. - is_send_to_all: Is the file send to all user in meeting. - file_size: The bytes of transfer file size. - file_name: The file name of transfer file. - timeStamp: The time stamp of the file. - complete_percentage: The percentage of the file transfer completed. - complete_size: The size of the file transferred so far in bytes. - bit_per_second: The speed of the file transfer in bits per second. |
onFileReceived
- Description:
- Invoked when receiving a file from another user.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
receiverInfo |
Object | The class to receive the file object with the following properties: - messageID: The message identify of transfer file. - trans_status: The status of the file transfer. - time_stamp: The time stamp of the file. - is_send_to_all: Is the file send to all user in meeting. - file_size: The bytes of transfer file size. - file_name: The file name of transfer file. - timeStamp: The time stamp of the file. - complete_percentage: The percentage of the file transfer completed. - complete_size: The size of the file transferred so far in bytes. - bit_per_second: The speed of the file transfer in bits per second. |
onFileSendStart
- Description:
- Invoked when start send file.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
senderInfo |
Object | The class to send file object with the following properties: - messageID: The message identify of transfer file. - trans_status: The status of the file transfer. - time_stamp: The time stamp of the file. - is_send_to_all: Is the file send to all user in meeting. - file_size: The bytes of transfer file size. - file_name: The file name of transfer file. - timeStamp: The time stamp of the file. - complete_percentage: The percentage of the file transfer completed. - complete_size: The size of the file transferred so far in bytes. - bit_per_second: The speed of the file transfer in bits per second. |
onFileSendStart
- Description:
- Invoked when start send file.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
senderInfo |
Object | The class to send file object with the following properties: - messageID: The message identify of transfer file. - trans_status: The status of the file transfer. - time_stamp: The time stamp of the file. - is_send_to_all: Is the file send to all user in meeting. - file_size: The bytes of transfer file size. - file_name: The file name of transfer file. - timeStamp: The time stamp of the file. - complete_percentage: The percentage of the file transfer completed. - complete_size: The size of the file transferred so far in bytes. - bit_per_second: The speed of the file transfer in bits per second. |
onFileTransferProgress
- Description:
- Invoked when send or receive file status change.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
transferInfo |
Object | Transfer information with the following properties: - messageID: The message identify of transfer file. - trans_status: The status of the file transfer. - time_stamp: The time stamp of the file. - is_send_to_all: Is the file send to all user in meeting. - file_size: The bytes of transfer file size. - file_name: The file name of transfer file. - timeStamp: The time stamp of the file. - complete_percentage: The percentage of the file transfer completed. - complete_size: The size of the file transferred so far in bytes. - bit_per_second: The speed of the file transfer in bits per second. |
onFileTransferProgress
- Description:
- Invoked when send or receive file status change.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
transferInfo |
Object | Transfer information with the following properties: - messageID: The message identify of transfer file. - trans_status: The status of the file transfer. - time_stamp: The time stamp of the file. - is_send_to_all: Is the file send to all user in meeting. - file_size: The bytes of transfer file size. - file_name: The file name of transfer file. - timeStamp: The time stamp of the file. - complete_percentage: The percentage of the file transfer completed. - complete_size: The size of the file transferred so far in bytes. - bit_per_second: The speed of the file transfer in bits per second. |
onShareMeetingChatStatusChanged
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
isStart |
Boolean |
onShareMeetingChatStatusChanged
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
isStart |
Boolean |