Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCPresenceHelper.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7#import <MobileRTC/MobileRTCConstants.h>
8
13@interface MobileRTCContactInfo : NSObject
14
18@property (copy, nonatomic, readonly) NSString * _Nullable contactID;
19
23@property (copy, nonatomic, readonly) NSString * _Nullable contactName;
24
28@property (assign, nonatomic, readonly) MobileRTCPresenceStatus presenceStatus;
29
33@property (copy, nonatomic, readonly) NSString * _Nullable profilepicture;
34
38@property (copy, nonatomic, readonly) NSString * _Nullable personalNote;
39
43@property (copy, nonatomic, readonly) NSString * _Nullable companyName;
44
48@property (copy, nonatomic, readonly) NSString * _Nullable department;
49
53@property (copy, nonatomic, readonly) NSString * _Nullable jobTitle;
54
58@property (copy, nonatomic, readonly) NSString * _Nullable phoneNumber;
59
63@property (copy, nonatomic, readonly) NSString * _Nullable email;
64
65@end
66
72
76@property (copy, nonatomic, readonly) NSString * _Nullable senderId;
77
81@property (copy, nonatomic, readonly) NSString * _Nullable senderName;
82
86@property (assign, nonatomic, readonly) long long meetingNumber;
87
91@property (assign, nonatomic, readonly) BOOL isChannelInvitation;
92
96@property (copy, nonatomic, readonly) NSString *_Nullable channelName;
97
101@property (assign, nonatomic, readonly) unsigned int channelMemberCount;
102
107- (void)setScreenName:(NSString * _Nullable)screenName;
108
113- (MobileRTCSDKError)accept;
114
119- (MobileRTCSDKError)decline;
120
125- (MobileRTCSDKError)timeout;
126
127@end
128
133@protocol MobileRTCPresenceHelperDelegate <NSObject>
134
139- (void)onRequestStarContact:(NSArray <NSString *> *_Nullable)contactIDList;
140
145- (void)onRequestContactDetailInfo:(NSArray <MobileRTCContactInfo *> *_Nullable)contactList;
146
152- (void)onUserPresenceChanged:(NSString *_Nullable)contactID presenceStatus:(MobileRTCPresenceStatus)status;
153
159- (void)onStarContactListChanged:(NSArray <NSString *> *_Nullable)contactIDList isAdd:(BOOL)add;
160
165- (void)onReceiveInvitationToMeeting:(MobileRTCInvitationMeetingHandler *_Nullable)handler;
166
171- (void)onMeetingInvitationCanceled:(long long)meetingNumber;
172
177- (void)onMeetingAcceptedByOtherDevice:(long long)meetingNumber;
178
183- (void)onMeetingInvitationDeclined:(NSString *_Nullable)contactID;
184
189- (void)onMeetingDeclinedByOtherDevice:(long long)meetingNumber;
190
191
192@end
193
198@interface MobileRTCPresenceHelper : NSObject
199
203@property(nonatomic, assign, nullable)id<MobileRTCPresenceHelperDelegate> delegate;
204
209- (MobileRTCSDKError)requestStarContact;
210
216- (MobileRTCSDKError)starContact:(NSString *_Nonnull)contactID;
217
223- (MobileRTCSDKError)unStarContact:(NSString *_Nonnull)contactID;
224
230- (MobileRTCSDKError)inviteContact:(NSString *_Nonnull)contactID;
231
237- (MobileRTCSDKError)inviteContactList:(NSArray <NSString *> *_Nonnull)contactIDList;
238
244- (MobileRTCSDKError)requestContactDetailInfo:(NSArray <NSString *> *_Nonnull)contactIDList;
245
251- (MobileRTCSDKError)subscribeContactPresence:(NSArray <NSString *> *_Nonnull)contactIDList;
252
258- (MobileRTCSDKError)unSubscribeContactPresence:(NSArray <NSString *> *_Nonnull)contactIDList;
259
260@end
261
262
263
MobileRTCSDKError
Enumeration of the SDK error.
MobileRTCPresenceStatus
Enumeration of the user's presence status. For more information, please visit https://support....
A class that contains presence information.
NSString *_Nullable companyName
The contact's company name, such as "Acme Incorporated".
NSString *_Nullable jobTitle
The contact's job title, such as "Support engineer".
NSString *_Nullable department
The contact's department, such as "Human resources".
NSString *_Nullable email
The contact's email, such as "jillchill@example.com".
NSString *_Nullable phoneNumber
The contact's phone number, such as "+1 000 000-0000".
NSString *_Nullable contactName
The contact's name.
NSString *_Nullable personalNote
The contact's personal note.
NSString *_Nullable contactID
The contact's ID.
NSString *_Nullable profilepicture
The contact's profile picture.
MobileRTCPresenceStatus presenceStatus
The contact's presence status, such as MobileRTCPresenceStatus_Available.
A handler that processes after the user receives an invitation from another user to join a meeting.
A class to manage contact presence and meeting invitations.