ZoomVideoSDKChatHelper Class Reference

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

#include <ZoomVideoSDKChatHelper.h>

Inherits NSObject.

Instance Methods
(ZoomVideoSDKError)	- SendChatToUser:Content:
	Sends a chat message to a specific user.
(ZoomVideoSDKError)	- SendChatToAll:
	Sends a chat message to all users.
(BOOL)	- canChatMessageBeDeleted:
	Determines whether a specific message can be deleted.
(ZoomVideoSDKError)	- deleteChatMessage:
	Deletes a specific chat message from the Zoom server.
(BOOL)	- IsChatDisabled
	Determines whether chat is disabled.
(BOOL)	- IsPrivateChatDisabled
	Determines whether private chat is disabled.
(ZoomVideoSDKError)	- changeChatPrivilege:
	Sets participant chat privilege when in session.
(ZoomVideoSDKChatPrivilegeType)	- getChatPrivilege
	Gets participant chat privilege when in session.

Detailed Description

A class to operate the instant message in session.

Definition at line 53 of file ZoomVideoSDKChatHelper.h.

Method Documentation

canChatMessageBeDeleted:

- (BOOL) canChatMessageBeDeleted:

(NSString *__nonnull)

msgID

Determines whether 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

Sets participant chat privilege when in session.

Parameters

privilege

The chat privilege of the participant.

Returns

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

Warning

Only meeting host or manager can run the function.

deleteChatMessage:

- (ZoomVideoSDKError) deleteChatMessage:

(NSString *__nonnull)

msgID

Deletes a specific chat message from the Zoom server.

Parameters

msgID

The message ID.

Returns

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

Warning

This does not delete the message in your user interface.

getChatPrivilege

- (ZoomVideoSDKChatPrivilegeType) getChatPrivilege

Gets participant chat privilege when in session.

Returns

The result of participant chat Privilege.

References getChatPrivilege.

Referenced by getChatPrivilege.

IsChatDisabled

- (BOOL) IsChatDisabled

Determines whether chat is disabled.

Returns

YES if chat is disabled. Otherwise, NO.

References IsChatDisabled.

Referenced by IsChatDisabled.

IsPrivateChatDisabled

- (BOOL) IsPrivateChatDisabled

Determines whether private chat is disabled.

Returns

YES if private chat is disabled. Otherwise, NO.

References IsPrivateChatDisabled.

Referenced by IsPrivateChatDisabled.

SendChatToAll:

- (ZoomVideoSDKError) SendChatToAll:

(NSString *_Nullable)

content

Sends a chat message to all users.

Parameters

content

The message content.

Returns

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

SendChatToUser:Content:

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

Sends a chat message to a specific user.

Parameters

user	The receiver.
content	The message content.

Returns

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