Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCAuthService.h
Go to the documentation of this file.
1
6#import <Foundation/Foundation.h>
7#import <MobileRTC/MobileRTCConstants.h>
8#import <MobileRTC/MobileRTCNotificationServiceHelper.h>
9
10
11@protocol MobileRTCAuthDelegate;
14
20@interface MobileRTCAuthService : NSObject
24@property (weak, nonatomic) id<MobileRTCAuthDelegate> _Nullable delegate;
25
30@property (nullable, retain, nonatomic) NSString *jwtToken;
31
37- (void)sdkAuth;
38
44- (BOOL)isLoggedIn;
45
52
53// @cond PRIVATE
54
60- (nullable NSString *)generateSSOLoginWebURL:(nonnull NSString*)vanityUrl;
61
67- (MobileRTCLoginFailReason)ssoLoginWithWebUriProtocol:(nonnull NSString*)uriProtocol;
68
69// @endcond
70
76- (BOOL)logoutRTC;
77
84
89- (void)enableAutoRegisterNotificationServiceForLogin:(BOOL)enable;
90
96- (MobileRTCSDKError)registerNotificationService:(nullable NSString*)accessToken;
97
103
109
110@end
111
116@protocol MobileRTCAuthDelegate <NSObject>
117@required
122- (void)onMobileRTCAuthReturn:(MobileRTCAuthError)returnValue;
123
124@optional
128- (void)onMobileRTCAuthExpired;
129
135- (void)onMobileRTCLoginResult:(MobileRTCLoginFailReason)resultValue;
136
141- (void)onMobileRTCLogoutReturn:(NSInteger)returnValue;
142
148- (void)onNotificationServiceStatus:(MobileRTCNotificationServiceStatus)status error:(MobileRTCNotificationServiceError)error;
149
150@end
151
156@interface MobileRTCAccountInfo : NSObject
161- (nullable NSString*)getEmailAddress;
162
167- (nullable NSString*)getUserName;
168
173- (nullable NSString *)getPMIVanityURL;
174
179- (BOOL)isTelephoneOnlySupported;
180
185- (BOOL)isTelephoneAndVoipSupported;
186
191- (BOOL)is3rdPartyAudioSupported;
192
197- (nullable NSString *)get3rdPartyAudioInfo;
198
203- (MobileRTCMeetingItemAudioType)getDefaultAudioInfo;
204
209- (BOOL)onlyAllowSignedInUserJoinMeeting;
210
215- (nullable NSArray <MobileRTCAlternativeHost *> *)getCanScheduleForUsersList;
216
221- (BOOL)isLocalRecordingSupported;
222
227- (BOOL)isCloudRecordingSupported;
228
233- (MobileRTCMeetingItemRecordType)getDefaultAutoRecordType;
234
239- (BOOL)isSpecifiedDomainCanJoinFeatureOn;
240
245- (nullable NSArray <NSString *> *)getDefaultCanJoinUserSpecifiedDomains;
246
247@end
248
253@interface MobileRTCAlternativeHost : NSObject
254@property (nonatomic, retain, readonly) NSString * _Nullable email;
255@property (nonatomic, retain, readonly) NSString * _Nullable firstName;
256@property (nonatomic, retain, readonly) NSString * _Nullable lastName;
257@property (nonatomic, assign, readonly) unsigned long long PMINumber;
258
259- (id _Nonnull)initWithEmailAddress:(NSString * _Nonnull)emailAddress firstname:(NSString * _Nonnull)firstName lastName:(NSString * _Nonnull)lastName PMI:(unsigned long long)PMINumber;
260@end
MobileRTCUserType
Enumeration of user types.
MobileRTCMeetingItemRecordType
Enumeration of the meeting recording types in meeting.
MobileRTCNotificationServiceStatus
Enumeration of the type for alive connect service status.
MobileRTCNotificationServiceError
Enumeration of the notification service error codes.
MobileRTCSDKError
Enumeration of the SDK error.
MobileRTCMeetingItemAudioType
Enumeration of audio types in meeting.
MobileRTCLoginFailReason
Enumeration of the login failure reasons.
MobileRTCAuthError
Enumeration of SDK authentication results.
It is used to store the profile information of logged-in user.
It is used to store the information of the alternative host.
The method provides support for authorizing MobileRTC.
id< MobileRTCAuthDelegate > _Nullable delegate
The property to receive authentication/login events.
void sdkAuth()
Authenticate SDK.
MobileRTCUserType getUserType()
Gets the user type.
nullable MobileRTCAccountInfo * getAccountInfo()
Gets the profile information of the logged-in user.
MobileRTCNotificationServiceHelper *_Nullable getNotificationServiceHelper()
Gets the notification service controller interface.
MobileRTCSDKError unregisterNotificationService()
Unregisters the notification service.
BOOL logoutRTC()
Logs out MobileRTC.
BOOL isLoggedIn()
Queries whether mobileRTC is logged-in or not.
NSString * jwtToken
Jwt auth token.
Helper for managing meeting transfer and presence features.