Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCPresenceHelper.h
Go to the documentation of this file.
1//
2// MobileRTCPresenceHelper.h
3// MobileRTC
4//
5// Created by Zoom on 2023/4/3.
6// Copyright © Zoom Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import <MobileRTC/MobileRTCConstants.h>
11
16@interface MobileRTCContactInfo : NSObject
20@property (copy, nonatomic, readonly) NSString * _Nullable contactID;
24@property (copy, nonatomic, readonly) NSString * _Nullable contactName;
28@property (assign, nonatomic, readonly) MobileRTCPresenceStatus presenceStatus;
32@property (copy, nonatomic, readonly) NSString * _Nullable profilepicture;
36@property (copy, nonatomic, readonly) NSString * _Nullable personalNote;
40@property (copy, nonatomic, readonly) NSString * _Nullable companyName;
44@property (copy, nonatomic, readonly) NSString * _Nullable department;
48@property (copy, nonatomic, readonly) NSString * _Nullable jobTitle;
52@property (copy, nonatomic, readonly) NSString * _Nullable phoneNumber;
56@property (copy, nonatomic, readonly) NSString * _Nullable email;
57
58@end
59
65
69@property (copy, nonatomic, readonly) NSString * _Nullable senderId;
70
74@property (copy, nonatomic, readonly) NSString * _Nullable senderName;
75
79@property (assign, nonatomic, readonly) long long meetingNumber;
80
84@property (assign, nonatomic, readonly) BOOL isChannelInvitation;
85
89@property (copy, nonatomic, readonly) NSString *_Nullable channelName;
90
94@property (assign, nonatomic, readonly) unsigned int channelMemberCount;
95
99- (void)setScreenName:(NSString * _Nullable)screenName;
103- (MobileRTCSDKError)accept;
107- (MobileRTCSDKError)decline;
111- (MobileRTCSDKError)timeout;
112
113@end
114
119@protocol MobileRTCPresenceHelperDelegate <NSObject>
124- (void)onRequestStarContact:(NSArray <NSString *> *_Nullable)contactIDList;
125
130- (void)onRequestContactDetailInfo:(NSArray <MobileRTCContactInfo *> *_Nullable)contactList;
131
137- (void)onUserPresenceChanged:(NSString *_Nullable)contactID presenceStatus:(MobileRTCPresenceStatus)status;
138
144- (void)onStarContactListChanged:(NSArray <NSString *> *_Nullable)contactIDList isAdd:(BOOL)add;
145
150- (void)onReceiveInvitationToMeeting:(MobileRTCInvitationMeetingHandler *_Nullable)handler;
155- (void)onMeetingInvitationCanceled:(long long)meetingNumber;
156
161- (void)onMeetingAcceptedByOtherDevice:(long long)meetingNumber;
162
167- (void)onMeetingInvitationDeclined:(NSString *_Nullable)contactID;
168
173- (void)onMeetingDeclinedByOtherDevice:(long long)meetingNumber;
174
175
176@end
177
182@interface MobileRTCPresenceHelper : NSObject
183
187@property(nonatomic, assign, nullable)id<MobileRTCPresenceHelperDelegate> delegate;
188
193- (MobileRTCSDKError)requestStarContact;
194
200- (MobileRTCSDKError)starContact:(NSString *_Nonnull)contactID;
201
207- (MobileRTCSDKError)unStarContact:(NSString *_Nonnull)contactID;
208
214- (MobileRTCSDKError)inviteContact:(NSString *_Nonnull)contactID;
215
221- (MobileRTCSDKError)inviteContactList:(NSArray <NSString *> *_Nonnull)contactIDList;
227- (MobileRTCSDKError)requestContactDetailInfo:(NSArray <NSString *> *_Nonnull)contactIDList;
228
234- (MobileRTCSDKError)subscribeContactPresence:(NSArray <NSString *> *_Nonnull)contactIDList;
235
241- (MobileRTCSDKError)unSubscribeContactPresence:(NSArray <NSString *> *_Nonnull)contactIDList;
242
243@end
244
245
246
MobileRTCSDKError
Enumeration of SDK error.
MobileRTCPresenceStatus
Enumeration of user's presence status. For more information, please visit https://support....
Presence information interface.
NSString *_Nullable companyName
Contact’s company name, such as "Acme Incorporated".
NSString *_Nullable jobTitle
Contact’s job title, such as "Support engineer".
NSString *_Nullable department
Contact’s department, such as "Human resources".
NSString *_Nullable email
Contact’s email, such as "jillchill@example.com".
NSString *_Nullable phoneNumber
Contact’s phone number, such as "+1 000 000-0000".
NSString *_Nullable contactName
Contact’s name.
NSString *_Nullable personalNote
Contact’s personal note.
NSString *_Nullable contactID
Contact’s ID.
NSString *_Nullable profilepicture
Contact’s profile picture.
MobileRTCPresenceStatus presenceStatus
Contact’s presence status, such as MobileRTCPresenceStatus_Available.
Process after the user receives an invitation from another user to join a meeting.
Interface to manage contact presence and meeting invitations.