Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKPresenceHelper.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7#import <ZoomSDK/ZoomSDKErrors.h>
8
9NS_ASSUME_NONNULL_BEGIN
14@interface ZoomSDKContactInfo : NSObject
18@property (copy, nonatomic,readonly, nullable) NSString *contactID;
19
23@property (copy, nonatomic,readonly, nullable) NSString *contactName;
24
28@property (assign, nonatomic,readonly) ZoomSDKPresenceStatus presenceStatus;
29
33@property (copy, nonatomic,readonly, nullable) NSString *profilePicture;
34
38@property (copy, nonatomic,readonly, nullable) NSString *personalNote;
39
43@property (copy, nonatomic,readonly, nullable) NSString *companyName;
44
48@property (copy, nonatomic,readonly, nullable) NSString *department;
49
53@property (copy, nonatomic,readonly, nullable) NSString *jobTitle;
54
58@property (copy, nonatomic,readonly, nullable) NSString *phoneNumber;
59
63@property (copy, nonatomic,readonly, nullable) NSString *email;
64@end
65
66
67
73
77@property (copy, nonatomic, readonly, nullable) NSString *senderName;
78
82@property (copy, nonatomic, readonly, nullable) NSString *senderId;
83
87@property (assign, nonatomic,readonly) long long meetingNumber;
88
92@property (assign, nonatomic,readonly) BOOL isChannelInvitation;
93
97@property (copy, nonatomic, readonly, nullable) NSString *channelName;
98
102@property (assign, nonatomic,readonly) unsigned int channelMemberCount;
103
108- (ZoomSDKError)setScreenName:(NSString *)screenName;
113- (ZoomSDKError)accept;
114
119- (ZoomSDKError)decline;
120
125- (ZoomSDKError)timeout;
126@end
127
128
133@protocol ZoomSDKPresenceHelperDelegate <NSObject>
134
139- (void)onRequestStarContact:(NSArray <NSString *> *)contactIDList;
140
145- (void)onRequestContactDetailInfo:(NSArray <ZoomSDKContactInfo *> *)contactList;
146
152- (void)onContactPresenceChanged:(NSString *)contactID presenceStatus:(ZoomSDKPresenceStatus)status;
153
159- (void)onStarContactListChanged:(NSArray <NSString *> *)contactIDList isAdd:(BOOL)add;
160
165- (void)onReceiveInvitationToMeeting:(ZoomSDKInvitationMeetingHandler *)handler;
166
171- (void)onMeetingInvitationCanceled:(long long)meetingNumber;
172
177- (void)onMeetingAcceptedByOtherDevice:(long long)meetingNumber;
178
183- (void)onMeetingDeclinedByOtherDevice:(long long)meetingNumber;
184
189- (void)onMeetingInvitationDeclined:(NSString *)contactID;
190@end
191
192
197@interface ZoomSDKPresenceHelper : NSObject
201@property(nonatomic, assign, nullable)id<ZoomSDKPresenceHelperDelegate> delegate;
202
207- (ZoomSDKError)requestStarContact;
208
214- (ZoomSDKError)addStarContact:(NSString *)contactID;
215
221- (ZoomSDKError)unStarContact:(NSString *)contactID;
222
228- (ZoomSDKError)inviteContact:(NSString *)contactID;
229
235- (ZoomSDKError)inviteContactList:(NSArray <NSString *> *)contactIDList;
236
242- (ZoomSDKError)requestContactDetailInfo:(NSArray <NSString *> *)contactIDList;
243
249- (ZoomSDKError)subscribeContactPresence:(NSArray <NSString *> *)contactIDList;
250
256- (ZoomSDKError)unSubscribeContactPresence:(NSArray <NSString *> *)contactIDList;
257@end
258
259NS_ASSUME_NONNULL_END
ZoomSDKPresenceStatus
Enumeration of user's presence status. For more information, please visit https://support....
ZoomSDKError
Enumeration of common errors of SDK.
Represents contact information of a Zoom user.
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".
Interface for handling received meeting invitations.
Interface to manage contact presence and meeting invitations.