ZOOM Windows SDK  5.2.42037.1112
meeting_chat_interface.h
Go to the documentation of this file.
1 
6 #ifndef _MEETING_CHAT_INTERFACE_H_
7 #define _MEETING_CHAT_INTERFACE_H_
8 #include "..\zoom_sdk_def.h"
9 
10 BEGIN_ZOOM_SDK_NAMESPACE
14  typedef enum
15 {
16  SDKChatMessageType_To_None,
23 
27 {
28 public:
32  virtual unsigned int GetSenderUserId() = 0;
33 
38  virtual const wchar_t* GetSenderDisplayName() = 0;
39 
45  virtual unsigned int GetReceiverUserId() = 0;
46 
50  virtual const wchar_t* GetReceiverDisplayName() = 0;
51 
55  virtual const wchar_t* GetContent() = 0;
56 
59  virtual time_t GetTimeStamp() = 0;
60 
63  virtual bool IsChatToAll() = 0;
64 
67  virtual bool IsChatToAllPanelist() = 0;
68 
71  virtual bool IsChatToWaitingroom() = 0;
72 
76 
77  virtual ~IChatMsgInfo() {};
78 };
79 
85 {
86  bool can_chat;
91 
97 {
98  bool can_chat;
102 
108 {
113 
118 typedef struct tagChatStatus
119 {
120  union
121  {
122  NormalMeetingChatStaus normal_meeting_status;
123  WebinarAttendeeChatStatus webinar_attendee_status;
124  WebinarOtherUserRoleChatStatus webinar_other_status;
125  }ut;
129 
130  tagChatStatus()
131  {
132  Reset();
133  }
134 
135  void Reset()
136  {
137  memset(this, 0, sizeof(tagChatStatus));
138  }
139 }ChatStatus;
140 
144 typedef enum {
145  SDK_CHAT_PRIVILEDGE_ALL = 1,
152 
153 
157 {
158 public:
162  virtual void onChatMsgNotifcation(IChatMsgInfo* chatMsg, const wchar_t* content = NULL) = 0;
163 
166  virtual void onChatStautsChangedNotification(ChatStatus* status_) = 0;
167 };
168 
174 {
179 };
180 
185 typedef struct tagSendChatItem4Webinar
186 {
188  const wchar_t* content;
189  unsigned int userID;
191  {
193  content = NULL;
194  userID = -1;
195  }
197 
201 {
202 public:
208  virtual SDKError SetEvent(IMeetingChatCtrlEvent* pEvent) = 0;
209 
215  virtual SDKError SendChatTo(unsigned int receiver, wchar_t* content) = 0;
216 
221  virtual SDKError SendChat4WebinarMeeting(SendChatItem4Webinar& chatIteam) = 0;
222 
226  virtual const ChatStatus* GetChatStatus() = 0;
227 
228  virtual SDKError SetParticipantsChatPriviledge(SDKChatPriviledge priviledge) = 0;
229 };
230 END_ZOOM_SDK_NAMESPACE
231 #endif
virtual const wchar_t * GetSenderDisplayName()=0
Get the sender screen name of the current message.
virtual void onChatMsgNotifcation(IChatMsgInfo *chatMsg, const wchar_t *content=NULL)=0
Chat message callback. This function is used to inform the user once received the message sent by oth...
bool is_webinar_meeting
TRUE indicates that the current meeting is webinar.
Definition: meeting_chat_interface.h:128
Disable to send message.
Definition: meeting_chat_interface.h:175
allow attendee to chat with all panelists only, but cannot to "all panelists and attendees" [webinar]...
Definition: meeting_chat_interface.h:147
bool can_chat_to_all_panellist
TRUE indicates that the user owns the authority to send message to all the panelists.
Definition: meeting_chat_interface.h:100
Definition: meeting_chat_interface.h:84
bool is_only_can_chat_to_host
TRUE indicates that the user owns the authority to send message only to the host. ...
Definition: meeting_chat_interface.h:89
allow attendee to chat with no one [meeting & webinar]
Definition: meeting_chat_interface.h:149
For initialize.
Definition: meeting_chat_interface.h:17
virtual SDKError SendChat4WebinarMeeting(SendChatItem4Webinar &chatIteam)=0
Send chat message in webinar.
WebinarChatMsgType
The sending message type in webinar. Here are more detailed structural descriptions..
Definition: meeting_chat_interface.h:173
virtual bool IsChatToAllPanelist()=0
Determine if the current message is sent to all the panelists.
Enable to send message to all the panelists.
Definition: meeting_chat_interface.h:176
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:29
bool is_webinar_attendee
TRUE indicates that the owner of the current message is the attendee of the webinar.
Definition: meeting_chat_interface.h:127
Chat message is send to individual user.
Definition: meeting_chat_interface.h:21
Meeting chat controller interface.
Definition: meeting_chat_interface.h:200
The authority to chat for the host, co-host and panelist to chat in webinar. Here are more detailed s...
Definition: meeting_chat_interface.h:107
Enable to send message to all.
Definition: meeting_chat_interface.h:177
The structure of chat message for webinar. Here are more detailed structural descriptions.
Definition: meeting_chat_interface.h:185
virtual SDKError SendChatTo(unsigned int receiver, wchar_t *content)=0
Send chat message in the normal meeting.
SDKChatPriviledge
Enumerations of the chat priviledge.
Definition: meeting_chat_interface.h:144
bool can_chat_to_all_panellist
TRUE indicates that the user owns the authority to send message to all the panelists.
Definition: meeting_chat_interface.h:109
allow attendee to chat with host and public [meeting]
Definition: meeting_chat_interface.h:150
union tagChatStatus::@1 ut
The ut value depends on the value of the other members in the structure. When the value of is_webinar...
WebinarChatMsgType msgType
The authority to send chat message.
Definition: meeting_chat_interface.h:187
virtual const wchar_t * GetReceiverDisplayName()=0
Get the receiver screen name of the current message.
virtual unsigned int GetReceiverUserId()=0
Get the receiver ID of the current message.
virtual const wchar_t * GetContent()=0
Get the content of the current message.
The authority to chat in the normal meeting. Here are more detailed structural descriptions..
The authority to chat in the specified meeting. Here are more detailed structural descriptions...
Definition: meeting_chat_interface.h:118
bool can_chat_to_individual
TRUE indicates that the user owns the authority to send message to individual attendee.
Definition: meeting_chat_interface.h:111
Chat message is send to all.
Definition: meeting_chat_interface.h:18
virtual time_t GetTimeStamp()=0
Get the timestamps of the current message.
Enable to send message to individual attendee.
Definition: meeting_chat_interface.h:178
bool can_chat_to_all_panellist_and_attendee
TRUE indicates that the user owns the authority to send message to all the panelists and attendees...
Definition: meeting_chat_interface.h:99
bool can_chat
TRUE indicates that the user owns the authority to send message to chat.
Definition: meeting_chat_interface.h:86
Meeting chat callback event.
Definition: meeting_chat_interface.h:156
bool can_chat
TRUE indicates that the attendee can send message to chat.
Definition: meeting_chat_interface.h:98
Chat message interface.
Definition: meeting_chat_interface.h:26
virtual bool IsChatToAll()=0
Determine if the current message is sent to all.
const wchar_t * content
The content of the message.
Definition: meeting_chat_interface.h:188
virtual SDKChatMessageType GetChatMessageType()=0
Get the chat message type of the current message.
virtual const ChatStatus * GetChatStatus()=0
Get the authority status to send current message.
bool is_chat_off
TRUE indicates that it is disabled to chat in the specified meeting.
Definition: meeting_chat_interface.h:126
virtual void onChatStautsChangedNotification(ChatStatus *status_)=0
The authority of chat changes callback. This function is used to inform the user when the authority o...
Chat message is send to all panelists.
Definition: meeting_chat_interface.h:19
SDKChatMessageType
Enumerations of the type for chat message.
Definition: meeting_chat_interface.h:14
virtual SDKError SetEvent(IMeetingChatCtrlEvent *pEvent)=0
Set meeting chat callback event.
allow attendee to chat with everyone [meeting & webinar]
Definition: meeting_chat_interface.h:146
virtual unsigned int GetSenderUserId()=0
Get the sender ID of the current message.
The authority to chat for the normal attendee in the webinar. Here are more detailed structural descr...
Definition: meeting_chat_interface.h:96
bool can_chat_to_individual
TRUE indicates that the user owns the authority to send message to an individual attendee in the meet...
Definition: meeting_chat_interface.h:88
allow attendee to chat with host only [meeting]
Definition: meeting_chat_interface.h:148
bool can_chat_to_all
TRUE indicates that the user owns the authority to send message to all.
Definition: meeting_chat_interface.h:87
bool can_chat_to_all_panellist_and_attendee
TRUE indicates that the user owns the authority to send message to all.
Definition: meeting_chat_interface.h:110
virtual bool IsChatToWaitingroom()=0
Determine if the current message is sent to waiting room.
unsigned int userID
This member is only used to specify the attendee ID when the authority is WebinarChatMsgType_ToIndivi...
Definition: meeting_chat_interface.h:189
Chat message is send to individual attendee and cc panelists.
Definition: meeting_chat_interface.h:20