Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCAuthService.h
Go to the documentation of this file.
1
5
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
35@property (nullable, retain, nonatomic) NSString *publicAppKey;
36
42- (void)sdkAuth;
43
49- (BOOL)isLoggedIn;
50
57
58// @cond PRIVATE
59
65- (nullable NSString *)generateSSOLoginWebURL:(nonnull NSString*)vanityUrl;
66
72- (MobileRTCLoginFailReason)ssoLoginWithWebUriProtocol:(nonnull NSString*)uriProtocol;
73
74// @endcond
75
81- (BOOL)logoutRTC;
82
89
94- (void)enableAutoRegisterNotificationServiceForLogin:(BOOL)enable;
95
101- (MobileRTCSDKError)registerNotificationService:(nullable NSString*)accessToken;
102
108
114
115@end
116
121@protocol MobileRTCAuthDelegate <NSObject>
122@required
127- (void)onMobileRTCAuthReturn:(MobileRTCAuthError)returnValue;
128
129@optional
134
140- (void)onMobileRTCLoginResult:(MobileRTCLoginFailReason)resultValue;
141
146- (void)onMobileRTCLogoutReturn:(NSInteger)returnValue;
147
153- (void)onNotificationServiceStatus:(MobileRTCNotificationServiceStatus)status error:(MobileRTCNotificationServiceError)error;
154
155@end
156
161@interface MobileRTCAccountInfo : NSObject
166- (nullable NSString*)getEmailAddress;
167
172- (nullable NSString*)getUserName;
173
178- (nullable NSString *)getPMIVanityURL;
179
185
191
197
202- (nullable NSString *)get3rdPartyAudioInfo;
203
209
215
221
227
233
239
245
250- (nullable NSArray <NSString *> *)getDefaultCanJoinUserSpecifiedDomains;
251
252@end
253
258@interface MobileRTCAlternativeHost : NSObject
259@property (nonatomic, retain, readonly) NSString * _Nullable email;
260@property (nonatomic, retain, readonly) NSString * _Nullable firstName;
261@property (nonatomic, retain, readonly) NSString * _Nullable lastName;
262@property (nonatomic, assign, readonly) unsigned long long PMINumber;
263
264- (id _Nonnull)initWithEmailAddress:(NSString * _Nonnull)emailAddress firstname:(NSString * _Nonnull)firstName lastName:(NSString * _Nonnull)lastName PMI:(unsigned long long)PMINumber;
265@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.
BOOL isTelephoneAndVoipSupported()
Determines if Audio Type (Telephone And VoIP) is supported while scheduling a meeting.
nullable NSString * getEmailAddress()
Gets the working email address.
BOOL onlyAllowSignedInUserJoinMeeting()
Determines if only signed-in users can join the meeting while scheduling a meeting.
nullable NSArray< NSString * > * getDefaultCanJoinUserSpecifiedDomains()
Gets the specified domain from user profile.
MobileRTCMeetingItemRecordType getDefaultAutoRecordType()
Gets the default Meeting Auto Recording Types from user profile.
BOOL isCloudRecordingSupported()
Determines if cloud recording is supported while scheduling a meeting.
BOOL isSpecifiedDomainCanJoinFeatureOn()
Determines if only users in specified domain can join the meeting while scheduling a meeting.
nullable NSString * get3rdPartyAudioInfo()
Gets the 3rd Party Audio Info from user profile.
nullable NSString * getUserName()
Gets the username of a logged in account. [Login User Only].
BOOL is3rdPartyAudioSupported()
Determines if Audio Type (3rdParty Audio) is supported while scheduling a meeting.
BOOL isLocalRecordingSupported()
Determines if local recording is supported while scheduling a meeting.
nullable NSString * getPMIVanityURL()
Gets the PMI Vanity URL from user profile information.
MobileRTCMeetingItemAudioType getDefaultAudioInfo()
Gets the default Audio Type from user profile.
BOOL isTelephoneOnlySupported()
Determines if Audio Type (Telephone Only) is supported while scheduling a meeting.
nullable NSArray< MobileRTCAlternativeHost * > * getCanScheduleForUsersList()
Gets the alternative host list from user profile information.
It is used to store the information of the alternative host.
The method provides support for authorizing MobileRTC.
NSString * publicAppKey
Public app key used for SDK authentication. Alternative to JWT token.
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.
void onMobileRTCAuthExpired()
Callback event when the token expires.