Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKPresenceHelper.h
Go to the documentation of this file.
1//
2
3#import <Foundation/Foundation.h>
4#import <ZoomSDK/ZoomSDKErrors.h>
5
6NS_ASSUME_NONNULL_BEGIN
7
8@interface ZoomSDKContactInfo : NSObject
12@property (copy, nonatomic,readonly, nullable) NSString *contactID;
13
17@property (copy, nonatomic,readonly, nullable) NSString *contactName;
18
22@property (assign, nonatomic,readonly) ZoomSDKPresenceStatus presenceStatus;
23
27@property (copy, nonatomic,readonly, nullable) NSString *profilePicture;
28
32@property (copy, nonatomic,readonly, nullable) NSString *personalNote;
33
37@property (copy, nonatomic,readonly, nullable) NSString *companyName;
38
42@property (copy, nonatomic,readonly, nullable) NSString *department;
43
47@property (copy, nonatomic,readonly, nullable) NSString *jobTitle;
48
52@property (copy, nonatomic,readonly, nullable) NSString *phoneNumber;
53
57@property (copy, nonatomic,readonly, nullable) NSString *email;
58@end
59
61
65@property (copy, nonatomic, readonly, nullable) NSString *senderName;
66
70@property (assign, nonatomic,readonly) long long meetingNumber;
71
75@property (assign, nonatomic,readonly) BOOL isChannelInvitation;
76
80@property (copy, nonatomic, readonly, nullable) NSString *channelName;
81
85@property (assign, nonatomic,readonly) unsigned int channelMemberCount;
86
91- (ZoomSDKError)setScreenName:(NSString *)screenName;
96- (ZoomSDKError)accept;
97
102- (ZoomSDKError)decline;
103
108- (ZoomSDKError)timeout;
109@end
110
111@protocol ZoomSDKPresenceHelperDelegate <NSObject>
112
117- (void)onRequestStarContact:(NSArray <NSString *> *)contactIDList;
118
123- (void)onRequestContactDetailInfo:(NSArray <ZoomSDKContactInfo *> *)contactList;
124
130- (void)onContactPresenceChanged:(NSString *)contactID presenceStatus:(ZoomSDKPresenceStatus)status;
131
137- (void)onStarContactListChanged:(NSArray <NSString *> *)contactIDList isAdd:(BOOL)add;
138
143- (void)onReceiveInvitationToMeeting:(ZoomSDKInvitationMeetingHandler *)handler;
144
149- (void)onMeetingInvitationCanceled:(long long)meetingNumber;
150
155- (void)onMeetingAcceptedByOtherDevice:(long long)meetingNumber;
156
161- (void)onMeetingDeclinedByOtherDevice:(long long)meetingNumber;
162
167- (void)onMeetingInvitationDeclined:(NSString *)contactID;
168@end
169
170@interface ZoomSDKPresenceHelper : NSObject
171
172@property(nonatomic, assign, nullable)id<ZoomSDKPresenceHelperDelegate> delegate;
173
178- (ZoomSDKError)requestStarContact;
179
185- (ZoomSDKError)addStarContact:(NSString *)contactID;
186
192- (ZoomSDKError)unStarContact:(NSString *)contactID;
193
199- (ZoomSDKError)inviteContact:(NSString *)contactID;
200
206- (ZoomSDKError)inviteContactList:(NSArray <NSString *> *)contactIDList;
207
213- (ZoomSDKError)requestContactDetailInfo:(NSArray <NSString *> *)contactIDList;
214
220- (ZoomSDKError)subscribeContactPresence:(NSArray <NSString *> *)contactIDList;
221
227- (ZoomSDKError)unSubscribeContactPresence:(NSArray <NSString *> *)contactIDList;
228@end
229
230NS_ASSUME_NONNULL_END
ZoomSDKPresenceStatus
Enumeration of user's presence status. For more information, please visit https://support....
ZoomSDKError
Enumeration of common errors of SDK.
NSString * profilePicture
Get the contact’s profile picture.
NSString * personalNote
Get the contact’s personal note.
NSString * phoneNumber
Get the contact’s phone number. such as "+1 000 000-0000".
NSString * jobTitle
Get the contact’s job title. such as "Support engineer".
NSString * contactName
Get the contact’s name.
NSString * companyName
Get the contact’s company name. such as "Acme Incorporated".
NSString * contactID
Get the contact’s ID.
NSString * email
Get the contact’s email. such as "jillchill@example.com".
ZoomSDKPresenceStatus presenceStatus
Get the contact’s presence status. such as ZoomSDKPresenceStatus_Available.
NSString * department
Get the contact’s department. such as "Human resources".