ZoomVideoSDKChatHelper Class Reference

A class to operate the instant message in session. More...

#include <ZoomVideoSDKChatHelper.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- SendChatToUser:Content:
	Call this method to send a chat message to a specific user.
(ZoomVideoSDKError)	- SendChatToAll:
	Call this method to send a chat message to all users.
(BOOL)	- canChatMessageBeDeleted:
	Determine if a specific message can be deleted.
(ZoomVideoSDKError)	- deleteChatMessage:
	Call this method to delete a specific chat message from the Zoom server.
(BOOL)	- IsChatDisabled
	Determine whether chat is disabled.
(BOOL)	- IsPrivateChatDisabled
	Determine whether private chat is disabled.
(ZoomVideoSDKError)	- changeChatPrivilege:
	Set participant Chat Privilege when in session.
(ZoomVideoSDKChatPrivilegeType)	- getChatPrivilege
	get participant Chat Privilege when in session

Detailed Description

A class to operate the instant message in session.

Definition at line 56 of file ZoomVideoSDKChatHelper.h.

Method Documentation

canChatMessageBeDeleted:

- (BOOL) canChatMessageBeDeleted:

(NSString *__nonnull)

msgID

Determine if a specific message can be deleted.

Parameters

msgID

The message ID.

Returns

YES if the message can be deleted, otherwise NO.

changeChatPrivilege:

- (ZoomVideoSDKError) changeChatPrivilege:

(ZoomVideoSDKChatPrivilegeType)

privilege

Set participant Chat Privilege when in session.

Parameters

privilege

The chat privilege of the participant

Returns

If the function succeeds, it will return Errors_Success, otherwise failed.

Warning

Only meeting host/manager can run the function

deleteChatMessage:

- (ZoomVideoSDKError) deleteChatMessage:

(NSString *__nonnull)

msgID

Call this method to delete a specific chat message from the Zoom server.

Warning

This does not delete the message in your user interface.

Parameters

msgID

The message ID.

Returns

If the function succeeds, it will return Errors_Success, otherwise failed.

getChatPrivilege

- (ZoomVideoSDKChatPrivilegeType) getChatPrivilege

get participant Chat Privilege when in session

Returns

the result of participant chat Privilege.

IsChatDisabled

- (BOOL) IsChatDisabled

Determine whether chat is disabled.

Returns

YES if chat is disabled, otherwise NO.

IsPrivateChatDisabled

- (BOOL) IsPrivateChatDisabled

Determine whether private chat is disabled.

Returns

YES if private chat is disabled, otherwise NO.

SendChatToAll:

- (ZoomVideoSDKError) SendChatToAll:

(NSString *_Nullable)

content

Call this method to send a chat message to all users.

Parameters

content

The message content.

Returns

The result of it.

SendChatToUser:Content:

- (ZoomVideoSDKError) SendChatToUser:		(ZoomVideoSDKUser *_Nullable)	user
Content:		(NSString *_Nullable)	content

Call this method to send a chat message to a specific user.

Parameters

user	The receiver.
content	The message content.

Returns

The result of it.