ZMVideoSDKChatHelper Class Reference

Chat helper interface. More...

#include <ZMVideoSDKChatHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isChatDisabled
	Determines whether chat is disabled.
(BOOL)	- isPrivateChatDisabled
	Determines whether private chat is disabled.
(ZMVideoSDKErrors)	- sendChatToUser:content:
	Sends a chat message to a specific user.
(ZMVideoSDKErrors)	- sendChatToAll:
	Sends a chat message to all users.
(BOOL)	- canChatMessageBeDeleted:
	Determines if a specific message supports deletion.
(ZMVideoSDKErrors)	- deleteChatMessage:
	Deletes a specific chat message from the Zoom server.
(ZMVideoSDKErrors)	- changeChatPrivilege:
	Sets participant chat privilege when in session. Only session host or manager can run the function.
(ZMVideoSDKChatPrivilegeType)	- getChatPrivilege
	Gets 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

Determines if a specific message supports deletion.

Parameters

msgID

The message Id.

Returns

YES if the message supports deletion. Otherwise, NO.

changeChatPrivilege:

- (ZMVideoSDKErrors) changeChatPrivilege:

(ZMVideoSDKChatPrivilegeType)

privilege

Sets participant chat privilege when in session. Only session host or manager can run the function.

Parameters

privilege

The participant's chat privilege.

Returns

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

deleteChatMessage:

- (ZMVideoSDKErrors) deleteChatMessage:

(NSString *)

msgID

Deletes a specific chat message from the Zoom server.

Parameters

msgID

The message Id.

Returns

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

Note

This does not delete the message in your user interface.

getChatPrivilege

- (ZMVideoSDKChatPrivilegeType) getChatPrivilege

Gets participant chat privilege when in session.

Returns

The result of participant chat priviledge.

isChatDisabled

- (BOOL) isChatDisabled

Determines whether chat is disabled.

Returns

YES if chat is disabled. Otherwise, NO.

isPrivateChatDisabled

- (BOOL) isPrivateChatDisabled

Determines whether private chat is disabled.

Returns

YES if private chat is disabled. Otherwise, NO.

sendChatToAll:

- (ZMVideoSDKErrors) sendChatToAll:

(NSString *)

msgContent

Sends a chat message to all users.

Parameters

msgContent

The content of message.

Returns

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

sendChatToUser:content:

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

Sends a chat message to a specific user.

Parameters

user	The receiver.
msgContent	The content of message.

Returns

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