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:
52 virtual const zchar_t* GetContactId() = 0;
53
58 virtual const zchar_t* GetContactName() = 0;
59
65
70 virtual const zchar_t* GetProfilePicture() = 0;
71
76 virtual const zchar_t* GetPersonalNote() = 0;
77
82 virtual const zchar_t* GetCompanyName() = 0;
83
88 virtual const zchar_t* GetDepartment() = 0;
89
94 virtual const zchar_t* GetJobTitle() = 0;
95
100 virtual const zchar_t* GetPhoneNumber() = 0;
101
106 virtual const zchar_t* GetEmail() = 0;
107
108 virtual ~IContactInfo(){};
109};
110
116{
117public:
119
124 virtual const zchar_t* GetSenderId() = 0;
125
130 virtual const zchar_t* GetSenderName() = 0;
131
136 virtual UINT64 GetMeetingNumber() = 0;
137
142 virtual bool IsChannelInvitation() = 0;
143
148 virtual const zchar_t* GetChannelName() = 0;
149
154 virtual UINT64 GetChannelMemberCount() = 0;
155
160 virtual SDKError SetScreenName(const zchar_t* screenName) = 0;
161
165 virtual SDKError Accept() = 0;
166
170 virtual SDKError Decline() = 0;
171
175 virtual SDKError TimeOut() = 0;
176
177};
178
184{
185public:
187
192 virtual void onRequestStarContact(IList<const zchar_t*>* pContactList) = 0;
193
198 virtual void onRequestContactDetailInfo(IList<IContactInfo*>* pContactList) = 0;
199
205 virtual void onContactPresenceChanged(const zchar_t* contactId, SDKPresenceStatus status) = 0;
206
212 virtual void onStarContactListChanged(IList<const zchar_t*>* pContactList,bool bAdd) = 0;
213
219
224 virtual void onMeetingInvitationCanceled(UINT64 meetingNumber) = 0;
225
230 virtual void onMeetingAcceptedByOtherDevice(UINT64 meetingNumber) = 0;
231
236 virtual void onMeetingDeclinedByOtherDevice(UINT64 meetingNumber) = 0;
237
242 virtual void onMeetingInvitationDeclined(const zchar_t* contactId) = 0;
243};
244
246{
247public:
254
262 virtual bool AddContactToList(const zchar_t* contactId) = 0;
263
270
277
284
291};
292
298{
299public:
306
312
318 virtual SDKError AddStarContact(const zchar_t* contactId) = 0;
319
325 virtual SDKError UnStarContact(const zchar_t* contactId) = 0;
326
332 virtual SDKError InviteContact(const zchar_t* contactId) = 0;
333
339
340};
342#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
Get the contact's email.
virtual const zchar_t * GetProfilePicture()=0
Get the contact's profile picture.
virtual const zchar_t * GetPersonalNote()=0
Get the contact's personal note.
virtual SDKPresenceStatus GetPresenceStatus()=0
Get the contact's presence status.
virtual const zchar_t * GetJobTitle()=0
Get the contact's job title.
virtual const zchar_t * GetPhoneNumber()=0
Get the contact's phone number.
virtual const zchar_t * GetDepartment()=0
Get the contact's department.
virtual const zchar_t * GetContactId()=0
Get the contact's ID.
virtual const zchar_t * GetCompanyName()=0
Get the contact's company name.
virtual const zchar_t * GetContactName()=0
Get the contact's name.
Process after the user receives the invitation from other user to join meeting.
virtual UINT64 GetMeetingNumber()=0
Get the meeting invite number.
virtual SDKError Decline()=0
Instance to decline the invitation, decline and finally self-destroy.
virtual UINT64 GetChannelMemberCount()=0
Get the channel member count.
virtual SDKError TimeOut()=0
Instance timeout, and finally self-destruct.
virtual SDKError SetScreenName(const zchar_t *screenName)=0
Set the display name in meeting.
virtual const zchar_t * GetChannelName()=0
Get the channel name.
virtual bool IsChannelInvitation()=0
Determine whether this invitation is from a channel.
virtual const zchar_t * GetSenderId()=0
Get 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
Get 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
Send a request to remove the contact ID from starred contact list.
virtual SDKError InviteContact(const zchar_t *contactId)=0
Send an invitation to a contact to join a meeting.
virtual SDKError AddStarContact(const zchar_t *contactId)=0
Send a request to add the contact ID to the starred contact list.
virtual IBatchRequestContactHelper * GetBatchRequestContactHelper()=0
Get the Batch request contact controller.
virtual SDKError SetEvent(IPresenceHelperEvent *pEvent)=0
Set the presence helper callback event handler.
virtual SDKError RequestStarContact()=0
Send 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
wchar_t zchar_t
Definition zoom_sdk_def.h:9
#define BEGIN_ZOOM_SDK_NAMESPACE
SDKError
Enumeration of common errors of SDK.