Windows SDK API Reference
Loading...
Searching...
No Matches
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
14typedef enum
15{
23
27{
28public:
32 virtual const wchar_t* GetMessageID() = 0;
33
37 virtual unsigned int GetSenderUserId() = 0;
38
43 virtual const wchar_t* GetSenderDisplayName() = 0;
44
50 virtual unsigned int GetReceiverUserId() = 0;
51
55 virtual const wchar_t* GetReceiverDisplayName() = 0;
56
60 virtual const wchar_t* GetContent() = 0;
61
64 virtual time_t GetTimeStamp() = 0;
65
68 virtual bool IsChatToAll() = 0;
69
72 virtual bool IsChatToAllPanelist() = 0;
73
76 virtual bool IsChatToWaitingroom() = 0;
77
81
82 virtual ~IChatMsgInfo() {};
83};
84
90{
96
102{
107
113{
118
123typedef struct tagChatStatus
124{
125 union
126 {
134
136 {
137 Reset();
138 }
139
140 void Reset()
141 {
142 memset(this, 0, sizeof(tagChatStatus)); //checked safe
143 }
145
149typedef enum {
157
161typedef enum
162{
168
172{
173public:
175
179 virtual void onChatMsgNotifcation(IChatMsgInfo* chatMsg, const wchar_t* content = NULL) = 0;
180
183 virtual void onChatStautsChangedNotification(ChatStatus* status_) = 0;
184
188 virtual void onChatMsgDeleteNotification(const wchar_t* msgID, SDKChatMessageDeleteType deleteBy) = 0;
189
190 virtual void onShareMeetingChatStatusChanged(bool isStart) = 0;
191};
192
196{
197public:
204
208 virtual const ChatStatus* GetChatStatus() = 0;
209
215
222 virtual SDKError SendChatMsgTo(wchar_t* content, unsigned int receiver, SDKChatMessageType type) = 0;
223
227
229 virtual const wchar_t* getChatLegalNoticesPrompt() = 0;
230
232 virtual const wchar_t* getChatLegalNoticesExplained() = 0;
233
237
240
243
247 virtual bool IsChatMessageCanBeDeleted(const wchar_t* msgID) = 0;
248
253 virtual SDKError DeleteChatMessage(const wchar_t* msgID) = 0;
254
257};
259#endif
Chat message interface.
virtual const wchar_t * GetContent()=0
Get the content of the current message.
virtual bool IsChatToAllPanelist()=0
Determine if the current message is sent to all the panelists.
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 time_t GetTimeStamp()=0
Get the timestamps of the current message.
virtual SDKChatMessageType GetChatMessageType()=0
Get the chat message type of the current message.
virtual bool IsChatToAll()=0
Determine if the current message is sent to all.
virtual const wchar_t * GetSenderDisplayName()=0
Get the sender screen name of the current message.
virtual bool IsChatToWaitingroom()=0
Determine if the current message is sent to waiting room.
virtual unsigned int GetSenderUserId()=0
Get the sender ID of the current message.
virtual const wchar_t * GetMessageID()=0
Get the message ID of the current message.
Meeting chat controller interface.
virtual IList< const wchar_t * > * GetAllChatMessageID()=0
Get all chat message id.
virtual SDKError SetParticipantsChatPriviledge(SDKChatPriviledge priviledge)=0
Set the chat priviledge of participants.
virtual bool IsShareMeetingChatLegalNoticeAvailable()=0
Determine whether the legal notice for sharing in meeting chat is available.
virtual SDKError SetEvent(IMeetingChatCtrlEvent *pEvent)=0
Set meeting chat callback event.
virtual const wchar_t * getChatLegalNoticesExplained()=0
Get the chat legal notices explained.
virtual const wchar_t * getChatLegalNoticesPrompt()=0
Get the chat legal notices prompt.
virtual bool IsChatMessageCanBeDeleted(const wchar_t *msgID)=0
Determine whether the message can be delete.
virtual const wchar_t * GetShareMeetingChatStoppedLegalNoticeContent()=0
Get the sharing in meeting chat stopped legal notices content.
virtual const ChatStatus * GetChatStatus()=0
Get the authority status to send current message.
virtual SDKError SendChatMsgTo(wchar_t *content, unsigned int receiver, SDKChatMessageType type)=0
Send chat message in the normal meeting.
virtual SDKError DeleteChatMessage(const wchar_t *msgID)=0
virtual const wchar_t * GetShareMeetingChatStartedLegalNoticeContent()=0
Get the sharing in meeting chat started legal notices content.
virtual bool IsMeetingChatLegalNoticeAvailable()=0
Determine whether the legal notice for chat is available.
Meeting chat callback event.
virtual void onShareMeetingChatStatusChanged(bool isStart)=0
virtual void onChatMsgDeleteNotification(const wchar_t *msgID, SDKChatMessageDeleteType deleteBy)=0
Chat message be deleted callback. This function is used to inform the user host/myself the message be...
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...
virtual void onChatStautsChangedNotification(ChatStatus *status_)=0
The authority of chat changes callback. This function is used to inform the user when the authority o...
SDKChatMessageType
Enumerations of the type for chat message.
@ SDKChatMessageType_To_None
@ SDKChatMessageType_To_WaitingRoomUsers
Chat message is send to individual user.
@ SDKChatMessageType_To_Individual
Chat message is send to individual attendee and cc panelists.
@ SDKChatMessageType_To_All
For initialize
@ SDKChatMessageType_To_Individual_Panelist
Chat message is send to all panelists.
@ SDKChatMessageType_To_All_Panelist
Chat message is send to all.
struct tagWebinarOtherUserRoleChatStatus WebinarOtherUserRoleChatStatus
struct tagChatStatus ChatStatus
SDKChatPriviledge
Enumerations of the chat priviledge.
@ SDK_CHAT_PRIVILEDGE_END
allow attendee to chat with host and public [meeting]
@ SDK_CHAT_PRIVILEDGE_DISABLE_ATTENDEE_CHAT
allow attendee to chat with host only [meeting]
@ SDK_CHAT_PRIVILEDGE_HOST_PUBLIC
allow attendee to chat with no one [meeting & webinar]
@ SDK_CHAT_PRIVILEDGE_HOST
allow attendee to chat with all panelists only, but cannot to "all panelists and attendees" [webinar]
@ SDK_CHAT_PRIVILEDGE_ALL
@ SDK_CHAT_PRIVILEDGE_ALL_PANELIST
allow attendee to chat with everyone [meeting & webinar]
struct tagNormalMeetingChatStaus NormalMeetingChatStaus
struct tagWebinarAttendeeChatStatus WebinarAttendeeChatStatus
SDKChatMessageDeleteType
Enumerations of the chat message delete type.
@ SDK_CHAT_DELETE_BY_HOST
delete by self
@ SDK_CHAT_DELETE_BY_NONE
@ SDK_CHAT_DELETE_BY_DLP
delete by host
@ SDK_CHAT_DELETE_BY_SELF
none
The authority to chat in the specified meeting. Here are more detailed structural descriptions....
union tagChatStatus::@0 ut
The ut value depends on the value of the other members in the structure. When the value of is_webinar...
bool is_chat_off
TRUE indicates that it is disabled to chat in the specified meeting.
WebinarAttendeeChatStatus webinar_attendee_status
bool is_webinar_meeting
TRUE indicates that the current meeting is webinar.
bool is_webinar_attendee
TRUE indicates that the owner of the current message is the attendee of the webinar.
NormalMeetingChatStaus normal_meeting_status
WebinarOtherUserRoleChatStatus webinar_other_status
bool can_chat_to_individual
TRUE indicates that the user owns the authority to send message to an individual attendee in the meet...
bool can_chat
TRUE indicates that the user owns the authority to send message to chat.
bool can_chat_to_all
TRUE indicates that the user owns the authority to send message to all.
bool is_only_can_chat_to_host
TRUE indicates that the user owns the authority to send message only to the host.
The authority to chat for the normal attendee in the webinar. Here are more detailed structural descr...
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.
bool can_chat_to_all_panellist
TRUE indicates that the user owns the authority to send message to all the panelists.
bool can_chat
TRUE indicates that the attendee can send message to chat.
The authority to chat for the host, co-host and panelist to chat in webinar. Here are more detailed s...
bool can_chat_to_all_panellist_and_attendee
TRUE indicates that the user owns the authority to send message to all.
bool can_chat_to_all_panellist
TRUE indicates that the user owns the authority to send message to all the panelists.
bool can_chat_to_individual
TRUE indicates that the user owns the authority to send message to individual attendee.
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
Definition: zoom_sdk_def.h:21
#define BEGIN_ZOOM_SDK_NAMESPACE
Definition: zoom_sdk_def.h:20
SDKError
SDK error types. Here are more detailed structural descriptions.
Definition: zoom_sdk_def.h:30