zoom_meeting_chat

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. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) CancelReceive() → {Number}

Description:
  • Cancel the file receive.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) CancelSend() → {Number}

Description:
  • Cancel the file send.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) CancelSend() → {Number}

Description:
  • Cancel the file send.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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:
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:
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. 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. 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. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SendLastBuildChatMsgTo() → {Number}

Description:
  • Send a chat message.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetOnChatMessageEditNotificationCB(onChatMessageEditNotification) → {Boolean}

Description:
  • Set chat message be edited callback.
Source:
Parameters:
Name Type Description
onChatMessageEditNotification function
Returns:
Type
Boolean

(inner) SetOnChatMessageEditNotificationCB(onChatMessageEditNotification) → {Boolean}

Description:
  • Set chat message be edited callback.
Source:
Parameters:
Name Type Description
onChatMessageEditNotification function
Returns:
Type
Boolean

(inner) SetOnChatMsgDeleteNotificationCB(onChatMsgDeleteNotification) → {Boolean}

Description:
  • Set chat message be deleted callback.
Source:
Parameters:
Name Type Description
onChatMsgDeleteNotification function
Returns:
Type
Boolean

(inner) SetOnChatMsgDeleteNotificationCB(onChatMsgDeleteNotification) → {Boolean}

Description:
  • Set chat message be deleted callback.
Source:
Parameters:
Name Type Description
onChatMsgDeleteNotification function
Returns:
Type
Boolean

(inner) SetOnChatMsgNotificationCB(onChatMsgNotification) → {Boolean}

Description:
  • Set chat message callback.
Source:
Parameters:
Name Type Description
onChatMsgNotification function
Returns:
Type
Boolean

(inner) SetOnChatMsgNotificationCB(onChatMsgNotification) → {Boolean}

Description:
  • Set chat message callback.
Source:
Parameters:
Name Type Description
onChatMsgNotification function
Returns:
Type
Boolean

(inner) SetOnChatStatusChangedNotificationCB(onChatStatusChangedNotification) → {Boolean}

Description:
  • Set the authority of chat changes callback.
Source:
Parameters:
Name Type Description
onChatStatusChangedNotification function
Returns:
Type
Boolean

(inner) SetOnChatStatusChangedNotificationCB(onChatStatusChangedNotification) → {Boolean}

Description:
  • Set the authority of chat changes callback.
Source:
Parameters:
Name Type Description
onChatStatusChangedNotification function
Returns:
Type
Boolean

(inner) SetOnFileReceivedCB(onFileReceived) → {Boolean}

Description:
  • Set receiving a file from another user callback.
Source:
Parameters:
Name Type Description
onFileReceived function
Returns:
Type
Boolean

(inner) SetOnFileReceivedCB(onFileReceived) → {Boolean}

Description:
  • Set receiving a file from another user callback.
Source:
Parameters:
Name Type Description
onFileReceived function
Returns:
Type
Boolean

(inner) SetOnFileSendStartCB(onFileSendStart) → {Boolean}

Description:
  • Set start send file callback.
Source:
Parameters:
Name Type Description
onFileSendStart function
Returns:
Type
Boolean

(inner) SetOnFileSendStartCB(onFileSendStart) → {Boolean}

Description:
  • Set start send file callback.
Source:
Parameters:
Name Type Description
onFileSendStart function
Returns:
Type
Boolean

(inner) SetOnFileTransferProgressCB(onFileTransferProgress) → {Boolean}

Description:
  • Set send or receive file status change callback.
Source:
Parameters:
Name Type Description
onFileTransferProgress function
Returns:
Type
Boolean

(inner) SetOnFileTransferProgressCB(onFileTransferProgress) → {Boolean}

Description:
  • Set send or receive file status change callback.
Source:
Parameters:
Name Type Description
onFileTransferProgress function
Returns:
Type
Boolean

(inner) SetOnShareMeetingChatStatusChangedCB(onShareMeetingChatStatusChanged) → {Boolean}

Description:
  • Set share meeting chat status changed callback.
Source:
Parameters:
Name Type Description
onShareMeetingChatStatusChanged function
Returns:
Type
Boolean

(inner) SetOnShareMeetingChatStatusChangedCB(onShareMeetingChatStatusChanged) → {Boolean}

Description:
  • Set share meeting chat status changed callback.
Source:
Parameters:
Name Type Description
onShareMeetingChatStatusChanged function
Returns:
Type
Boolean

(inner) SetParticipantsChatPrivilege(privilege) → {Number}

Description:
  • Accept the chat.
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. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetParticipantsChatPrivilege(privilege) → {Number}

Description:
  • Accept the chat.
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) getChatLegalNoticesExplained() → {String}

Description:
  • Get the chat legal notices explained.
Source:
Returns:
Type
String

(inner) getChatLegalNoticesExplained() → {String}

Description:
  • Get the chat legal notices explained.
Source:
Returns:
Type
String

(inner) getChatLegalNoticesPrompt() → {String}

Description:
  • Get the chat legal notices prompt.
Source:
Returns:
Type
String

(inner) getChatLegalNoticesPrompt() → {String}

Description:
  • Get the chat legal notices prompt.
Source:
Returns:
Type
String

Events

onChatMessageEditNotification

Description:
  • Chat message be edited callback.
Source:
Parameters:
Name Type Description
chatMsg Object Chat message object

onChatMessageEditNotification

Description:
  • Chat message be edited callback.
Source:
Parameters:
Name Type Description
chatMsg Object Chat message object

onChatMsgDeleteNotification

Description:
  • Callback event used to inform the user host/myself the message be deleted.
Source:
Parameters:
Name Type Description
msgID String
deleteBy Number chat message delete type, Defined in: ChatMessageDeleteType

onChatMsgDeleteNotification

Description:
  • Callback event used to inform the user host/myself the message be deleted.
Source:
Parameters:
Name Type Description
msgID String
deleteBy Number chat message delete type, Defined in: ChatMessageDeleteType

onChatMsgNotification

Description:
  • Callback event used to inform the user once received the message sent by others.
Source:
Parameters:
Name Type Description
chatMsg Object Chat message object
content String

onChatMsgNotification

Description:
  • Callback event used to inform the user once received the message sent by others.
Source:
Parameters:
Name Type Description
chatMsg Object Chat message object
content String

onChatStatusChangedNotification

Description:
  • Callback event used to inform the user when the authority of chat changes in the meeting or webinar.
Source:
Parameters:
Name Type Description
status Object The authority to chat in the specified meeting.

onChatStatusChangedNotification

Description:
  • Callback event used to inform the user when the authority of chat changes in the meeting or webinar.
Source:
Parameters:
Name Type Description
status Object The authority to chat in the specified meeting.

onFileReceived

Description:
  • Callback event invoked when receiving a file from another user.
Source:
Parameters:
Name Type Description
receiverInfo Object receiver The class to receive the file object.

onFileReceived

Description:
  • Callback event invoked when receiving a file from another user.
Source:
Parameters:
Name Type Description
receiverInfo Object receiver The class to receive the file object.

onFileSendStart

Description:
  • Callback event invoked when start send file.
Source:
Parameters:
Name Type Description
senderInfo Object sender The class to send file object.

onFileSendStart

Description:
  • Callback event invoked when start send file.
Source:
Parameters:
Name Type Description
senderInfo Object sender The class to send file object.

onFileTransferProgress

Description:
  • Callback event Invoked when send or receive file status change.
Source:
Parameters:
Name Type Description
transferInfo Object info The class to basic transfer information.

onFileTransferProgress

Description:
  • Callback event Invoked when send or receive file status change.
Source:
Parameters:
Name Type Description
transferInfo Object info The class to basic transfer information.

onShareMeetingChatStatusChanged

Description:
  • Callback event used to inform the user when share meeting chat status changed.
Source:
Parameters:
Name Type Description
isStart Boolean

onShareMeetingChatStatusChanged

Description:
  • Callback event used to inform the user when share meeting chat status changed.
Source:
Parameters:
Name Type Description
isStart Boolean
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. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) CancelReceive() → {Number}

Description:
  • Cancel the file receive.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) CancelSend() → {Number}

Description:
  • Cancel the file send.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) CancelSend() → {Number}

Description:
  • Cancel the file send.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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:
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:
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. 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. 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. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SendLastBuildChatMsgTo() → {Number}

Description:
  • Send a chat message.
Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetOnChatMessageEditNotificationCB(onChatMessageEditNotification) → {Boolean}

Description:
  • Set chat message be edited callback.
Source:
Parameters:
Name Type Description
onChatMessageEditNotification function
Returns:
Type
Boolean

(inner) SetOnChatMessageEditNotificationCB(onChatMessageEditNotification) → {Boolean}

Description:
  • Set chat message be edited callback.
Source:
Parameters:
Name Type Description
onChatMessageEditNotification function
Returns:
Type
Boolean

(inner) SetOnChatMsgDeleteNotificationCB(onChatMsgDeleteNotification) → {Boolean}

Description:
  • Set chat message be deleted callback.
Source:
Parameters:
Name Type Description
onChatMsgDeleteNotification function
Returns:
Type
Boolean

(inner) SetOnChatMsgDeleteNotificationCB(onChatMsgDeleteNotification) → {Boolean}

Description:
  • Set chat message be deleted callback.
Source:
Parameters:
Name Type Description
onChatMsgDeleteNotification function
Returns:
Type
Boolean

(inner) SetOnChatMsgNotificationCB(onChatMsgNotification) → {Boolean}

Description:
  • Set chat message callback.
Source:
Parameters:
Name Type Description
onChatMsgNotification function
Returns:
Type
Boolean

(inner) SetOnChatMsgNotificationCB(onChatMsgNotification) → {Boolean}

Description:
  • Set chat message callback.
Source:
Parameters:
Name Type Description
onChatMsgNotification function
Returns:
Type
Boolean

(inner) SetOnChatStatusChangedNotificationCB(onChatStatusChangedNotification) → {Boolean}

Description:
  • Set the authority of chat changes callback.
Source:
Parameters:
Name Type Description
onChatStatusChangedNotification function
Returns:
Type
Boolean

(inner) SetOnChatStatusChangedNotificationCB(onChatStatusChangedNotification) → {Boolean}

Description:
  • Set the authority of chat changes callback.
Source:
Parameters:
Name Type Description
onChatStatusChangedNotification function
Returns:
Type
Boolean

(inner) SetOnFileReceivedCB(onFileReceived) → {Boolean}

Description:
  • Set receiving a file from another user callback.
Source:
Parameters:
Name Type Description
onFileReceived function
Returns:
Type
Boolean

(inner) SetOnFileReceivedCB(onFileReceived) → {Boolean}

Description:
  • Set receiving a file from another user callback.
Source:
Parameters:
Name Type Description
onFileReceived function
Returns:
Type
Boolean

(inner) SetOnFileSendStartCB(onFileSendStart) → {Boolean}

Description:
  • Set start send file callback.
Source:
Parameters:
Name Type Description
onFileSendStart function
Returns:
Type
Boolean

(inner) SetOnFileSendStartCB(onFileSendStart) → {Boolean}

Description:
  • Set start send file callback.
Source:
Parameters:
Name Type Description
onFileSendStart function
Returns:
Type
Boolean

(inner) SetOnFileTransferProgressCB(onFileTransferProgress) → {Boolean}

Description:
  • Set send or receive file status change callback.
Source:
Parameters:
Name Type Description
onFileTransferProgress function
Returns:
Type
Boolean

(inner) SetOnFileTransferProgressCB(onFileTransferProgress) → {Boolean}

Description:
  • Set send or receive file status change callback.
Source:
Parameters:
Name Type Description
onFileTransferProgress function
Returns:
Type
Boolean

(inner) SetOnShareMeetingChatStatusChangedCB(onShareMeetingChatStatusChanged) → {Boolean}

Description:
  • Set share meeting chat status changed callback.
Source:
Parameters:
Name Type Description
onShareMeetingChatStatusChanged function
Returns:
Type
Boolean

(inner) SetOnShareMeetingChatStatusChangedCB(onShareMeetingChatStatusChanged) → {Boolean}

Description:
  • Set share meeting chat status changed callback.
Source:
Parameters:
Name Type Description
onShareMeetingChatStatusChanged function
Returns:
Type
Boolean

(inner) SetParticipantsChatPrivilege(privilege) → {Number}

Description:
  • Accept the chat.
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. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) SetParticipantsChatPrivilege(privilege) → {Number}

Description:
  • Accept the chat.
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
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. To get extended error information, Defined in: ZoomSDKError
Type
Number

(inner) getChatLegalNoticesExplained() → {String}

Description:
  • Get the chat legal notices explained.
Source:
Returns:
Type
String

(inner) getChatLegalNoticesExplained() → {String}

Description:
  • Get the chat legal notices explained.
Source:
Returns:
Type
String

(inner) getChatLegalNoticesPrompt() → {String}

Description:
  • Get the chat legal notices prompt.
Source:
Returns:
Type
String

(inner) getChatLegalNoticesPrompt() → {String}

Description:
  • Get the chat legal notices prompt.
Source:
Returns:
Type
String

Events

onChatMessageEditNotification

Description:
  • Chat message be edited callback.
Source:
Parameters:
Name Type Description
chatMsg Object Chat message object

onChatMessageEditNotification

Description:
  • Chat message be edited callback.
Source:
Parameters:
Name Type Description
chatMsg Object Chat message object

onChatMsgDeleteNotification

Description:
  • Callback event used to inform the user host/myself the message be deleted.
Source:
Parameters:
Name Type Description
msgID String
deleteBy Number chat message delete type, Defined in: ChatMessageDeleteType

onChatMsgDeleteNotification

Description:
  • Callback event used to inform the user host/myself the message be deleted.
Source:
Parameters:
Name Type Description
msgID String
deleteBy Number chat message delete type, Defined in: ChatMessageDeleteType

onChatMsgNotification

Description:
  • Callback event used to inform the user once received the message sent by others.
Source:
Parameters:
Name Type Description
chatMsg Object Chat message object
content String

onChatMsgNotification

Description:
  • Callback event used to inform the user once received the message sent by others.
Source:
Parameters:
Name Type Description
chatMsg Object Chat message object
content String

onChatStatusChangedNotification

Description:
  • Callback event used to inform the user when the authority of chat changes in the meeting or webinar.
Source:
Parameters:
Name Type Description
status Object The authority to chat in the specified meeting.

onChatStatusChangedNotification

Description:
  • Callback event used to inform the user when the authority of chat changes in the meeting or webinar.
Source:
Parameters:
Name Type Description
status Object The authority to chat in the specified meeting.

onFileReceived

Description:
  • Callback event invoked when receiving a file from another user.
Source:
Parameters:
Name Type Description
receiverInfo Object receiver The class to receive the file object.

onFileReceived

Description:
  • Callback event invoked when receiving a file from another user.
Source:
Parameters:
Name Type Description
receiverInfo Object receiver The class to receive the file object.

onFileSendStart

Description:
  • Callback event invoked when start send file.
Source:
Parameters:
Name Type Description
senderInfo Object sender The class to send file object.

onFileSendStart

Description:
  • Callback event invoked when start send file.
Source:
Parameters:
Name Type Description
senderInfo Object sender The class to send file object.

onFileTransferProgress

Description:
  • Callback event Invoked when send or receive file status change.
Source:
Parameters:
Name Type Description
transferInfo Object info The class to basic transfer information.

onFileTransferProgress

Description:
  • Callback event Invoked when send or receive file status change.
Source:
Parameters:
Name Type Description
transferInfo Object info The class to basic transfer information.

onShareMeetingChatStatusChanged

Description:
  • Callback event used to inform the user when share meeting chat status changed.
Source:
Parameters:
Name Type Description
isStart Boolean

onShareMeetingChatStatusChanged

Description:
  • Callback event used to inform the user when share meeting chat status changed.
Source:
Parameters:
Name Type Description
isStart Boolean