ZoomSDKMeetingChatController Class Reference

Provide APIs to manage in-meeting chat messages and file transfers. More...

#include <ZoomSDKMeetingChatController.h>

Inherits NSObject.

Instance Methods
(ZoomSDKChatInfo *_Nullable)	- getChatMessageById:
	Get chat message by message ID.
(ZoomSDKError)	- sendChatMsgTo:
	Send a chat message.
(BOOL)	- isFileTransferEnabled
	Determine whether file transfer is enabled.
(ZoomSDKError)	- transferFile:toUser:
	Send file to specify user in current meeting.
(ZoomSDKError)	- transferFileToAll:
	Send file to all users in current meeting.
(NSString *_Nullable)	- getTransferFileTypeAllowList
	Get the list of allowed file types in transfer.
(unsigned long long)	- getMaxTransferFileSizeBytes
	Get the maximum size for file transfer.

Properties
id< ZoomSDKMeetingChatControllerDelegate >	delegate
	Set the delegate to receive chat and file transfer events.

Detailed Description

Provide APIs to manage in-meeting chat messages and file transfers.

Definition at line 675 of file ZoomSDKMeetingChatController.h.

Method Documentation

getChatMessageById:

- (ZoomSDKChatInfo *_Nullable) getChatMessageById:

(NSString *)

messageID

Get chat message by message ID.

Parameters

messageID

The message ID.

Returns

If the function succeeds, it will return object ZoomSDKChatInfo.

getMaxTransferFileSizeBytes

- (unsigned long long) getMaxTransferFileSizeBytes

Get the maximum size for file transfer.

Returns

The maximum number of bytes for file transfer.

getTransferFileTypeAllowList

- (NSString *_Nullable) 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.

isFileTransferEnabled

- (BOOL) isFileTransferEnabled

Determine whether file transfer is enabled.

Returns

True if file transfer is enabled, otherwise false.

sendChatMsgTo:

- (ZoomSDKError) sendChatMsgTo:

(ZoomSDKChatInfo *)

message

Send a chat message.

Parameters

message

The message info.

Returns

If the function succeeds, it will return ZoomSDKError_Success.

transferFile:toUser:

- (ZoomSDKError) transferFile:		(NSString *)	filePath
toUser:		(unsigned int)	userId

Send file to specify user in current meeting.

Parameters

filePath	The absolute path of the file.
userId	Send the file to this user.

Returns

If the function succeeds, the return value is ZoomSDKError_Success.

Warning

This interface related chat privilege. See ZoomSDKChatPrivilegeType.

transferFileToAll:

- (ZoomSDKError) transferFileToAll:

(NSString *)

filePath

Send file to all users in current meeting.

Parameters

filePath

The absolute path of the file.

Returns

If the function succeeds, the return value is ZoomSDKError_Success.

Warning

This interface related chat privilege. See ZoomSDKChatPrivilegeType.

Property Documentation

delegate

- (id<ZoomSDKMeetingChatControllerDelegate>) delegate

readwritenonatomicassign

Set the delegate to receive chat and file transfer events.

Definition at line 679 of file ZoomSDKMeetingChatController.h.