Zoom Rooms Controller SDK Reference 6.5.0
Loading...
Searching...
No Matches
IMeetingChatHelper.h File Reference

Meeting Chat interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures

struct  MeetingChatPrivilege
 Meeting chat privilege. More...
 
struct  ShareFileInMeetingChatParam
 Share file in meeting chat params. More...
 
struct  MeetingChatMessage
 Meeting chat message old chat message struct. More...
 
struct  ChatEmojiCountInfo
 Chat emoji count info. New chat supports emoji reaction. More...
 
struct  ChatEmojiComment
 Chat emoji comment New chat supports emoji reaction. More...
 
struct  NewMeetingChatMessage
 New meeting chat message New meeting chat message struct. Time all timestamp. More...
 
struct  NewMeetingChatThreadItem
 New meeting chat thread item. A thread can contain several comments. More...
 
struct  ChatMessageSyncFilter
 Chat message sync filter. More...
 
class  IMeetingChatHelperSink
 Meeting Chat helper event callback. More...
 
class  IMeetingChatHelper
 Meeting Chat helper interface. More...
 

Enumerations

enum  MeetingChatPrivilegeType {
  MeetingChatPrivilegeTypeUnknown = -1 , MeetingChatPrivilegeTypeAll = 1 , MeetingChatPrivilegeTypeAllPanelist , MeetingChatPrivilegeTypeHost ,
  MeetingChatPrivilegeTypeDisableAttendeeChat , MeetingChatPrivilegeTypeHostPublic
}
 Meeting chat privilege type for participants in normal meeting and attendees in webinar. Here are more detailed structural descriptions. More...
 
enum  MeetingChatPanelistPrivilegeType { MeetingChatPanelistPrivilegeTypeUnknown = -1 , MeetingChatPanelistPrivilegeTypeAllPanelist = 1 , MeetingChatPanelistPrivilegeTypeAll }
 Meeting chat privilege type for panelist in webinar. Here are more detailed structural descriptions. More...
 
enum  MeetingChatMSGSendToType {
  MeetingChatMSGSendToTypeUnknown = -1 , MeetingChatMSGSendToTypeToAll = 0 , MeetingChatMSGSendToTypeToPanelist = 1 , MeetingChatMSGSendToTypeToIndividualCcPanelist = 2 ,
  MeetingChatMSGSendToTypeToIndividual = 3 , MeetingChatMSGSendToTypeToGreenRoom = 7
}
 Meeting chat message send to type. Here are more detailed structural descriptions. More...
 
enum  MeetingChatMessageType {
  MeetingChatMessageType_UNKNOWN = 0 , MeetingChatMessageType_TEXT = 1 , MeetingChatMessageType_FILE = 2 , MeetingChatMessageType_IMAGE = 3 ,
  MeetingChatMessageType_CMC_MEETING = 8 , MeetingChatMessageType_CMC_GROUP_CHAT , MeetingChatMessageType_CMC_GUEST_JOIN_OR_LEFT = 10 , MeetingChatMessageType_REVOKE_MESSAGE = 11
}
 Meeting chat message type. Here are more detailed structural descriptions. More...
 
enum  MeetingChatMessageSubType { MeetingChatMessageSubType_NOT_SET = 0 , MeetingChatMessageSubType_THREAD = 1 , MeetingChatMessageSubType_COMMENT = 2 }
 Meeting chat message sub-type. Here are more detailed structural descriptions. More...
 
enum  MeetingChatMessageState { MeetingChatMessageState_UNKNOWN = 0 , MeetingChatMessageState_SENDING = 1 , MeetingChatMessageState_SENT = 2 , MeetingChatMessageState_RECEIVED = 3 }
 Meeting chat message state. Here are more detailed structural descriptions. More...
 
enum  MeetingChatSyncType { MeetingChatSyncType_UNKNOWN = 0 , MeetingChatSyncType_INIT = 1 , MeetingChatSyncType_LOAD_MORE_HISTORY = 2 }
 Meeting chat sync type. Here are more detailed structural descriptions. More...
 

Detailed Description

Meeting Chat interfaces.

Since
Added in ZRC SDK 6.0.0.

** ZRC SDK supports sending meeting chat feature since 6.1.0 There are two versions of sending meeting chat, check with API IsNewChatExperience.

  1. Old meeting chat: For webinar meeting chat or new meeting chat is OFF on Zoom web, which supports send and view messages.
  2. New meeting chat: Available when new meeting chat is ON on Zoom web, which supports send and view messages and emojis, reply to messages, CMC(Continuous Meeting Chat) feature, etc.

**

Definition in file IMeetingChatHelper.h.

Enumeration Type Documentation

◆ MeetingChatMessageState

Meeting chat message state. Here are more detailed structural descriptions.

Enumerator
MeetingChatMessageState_UNKNOWN 

Unknown.

MeetingChatMessageState_SENDING 

Message sending.

MeetingChatMessageState_SENT 

Message sent.

MeetingChatMessageState_RECEIVED 

Message received.

Definition at line 92 of file IMeetingChatHelper.h.

93{
98};
@ MeetingChatMessageState_SENT
Message sent.
@ MeetingChatMessageState_SENDING
Message sending.
@ MeetingChatMessageState_RECEIVED
Message received.
@ MeetingChatMessageState_UNKNOWN
Unknown.

◆ MeetingChatMessageSubType

Meeting chat message sub-type. Here are more detailed structural descriptions.

Enumerator
MeetingChatMessageSubType_NOT_SET 

Not set.

MeetingChatMessageSubType_THREAD 

Thread. A thread is a root message and can contain other comments.

MeetingChatMessageSubType_COMMENT 

Comment. Message under thread message.

Definition at line 81 of file IMeetingChatHelper.h.

82{
86};
@ MeetingChatMessageSubType_COMMENT
Comment. Message under thread message.
@ MeetingChatMessageSubType_NOT_SET
Not set.
@ MeetingChatMessageSubType_THREAD
Thread. A thread is a root message and can contain other comments.

◆ MeetingChatMessageType

Meeting chat message type. Here are more detailed structural descriptions.

Enumerator
MeetingChatMessageType_UNKNOWN 

Unknown.

MeetingChatMessageType_TEXT 

Message is Text.

MeetingChatMessageType_FILE 

Message is File.

MeetingChatMessageType_IMAGE 

Message is Image, JPG/PNG.

MeetingChatMessageType_CMC_MEETING 

System message, example "Meeting started/ended ${data & time}".

MeetingChatMessageType_CMC_GROUP_CHAT 

System message, example "Messages addressed to "Meeting Group Chat" will also appear in the meeting group chat in Team Chat".

MeetingChatMessageType_CMC_GUEST_JOIN_OR_LEFT 

System message, example "Darrel Marquez joined as a guest / Darrel Marquez left".

MeetingChatMessageType_REVOKE_MESSAGE 

System message, example "You deleted a message".

Definition at line 64 of file IMeetingChatHelper.h.

65{
72 9,
75};
@ MeetingChatMessageType_CMC_MEETING
System message, example "Meeting started/ended ${data & time}".
@ MeetingChatMessageType_REVOKE_MESSAGE
System message, example "You deleted a message".
@ MeetingChatMessageType_UNKNOWN
Unknown.
@ MeetingChatMessageType_TEXT
Message is Text.
@ MeetingChatMessageType_CMC_GROUP_CHAT
System message, example "Messages addressed to "Meeting Group Chat" will also appear in the meeting g...
@ MeetingChatMessageType_CMC_GUEST_JOIN_OR_LEFT
System message, example "Darrel Marquez joined as a guest / Darrel Marquez left".
@ MeetingChatMessageType_IMAGE
Message is Image, JPG/PNG.
@ MeetingChatMessageType_FILE
Message is File.

◆ MeetingChatMSGSendToType

Meeting chat message send to type. Here are more detailed structural descriptions.

Enumerator
MeetingChatMSGSendToTypeUnknown 

Unknown.

MeetingChatMSGSendToTypeToAll 

Send chat to every one.

MeetingChatMSGSendToTypeToPanelist 

Send chat to host and panelists.

MeetingChatMSGSendToTypeToIndividualCcPanelist 

Send chat to individual attendee and cc host and panelists.

MeetingChatMSGSendToTypeToIndividual 

Send chat to individual.

MeetingChatMSGSendToTypeToGreenRoom 

Send chat to backstage.

Definition at line 50 of file IMeetingChatHelper.h.

51{
58};
@ MeetingChatMSGSendToTypeToAll
Send chat to every one.
@ MeetingChatMSGSendToTypeToIndividual
Send chat to individual.
@ MeetingChatMSGSendToTypeUnknown
Unknown.
@ MeetingChatMSGSendToTypeToPanelist
Send chat to host and panelists.
@ MeetingChatMSGSendToTypeToIndividualCcPanelist
Send chat to individual attendee and cc host and panelists.
@ MeetingChatMSGSendToTypeToGreenRoom
Send chat to backstage.

◆ MeetingChatPanelistPrivilegeType

Meeting chat privilege type for panelist in webinar. Here are more detailed structural descriptions.

Enumerator
MeetingChatPanelistPrivilegeTypeUnknown 

Meeting chat panelist privilege type is unknown.

MeetingChatPanelistPrivilegeTypeAllPanelist 

Meeting chat panelist privilege type is all panelist.

MeetingChatPanelistPrivilegeTypeAll 

Meeting chat panelist privilege type is all.

Definition at line 39 of file IMeetingChatHelper.h.

40{
44};
@ MeetingChatPanelistPrivilegeTypeAllPanelist
Meeting chat panelist privilege type is all panelist.
@ MeetingChatPanelistPrivilegeTypeUnknown
Meeting chat panelist privilege type is unknown.
@ MeetingChatPanelistPrivilegeTypeAll
Meeting chat panelist privilege type is all.

◆ MeetingChatPrivilegeType

Meeting chat privilege type for participants in normal meeting and attendees in webinar. Here are more detailed structural descriptions.

Enumerator
MeetingChatPrivilegeTypeUnknown 

Meeting chat privilege type is unknown.

MeetingChatPrivilegeTypeAll 

Meeting chat privilege type is all.

MeetingChatPrivilegeTypeAllPanelist 

Meeting chat privilege type is panelist.

MeetingChatPrivilegeTypeHost 

Meeting chat privilege type is host.

MeetingChatPrivilegeTypeDisableAttendeeChat 

Meeting chat privilege type is none.

MeetingChatPrivilegeTypeHostPublic 

Meeting chat privilege type is host public.

Definition at line 25 of file IMeetingChatHelper.h.

26{
33};
@ MeetingChatPrivilegeTypeAllPanelist
Meeting chat privilege type is panelist.
@ MeetingChatPrivilegeTypeAll
Meeting chat privilege type is all.
@ MeetingChatPrivilegeTypeUnknown
Meeting chat privilege type is unknown.
@ MeetingChatPrivilegeTypeHostPublic
Meeting chat privilege type is host public.
@ MeetingChatPrivilegeTypeDisableAttendeeChat
Meeting chat privilege type is none.
@ MeetingChatPrivilegeTypeHost
Meeting chat privilege type is host.

◆ MeetingChatSyncType

Meeting chat sync type. Here are more detailed structural descriptions.

Enumerator
MeetingChatSyncType_UNKNOWN 

Unknown.

MeetingChatSyncType_INIT 

Init action.

MeetingChatSyncType_LOAD_MORE_HISTORY 

Load more history.

Definition at line 104 of file IMeetingChatHelper.h.

105{
109};
@ MeetingChatSyncType_UNKNOWN
Unknown.
@ MeetingChatSyncType_LOAD_MORE_HISTORY
Load more history.
@ MeetingChatSyncType_INIT
Init action.