Unity Video SDK API Reference Documentation
Loading...
Searching...
No Matches
ZMVideoSDKChatHelper Class Reference

Public Member Functions

bool IsChatDisabled ()
 
bool IsPrivateChatDisabled ()
 
void SendChatToUser (ZMVideoSDKUser user, string msgContent, Action< ZMVideoSDKErrors > callback)
 
void SendChatToAll (string msgContent, Action< ZMVideoSDKErrors > callback)
 
void DeleteChatMessage (string msgId, Action< ZMVideoSDKErrors > callback)
 
bool CanChatMessageBeDeleted (string msgId)
 
ZMVideoSDKErrors ChangeChatPrivilege (ZMVideoSDKChatPrivilegeType privilege)
 
ZMVideoSDKChatPrivilegeType GetChatPrivilege ()
 

Detailed Description

Chat interface.

See ZoomVideoSDK#getChatHelper()

Definition at line 7 of file ZMVideoSDKChatHelper.cs.

Member Function Documentation

◆ CanChatMessageBeDeleted()

bool ZMVideoSDKChatHelper.CanChatMessageBeDeleted ( string  msgId)
inline

Determine if a specific message can be deleted.

Parameters
msgIdthe message Id
Returns
true if the message can be deleted, otherwise False.

Definition at line 95 of file ZMVideoSDKChatHelper.cs.

96 {
97 return _videoSDKChatHelper.CanChatMessageBeDeleted(msgId);
98 }

◆ ChangeChatPrivilege()

ZMVideoSDKErrors ZMVideoSDKChatHelper.ChangeChatPrivilege ( ZMVideoSDKChatPrivilegeType  privilege)
inline

Set participant Chat Privilege when in session Note: Only session host/manager can run the function

Parameters
privilegeThe chat privilege of the participant
Returns
If the function succeeds, it will return Errors_Success, otherwise failed.

Definition at line 107 of file ZMVideoSDKChatHelper.cs.

108 {
109 return _videoSDKChatHelper.ChangeChatPrivilege(privilege);
110 }

◆ DeleteChatMessage()

void ZMVideoSDKChatHelper.DeleteChatMessage ( string  msgId,
Action< ZMVideoSDKErrors callback 
)
inline

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

Parameters
msgIdthe message Id
Returns
ZoomVideoSDKErrors

Definition at line 84 of file ZMVideoSDKChatHelper.cs.

85 {
86 _videoSDKChatHelper.DeleteChatMessage(msgId, callback);
87 }

◆ GetChatPrivilege()

ZMVideoSDKChatPrivilegeType ZMVideoSDKChatHelper.GetChatPrivilege ( )
inline

get participant Chat Priviledge when in session

Returns
the result of participant chat priviledge.

Definition at line 116 of file ZMVideoSDKChatHelper.cs.

117 {
118 return _videoSDKChatHelper.GetChatPrivilege();
119 }

◆ IsChatDisabled()

bool ZMVideoSDKChatHelper.IsChatDisabled ( )
inline

Determine whether chat is disabled.

Returns
true if chat is disabled, otherwise false.

Definition at line 39 of file ZMVideoSDKChatHelper.cs.

40 {
41 return _videoSDKChatHelper.IsChatDisabled();
42 }

◆ IsPrivateChatDisabled()

bool ZMVideoSDKChatHelper.IsPrivateChatDisabled ( )
inline

Determine whether private chat is disabled.

Returns
true if private chat is disabled, otherwise false.

Definition at line 49 of file ZMVideoSDKChatHelper.cs.

50 {
51 return _videoSDKChatHelper.IsPrivateChatDisabled();
52 }

◆ SendChatToAll()

void ZMVideoSDKChatHelper.SendChatToAll ( string  msgContent,
Action< ZMVideoSDKErrors callback 
)
inline

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

Parameters
msgContentthe message content
Returns
ZoomVideoSDKErrors

Definition at line 72 of file ZMVideoSDKChatHelper.cs.

73 {
74 _videoSDKChatHelper.SendChatToAll(msgContent, callback);
75 }

◆ SendChatToUser()

void ZMVideoSDKChatHelper.SendChatToUser ( ZMVideoSDKUser  user,
string  msgContent,
Action< ZMVideoSDKErrors callback 
)
inline

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

Parameters
userthe receiver
msgContentthe message content
Returns
ZoomVideoSDKErrors

Definition at line 61 of file ZMVideoSDKChatHelper.cs.

62 {
63 _videoSDKChatHelper.SendChatToUser(user, msgContent, callback);
64 }