ZMVideoSDKChatHelper Class Reference

Chat helper interface. More...

#include <ZMVideoSDKChatHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isChatDisabled
	Determine whether chat is disabled.
(BOOL)	- isPrivateChatDisabled
	Determine whether private chat is disabled.
(ZMVideoSDKErrors)	- sendChatToUser:content:
	Call this method to send a chat message to a specific user.
(ZMVideoSDKErrors)	- sendChatToAll:
	Call this method to send a chat message to all users.
(BOOL)	- canChatMessageBeDeleted:
	Determine if a specific message can be deleted.
(ZMVideoSDKErrors)	- deleteChatMessage:
	Call this method to delete a specific chat message from the Zoom server.
(ZMVideoSDKErrors)	- changeChatPrivilege:
	Set participant chat privilege when in session. Only session host/manager can run the function.
(ZMVideoSDKChatPrivilegeType)	- getChatPrivilege
	Get participant chat privilege when in session.

Detailed Description

Chat helper interface.

Definition at line 15 of file ZMVideoSDKChatHelper.h.

Method Documentation

canChatMessageBeDeleted:

- (BOOL) canChatMessageBeDeleted:

(NSString *)

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:

- (ZMVideoSDKErrors) changeChatPrivilege:

(ZMVideoSDKChatPrivilegeType)

privilege

Set participant chat privilege when in session. Only session host/manager can run the function.

Parameters

privilege

The chat privilege of the participant.

Returns

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

deleteChatMessage:

- (ZMVideoSDKErrors) deleteChatMessage:

(NSString *)

msgID

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

Parameters

msgID

The message Id.

Returns

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

Note

This does not delete the message in your user interface.

getChatPrivilege

- (ZMVideoSDKChatPrivilegeType) getChatPrivilege

Get participant chat privilege when in session.

Returns

The result of participant chat priviledge.

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:

- (ZMVideoSDKErrors) sendChatToAll:

(NSString *)

msgContent

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

Parameters

msgContent

The content of message.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

sendChatToUser:content:

- (ZMVideoSDKErrors) sendChatToUser:		(ZMVideoSDKUser *)	user
content:		(NSString *)	msgContent

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

Parameters

user	The receiver.
msgContent	The content of message.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.