Meeting SDK for Android API Reference
Loading...
Searching...
No Matches
us.zoom.sdk.InMeetingChatController Interface Reference

Chat controller in meeting. More...

Data Structures

enum  MobileRTCChatGroup
 Chat group in meeting. More...
 
enum  MobileRTCMeetingChatPrivilege
 Enumeration of the privilege for attendee chat. More...
 
enum  MobileRTCWebinarChatPrivilege
 Enumeration of webinar chat privilege types. More...
 
enum  MobileRTCWebinarPanelistChatPrivilege
 Enumeration of the panelist chat privilege in webinar meeting. More...
 

Public Member Functions

boolean isChatDisabled ()
 Query if it is disabled to chat in the current meeting.
 
boolean isPrivateChatDisabled ()
 Query if meeting participants can send private 1:1 message to another participant.
 
InMeetingChatMessage getChatMessageById (String msgID)
 Get chat message by message ID.
 
MobileRTCSDKError sendChatMsgTo (InMeetingChatMessage msg)
 Send a chat message.
 
boolean allowAttendeeChat (MobileRTCWebinarChatPrivilege privilege)
 Only webinar host/co-host can run the function.
 
boolean changeAttendeeChatPrivilege (MobileRTCMeetingChatPrivilege privilege)
 Only meeting host/co-host can run the function.
 
MobileRTCSDKError setPanelistChatPrivilege (MobileRTCWebinarPanelistChatPrivilege privilege)
 Set the chat privilege of the panelist.
 
MobileRTCWebinarPanelistChatPrivilege getPanelistChatPrivilege ()
 Get the chat privilege of the panelist.
 
MobileRTCWebinarChatPrivilege getWebinarAttendeeChatPrivilege ()
 Get the chat privilege of the webinar attendee.
 
MobileRTCMeetingChatPrivilege getMeetingAttendeeChatPrivilege ()
 Get the chat privilege of the meeting participant.
 
boolean isMeetingChatLegalNoticeAvailable ()
 Whether chat legal notice is available.
 
String getChatLegalNoticesPrompt ()
 Return chat legal notice prompt.
 
String getChatLegalNoticesExplained ()
 Return explained text for chat legal notice.
 
MobileRTCSDKError deleteChatMessage (String msgId)
 Delete chat message by message id.
 
List< String > getAllChatMessageID ()
 Get all chat message id.
 
boolean isChatMessageCanBeDeleted (String msgId)
 Determine whether the message can be delete.
 
boolean isShareMeetingChatLegalNoticeAvailable ()
 Whether meeting chat legal notice is available.
 
String getShareMeetingChatStartedLegalNoticeContent ()
 Return meeting chat legal notice content when start to share meeting chat.
 
String getShareMeetingChatStoppedLegalNoticeContent ()
 Return meeting chat legal notice content when stop to share meeting chat.
 
boolean isFileTransferEnable ()
 Determine whether file transfer is enabled.
 
MobileRTCSDKError transferFile (String filePath, long toUser)
 Send file to specify user in current meeting.
 
MobileRTCSDKError transferFileToAll (String filePath)
 Send file to all users in current meeting.
 
String getTransferFileTypeAllowList ()
 Get the list of allowed file types in transfer.
 
long getMaxTransferFileSize ()
 Get the maximum size for file transfer.
 

Detailed Description

Chat controller in meeting.

Definition at line 9 of file InMeetingChatController.java.

Member Function Documentation

◆ allowAttendeeChat()

boolean us.zoom.sdk.InMeetingChatController.allowAttendeeChat ( MobileRTCWebinarChatPrivilege privilege)

Only webinar host/co-host can run the function.

Parameters
privilegeThe privilege will be set.
Returns
success or not

◆ changeAttendeeChatPrivilege()

boolean us.zoom.sdk.InMeetingChatController.changeAttendeeChatPrivilege ( MobileRTCMeetingChatPrivilege privilege)

Only meeting host/co-host can run the function.

Parameters
privilegeThe privilege will be set.
Returns
success or not

◆ deleteChatMessage()

MobileRTCSDKError us.zoom.sdk.InMeetingChatController.deleteChatMessage ( String msgId)

Delete chat message by message id.

Parameters
msgIdthe message id.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ getAllChatMessageID()

List< String > us.zoom.sdk.InMeetingChatController.getAllChatMessageID ( )

Get all chat message id.

Returns
the all chat message id list. null means failed.

◆ getChatLegalNoticesExplained()

String us.zoom.sdk.InMeetingChatController.getChatLegalNoticesExplained ( )

Return explained text for chat legal notice.

Returns
explained text for notice

◆ getChatLegalNoticesPrompt()

String us.zoom.sdk.InMeetingChatController.getChatLegalNoticesPrompt ( )

Return chat legal notice prompt.

Returns
notice prompt

◆ getChatMessageById()

InMeetingChatMessage us.zoom.sdk.InMeetingChatController.getChatMessageById ( String msgID)

Get chat message by message ID.

Parameters
msgIDthe message ID.

◆ getMaxTransferFileSize()

long us.zoom.sdk.InMeetingChatController.getMaxTransferFileSize ( )

Get the maximum size for file transfer.

Returns
The maximum number of bytes for file transfer.

◆ getMeetingAttendeeChatPrivilege()

MobileRTCMeetingChatPrivilege us.zoom.sdk.InMeetingChatController.getMeetingAttendeeChatPrivilege ( )

Get the chat privilege of the meeting participant.

Returns
The chat privilege of the meeting participant.

◆ getPanelistChatPrivilege()

MobileRTCWebinarPanelistChatPrivilege us.zoom.sdk.InMeetingChatController.getPanelistChatPrivilege ( )

Get the chat privilege of the panelist.

Returns
The chat privilege of the panelist.

◆ getShareMeetingChatStartedLegalNoticeContent()

String us.zoom.sdk.InMeetingChatController.getShareMeetingChatStartedLegalNoticeContent ( )

Return meeting chat legal notice content when start to share meeting chat.

Returns
notice content

◆ getShareMeetingChatStoppedLegalNoticeContent()

String us.zoom.sdk.InMeetingChatController.getShareMeetingChatStoppedLegalNoticeContent ( )

Return meeting chat legal notice content when stop to share meeting chat.

Returns
notice content

◆ getTransferFileTypeAllowList()

String us.zoom.sdk.InMeetingChatController.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.

◆ getWebinarAttendeeChatPrivilege()

MobileRTCWebinarChatPrivilege us.zoom.sdk.InMeetingChatController.getWebinarAttendeeChatPrivilege ( )

Get the chat privilege of the webinar attendee.

Returns
The chat privilege of the webinar attendee.

◆ isChatDisabled()

boolean us.zoom.sdk.InMeetingChatController.isChatDisabled ( )

Query if it is disabled to chat in the current meeting.

Returns
TRUE means that the chat in current meeting is disabled.

◆ isChatMessageCanBeDeleted()

boolean us.zoom.sdk.InMeetingChatController.isChatMessageCanBeDeleted ( String msgId)

Determine whether the message can be delete.

Parameters
msgIdthe message id.
Returns
True indicates the message can be delete. Otherwise False.

◆ isFileTransferEnable()

boolean us.zoom.sdk.InMeetingChatController.isFileTransferEnable ( )

Determine whether file transfer is enabled.

Returns
true if file transfer is enabled, otherwise false.

◆ isMeetingChatLegalNoticeAvailable()

boolean us.zoom.sdk.InMeetingChatController.isMeetingChatLegalNoticeAvailable ( )

Whether chat legal notice is available.

Returns
True if chat legal notice is available

◆ isPrivateChatDisabled()

boolean us.zoom.sdk.InMeetingChatController.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.

◆ isShareMeetingChatLegalNoticeAvailable()

boolean us.zoom.sdk.InMeetingChatController.isShareMeetingChatLegalNoticeAvailable ( )

Whether meeting chat legal notice is available.

Returns
True if meeting chat legal notice is available

◆ sendChatMsgTo()

MobileRTCSDKError us.zoom.sdk.InMeetingChatController.sendChatMsgTo ( InMeetingChatMessage msg)

Send a chat message.

Parameters
msgthe message info.

◆ setPanelistChatPrivilege()

MobileRTCSDKError us.zoom.sdk.InMeetingChatController.setPanelistChatPrivilege ( MobileRTCWebinarPanelistChatPrivilege privilege)

Set the chat privilege of the panelist.

Parameters
privilegeThe chat privilege of the panelist.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ transferFile()

MobileRTCSDKError us.zoom.sdk.InMeetingChatController.transferFile ( String filePath,
long toUser )

Send file to specify user in current meeting.

Parameters
filePathThe local path of the file
toUserSend the file to this user.
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.

◆ transferFileToAll()

MobileRTCSDKError us.zoom.sdk.InMeetingChatController.transferFileToAll ( String filePath)

Send file to all users in current meeting.

Parameters
filePathThe local path of the file
Returns
If the function succeeds, it will return SDKERR_SUCCESS. Otherwise failed.