Meeting SDK for Windows API Reference
Loading...
Searching...
No Matches
presence_helper_interface.h
Go to the documentation of this file.
1
5#ifndef _PRESENCE_HELPER_INTERFACE_H_
6#define _PRESENCE_HELPER_INTERFACE_H_
7#include "zoom_sdk_def.h"
8
10
39
45{
46public:
51 virtual const zchar_t* GetContactId() = 0;
52
57 virtual const zchar_t* GetContactName() = 0;
58
64
69 virtual const zchar_t* GetProfilePicture() = 0;
70
75 virtual const zchar_t* GetPersonalNote() = 0;
76
81 virtual const zchar_t* GetCompanyName() = 0;
82
87 virtual const zchar_t* GetDepartment() = 0;
88
93 virtual const zchar_t* GetJobTitle() = 0;
94
99 virtual const zchar_t* GetPhoneNumber() = 0;
100
105 virtual const zchar_t* GetEmail() = 0;
106
107 virtual ~IContactInfo(){};
108};
109
115{
116public:
118
123 virtual const zchar_t* GetSenderId() = 0;
124
129 virtual const zchar_t* GetSenderName() = 0;
130
136
141 virtual bool IsChannelInvitation() = 0;
142
147 virtual const zchar_t* GetChannelName() = 0;
148
154
159 virtual SDKError SetScreenName(const zchar_t* screenName) = 0;
160
164 virtual SDKError Accept() = 0;
165
169 virtual SDKError Decline() = 0;
170
174 virtual SDKError TimeOut() = 0;
175
176};
177
183{
184public:
186
191 virtual void onRequestStarContact(IList<const zchar_t*>* pContactList) = 0;
192
197 virtual void onRequestContactDetailInfo(IList<IContactInfo*>* pContactList) = 0;
198
204 virtual void onContactPresenceChanged(const zchar_t* contactId, SDKPresenceStatus status) = 0;
205
211 virtual void onStarContactListChanged(IList<const zchar_t*>* pContactList,bool bAdd) = 0;
212
218
223 virtual void onMeetingInvitationCanceled(UINT64 meetingNumber) = 0;
224
229 virtual void onMeetingAcceptedByOtherDevice(UINT64 meetingNumber) = 0;
230
235 virtual void onMeetingDeclinedByOtherDevice(UINT64 meetingNumber) = 0;
236
241 virtual void onMeetingInvitationDeclined(const zchar_t* contactId) = 0;
242};
243
245{
246public:
253
261 virtual bool AddContactToList(const zchar_t* contactId) = 0;
262
269
276
283
290};
291
297{
298public:
305
311
317 virtual SDKError AddStarContact(const zchar_t* contactId) = 0;
318
324 virtual SDKError UnStarContact(const zchar_t* contactId) = 0;
325
331 virtual SDKError InviteContact(const zchar_t* contactId) = 0;
332
338
339};
341#endif
virtual SDKError CommitSubscribeContactPresence()=0
Batch subscribe contact presence status according to the prepare list.
virtual SDKError CommitInviteContact()=0
Batch invite contact to join meeting according to the prepare list.
virtual SDKError CreateBatchRequestBegin()=0
Prepare to batch request for contact helper.
virtual SDKError CommitUnSubscribeContactPresence()=0
Batch unsubscribe contact presence status according to the prepare list.
virtual SDKError CommitContactDetailInfoRequest()=0
Batch request contact detail information according to the prepare list.
virtual bool AddContactToList(const zchar_t *contactId)=0
Add the contact ID to a prepared list.
Contact information interface.
virtual const zchar_t * GetEmail()=0
Gets the contact's email.
virtual const zchar_t * GetProfilePicture()=0
Gets the contact's profile picture.
virtual const zchar_t * GetPersonalNote()=0
Gets the contact's personal note.
virtual SDKPresenceStatus GetPresenceStatus()=0
Gets the contact's presence status.
virtual const zchar_t * GetJobTitle()=0
Gets the contact's job title.
virtual const zchar_t * GetPhoneNumber()=0
Gets the contact's phone number.
virtual const zchar_t * GetDepartment()=0
Gets the contact's department.
virtual const zchar_t * GetContactId()=0
Gets the contact's ID.
virtual const zchar_t * GetCompanyName()=0
Gets the contact's company name.
virtual const zchar_t * GetContactName()=0
Gets the contact's name.
Process after the user receives the invitation from other user to join meeting.
virtual UINT64 GetMeetingNumber()=0
Gets the meeting invite number.
virtual SDKError Decline()=0
Instance to decline the invitation, decline and finally self-destroy.
virtual UINT64 GetChannelMemberCount()=0
Gets the channel member count.
virtual SDKError TimeOut()=0
Instance timeout, and finally self-destruct.
virtual SDKError SetScreenName(const zchar_t *screenName)=0
Sets the display name in meeting.
virtual const zchar_t * GetChannelName()=0
Gets the channel name.
virtual bool IsChannelInvitation()=0
Determines whether this invitation is from a channel.
virtual const zchar_t * GetSenderId()=0
Gets the inviter's ID.
virtual SDKError Accept()=0
Instance to accept the invitation, join the meeting and finally self-destroy.
virtual const zchar_t * GetSenderName()=0
Gets the inviter's name.
Presence helper callback event.
virtual void onMeetingDeclinedByOtherDevice(UINT64 meetingNumber)=0
Callback to decline a meeting invitation on another device.
virtual void onStarContactListChanged(IList< const zchar_t * > *pContactList, bool bAdd)=0
Star contact list changed callback.
virtual void onRequestContactDetailInfo(IList< IContactInfo * > *pContactList)=0
Request contact detail information list callback.
virtual void onMeetingAcceptedByOtherDevice(UINT64 meetingNumber)=0
Callback to accept a meeting invitation on another device.
virtual void onContactPresenceChanged(const zchar_t *contactId, SDKPresenceStatus status)=0
Contact presence changed callback.
virtual void onRequestStarContact(IList< const zchar_t * > *pContactList)=0
Request star contact ID list callback.
virtual void onMeetingInvitationCanceled(UINT64 meetingNumber)=0
Callback for the meeting invitation canceled by the inviter.
virtual void onReceiveInvitationToMeeting(IInvitationMeetingHandler *handler)=0
Receive meeting invitation callback.
virtual void onMeetingInvitationDeclined(const zchar_t *contactId)=0
Callback to decline a meeting invitation.
Presence Helper Interface.
virtual SDKError UnStarContact(const zchar_t *contactId)=0
Sends a request to remove the contact ID from starred contact list.
virtual SDKError InviteContact(const zchar_t *contactId)=0
Sends an invitation to a contact to join a meeting.
virtual SDKError AddStarContact(const zchar_t *contactId)=0
Sends a request to add the contact ID to the starred contact list.
virtual IBatchRequestContactHelper * GetBatchRequestContactHelper()=0
Gets the Batch request contact controller.
virtual SDKError SetEvent(IPresenceHelperEvent *pEvent)=0
Sets the presence helper callback event handler.
virtual SDKError RequestStarContact()=0
Sends a request to get the starred contact ids.
SDKPresenceStatus
Enumeration of user's presence status. For more information, please visit https://support....
@ SDKPresenceStatus_PhoneCall
@ SDKPresenceStatus_Calendar
@ SDKPresenceStatus_InMeeting
@ SDKPresenceStatus_Available
@ SDKPresenceStatus_Away
@ SDKPresenceStatus_Presenting
@ SDKPresenceStatus_Busy
@ SDKPresenceStatus_UnAvailable
@ SDKPresenceStatus_DoNotDisturb
@ SDKPresenceStatus_None
@ SDKPresenceStatus_OutOfOffice
ZOOM windows SDK Common Definition File.
#define END_ZOOM_SDK_NAMESPACE
uint64_t UINT64
#define BEGIN_ZOOM_SDK_NAMESPACE
char zchar_t
SDKError
Enumeration of common errors of SDK.