Package us.zoom.sdk
Interface InMeetingChatController
public interface InMeetingChatController
Chat controller in meeting.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
Chat group in meeting.static enum
Enumeration of the privilege for attendee chat.static enum
Enumeration of webinar chat privilege typesstatic enum
Enumeration of the panelist chat privilege in webinar meeting. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Only webinar host/co-host can run the functionboolean
Only meeting host/co-host can run the functiondeleteChatMessage
(String msgId) Delete chat message by message id.Get all chat message id.Return explained text for chat legal noticeReturn chat legal notice promptgetChatMessageById
(String msgID) Get chat message by message ID.long
Get the maximum size for file transfer.Get the chat privilege of the meeting participant.Get the chat privilege of the panelist.Return meeting chat legal notice content when start to share meeting chatReturn meeting chat legal notice content when stop to share meeting chatGet the list of allowed file types in transfer.Get the chat privilege of the webinar attendee.boolean
Query if it is disabled to chat in the current meeting.boolean
isChatMessageCanBeDeleted
(String msgId) Determine whether the message can be delete.boolean
Determine whether file transfer is enabled.boolean
Whether chat legal notice is availableboolean
Query if meeting participants can send private 1:1 message to another participant.boolean
Whether meeting chat legal notice is availableSend a chat message.Set the chat privilege of the panelist.transferFile
(String filePath, long toUser) Send file to specify user in current meeting.transferFileToAll
(String filePath) Send file to all users in current meeting.
-
Method Details
-
isChatDisabled
boolean isChatDisabled()Query if it is disabled to chat in the current meeting.- Returns:
- TRUE means that the chat in current meeting is disabled.
-
isPrivateChatDisabled
boolean isPrivateChatDisabled()Query if meeting participants can send private 1:1 message to another participant.- Returns:
- TRUE means that the private chat in current meeting is disabled.
-
getChatMessageById
Get chat message by message ID.- Parameters:
msgID
- the message ID.
-
sendChatMsgTo
Send a chat message.- Parameters:
msg
- the message info.
-
allowAttendeeChat
Only webinar host/co-host can run the function- Parameters:
privilege
- The privilege will be set.- Returns:
- success or not
-
changeAttendeeChatPrivilege
boolean changeAttendeeChatPrivilege(InMeetingChatController.MobileRTCMeetingChatPrivilege privilege) Only meeting host/co-host can run the function- Parameters:
privilege
- The privilege will be set.- Returns:
- success or not
-
setPanelistChatPrivilege
MobileRTCSDKError setPanelistChatPrivilege(InMeetingChatController.MobileRTCWebinarPanelistChatPrivilege privilege) Set the chat privilege of the panelist.- Parameters:
privilege
- The chat privilege of the panelist. seeInMeetingChatController.MobileRTCWebinarPanelistChatPrivilege
- Returns:
- If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see
MobileRTCSDKError
.
-
getPanelistChatPrivilege
InMeetingChatController.MobileRTCWebinarPanelistChatPrivilege getPanelistChatPrivilege()Get the chat privilege of the panelist.- Returns:
- The chat privilege of the panelist. see
InMeetingChatController.MobileRTCWebinarPanelistChatPrivilege
-
getWebinarAttendeeChatPrivilege
InMeetingChatController.MobileRTCWebinarChatPrivilege getWebinarAttendeeChatPrivilege()Get the chat privilege of the webinar attendee.- Returns:
- The chat privilege of the webinar attendee. see
InMeetingChatController.MobileRTCWebinarChatPrivilege
-
getMeetingAttendeeChatPrivilege
InMeetingChatController.MobileRTCMeetingChatPrivilege getMeetingAttendeeChatPrivilege()Get the chat privilege of the meeting participant.- Returns:
- The chat privilege of the meeting participant. see
InMeetingChatController.MobileRTCMeetingChatPrivilege
-
isMeetingChatLegalNoticeAvailable
boolean isMeetingChatLegalNoticeAvailable()Whether chat legal notice is available- Returns:
- True if chat legal notice is available
-
getChatLegalNoticesPrompt
String getChatLegalNoticesPrompt()Return chat legal notice prompt- Returns:
- notice prompt
-
getChatLegalNoticesExplained
String getChatLegalNoticesExplained()Return explained text for chat legal notice- Returns:
- explained text for notice
-
deleteChatMessage
Delete chat message by message id.- Parameters:
msgId
- the message id.- Returns:
- If the function succeeds, the return value is SDKErr_Success. Otherwise failed, returns calling error. For more details, see
MobileRTCSDKError
.
-
getAllChatMessageID
Get all chat message id.- Returns:
- the all chat message id list. null means failed.
-
isChatMessageCanBeDeleted
Determine whether the message can be delete.- Parameters:
msgId
- the message id.- Returns:
- True indicates the message can be delete. Otherwise False.
-
isFileTransferEnable
boolean isFileTransferEnable()Determine whether file transfer is enabled.- Returns:
- true if file transfer is enabled, otherwise false.
-
transferFile
Send file to specify user in current meeting.- Parameters:
filePath
- The local path of the filetoUser
- Send the file to this user.- Returns:
- If the function succeeds, the return value is
MobileRTCSDKError.SDKERR_SUCCESS
.
-
transferFileToAll
Send file to all users in current meeting.- Parameters:
filePath
- The local path of the file- Returns:
- If the function succeeds, the return value is MobileRTCSDKError_Success.
-
getTransferFileTypeAllowList
String getTransferFileTypeAllowList()Get the list of allowed file types in transfer.- 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.
-
getMaxTransferFileSize
long getMaxTransferFileSize()Get the maximum size for file transfer.- Returns:
- The maximum number of bytes for file transfer.
-