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:
	Gets chat message by message ID.
(ZoomSDKError)	- sendChatMsgTo:
	Sends a chat message.
(BOOL)	- isFileTransferEnabled
	Determines whether file transfer is enabled.
(ZoomSDKError)	- transferFile:toUser:
	Sends file to specify user in current meeting.
(ZoomSDKError)	- transferFileToAll:
	Sends file to all users in current meeting.
(NSString *_Nullable)	- getTransferFileTypeAllowList
	Gets the list of allowed file types in transfer.
(unsigned long long)	- getMaxTransferFileSizeBytes
	Gets the maximum size for file transfer.

Properties
id< ZoomSDKMeetingChatControllerDelegate >	delegate
	Sets 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

Gets chat message by message ID.

Parameters

messageID

The message ID.

Returns

If the function succeeds, it returns object ZoomSDKChatInfo. Otherwise, this function fails and returns nil.

getMaxTransferFileSizeBytes

- (unsigned long long) getMaxTransferFileSizeBytes

Gets the maximum size for file transfer.

Returns

The maximum number of bytes for file transfer.

References getMaxTransferFileSizeBytes.

Referenced by getMaxTransferFileSizeBytes.

getTransferFileTypeAllowList

- (NSString *_Nullable) getTransferFileTypeAllowList

Gets 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. Otherwise, this function fails and returns nil.

References getTransferFileTypeAllowList.

Referenced by getTransferFileTypeAllowList.

isFileTransferEnabled

- (BOOL) isFileTransferEnabled

Determines whether file transfer is enabled.

Returns

YES if file transfer is enabled. Otherwise, NO.

References isFileTransferEnabled.

Referenced by isFileTransferEnabled.

sendChatMsgTo:

- (ZoomSDKError) sendChatMsgTo:

(ZoomSDKChatInfo *)

message

Sends a chat message.

Parameters

message

The message info.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

transferFile:toUser:

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

Sends file to specify user in current meeting.

Parameters

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

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Warning

This interface related chat privilege. See ZoomSDKChatPrivilegeType.

transferFileToAll:

- (ZoomSDKError) transferFileToAll:

(NSString *)

filePath

Sends file to all users in current meeting.

Parameters

filePath

The file's absolute path.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Warning

This interface related chat privilege. See ZoomSDKChatPrivilegeType.

Property Documentation

delegate

- (id<ZoomSDKMeetingChatControllerDelegate>) delegate

readwritenonatomicassign

Sets the delegate to receive chat and file transfer events.

Definition at line 679 of file ZoomSDKMeetingChatController.h.