IZoomVideoSDKChatHelper Class Reference

Chat helper interface. More...

#include <zoom_video_sdk_chat_helper_interface.h>

Public Member Functions
virtual bool	isChatDisabled ()=0
	Determine whether chat is disabled.
virtual bool	isPrivateChatDisabled ()=0
	Determine whether private chat is disabled.
virtual ZoomVideoSDKErrors	sendChatToUser (IZoomVideoSDKUser *pUser, const zchar_t *msgContent)=0
	Send a chat message to a specific user.
virtual ZoomVideoSDKErrors	sendChatToAll (const zchar_t *msgContent)=0
	Send a chat message to all users.
virtual bool	canChatMessageBeDeleted (const zchar_t *msgID)=0
	Determine if a specific message can be deleted.
virtual ZoomVideoSDKErrors	deleteChatMessage (const zchar_t *msgID)=0
	delete a specific chat message from the Zoom server. This does not delete the message in your user interface.
virtual ZoomVideoSDKErrors	changeChatPrivilege (ZoomVideoSDKChatPrivilegeType privilege)=0
	Set participant Chat Privilege when in session. Only session host/manager can run the function.
virtual ZoomVideoSDKChatPrivilegeType	getChatPrivilege ()=0
	Get participant Chat Privilege when in session.

Detailed Description

Chat helper interface.

Definition at line 36 of file zoom_video_sdk_chat_helper_interface.h.

Member Function Documentation

canChatMessageBeDeleted()

virtual bool IZoomVideoSDKChatHelper::canChatMessageBeDeleted ( const zchar_t * msgID )

pure virtual

Determine if a specific message can be deleted.

Parameters

msgID

The message id.

Returns

True if the message can be deleted, otherwise False.

changeChatPrivilege()

virtual ZoomVideoSDKErrors IZoomVideoSDKChatHelper::changeChatPrivilege ( ZoomVideoSDKChatPrivilegeType privilege )

pure virtual

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 ZoomVideoSDKErrors_Success, otherwise failed. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

deleteChatMessage()

virtual ZoomVideoSDKErrors IZoomVideoSDKChatHelper::deleteChatMessage ( const zchar_t * msgID )

pure virtual

delete a specific chat message from the Zoom server. This does not delete the message in your user interface.

Parameters

msgID

The message id.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

getChatPrivilege()

virtual ZoomVideoSDKChatPrivilegeType IZoomVideoSDKChatHelper::getChatPrivilege ( )

pure virtual

Get participant Chat Privilege when in session.

Returns

The result of participant chat priviledge.

isChatDisabled()

virtual bool IZoomVideoSDKChatHelper::isChatDisabled ( )

pure virtual

Determine whether chat is disabled.

Returns

True if chat is disabled, otherwise false.

isPrivateChatDisabled()

virtual bool IZoomVideoSDKChatHelper::isPrivateChatDisabled ( )

pure virtual

Determine whether private chat is disabled.

Returns

True if private chat is disabled, otherwise false.

sendChatToAll()

virtual ZoomVideoSDKErrors IZoomVideoSDKChatHelper::sendChatToAll ( const zchar_t * msgContent )

pure virtual

Send a chat message to all users.

Parameters

msgContent

The message content.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.

sendChatToUser()

virtual ZoomVideoSDKErrors IZoomVideoSDKChatHelper::sendChatToUser ( IZoomVideoSDKUser * pUser, const zchar_t * msgContent )

pure virtual

Send a chat message to a specific user.

Parameters

pUser	The receiver.
msgContent	The message content.

Returns

If the function succeeds, the return value is ZoomVideoSDKErrors_Success. Otherwise failed. To get extended error information, see ZoomVideoSDKErrors enum.