Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCAuthService.h
Go to the documentation of this file.
1//
2// MobileRTCAuthService.h
3// MobileRTC
4//
5// Created by Zoom Communications on 8/8/14.
6// Copyright (c) Zoom Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import <MobileRTC/MobileRTCConstants.h>
11#import <MobileRTC/MobileRTCNotificationServiceHelper.h>
12
13
14@protocol MobileRTCAuthDelegate;
17
23@interface MobileRTCAuthService : NSObject
27@property (weak, nonatomic) id<MobileRTCAuthDelegate> _Nullable delegate;
28
33@property (nullable, retain, nonatomic) NSString *jwtToken;
34
40- (void)sdkAuth;
41
47- (BOOL)isLoggedIn;
48
55
56// @cond PRIVATE
57
63- (nullable NSString *)generateSSOLoginWebURL:(nonnull NSString*)vanityUrl;
64
70- (MobileRTCLoginFailReason)ssoLoginWithWebUriProtocol:(nonnull NSString*)uriProtocol;
71
72// @endcond
73
79- (BOOL)logoutRTC;
80
87
92- (void)enableAutoRegisterNotificationServiceForLogin:(BOOL)enable;
93
99- (MobileRTCSDKError)registerNotificationService:(nullable NSString*)accessToken;
100
106
112
113@end
114
119@protocol MobileRTCAuthDelegate <NSObject>
120@required
125- (void)onMobileRTCAuthReturn:(MobileRTCAuthError)returnValue;
126
127@optional
131- (void)onMobileRTCAuthExpired;
132
138- (void)onMobileRTCLoginResult:(MobileRTCLoginFailReason)resultValue;
139
144- (void)onMobileRTCLogoutReturn:(NSInteger)returnValue;
145
151- (void)onNotificationServiceStatus:(MobileRTCNotificationServiceStatus)status error:(MobileRTCNotificationServiceError)error;
152
153@end
154
159@interface MobileRTCAccountInfo : NSObject
164- (nullable NSString*)getEmailAddress;
165
170- (nullable NSString*)getUserName;
171
176- (nullable NSString *)getPMIVanityURL;
177
182- (BOOL)isTelephoneOnlySupported;
183
188- (BOOL)isTelephoneAndVoipSupported;
189
194- (BOOL)is3rdPartyAudioSupported;
195
200- (nullable NSString *)get3rdPartyAudioInfo;
201
206- (MobileRTCMeetingItemAudioType)getDefaultAudioInfo;
207
212- (BOOL)onlyAllowSignedInUserJoinMeeting;
213
218- (nullable NSArray <MobileRTCAlternativeHost *> *)getCanScheduleForUsersList;
219
224- (BOOL)isLocalRecordingSupported;
225
230- (BOOL)isCloudRecordingSupported;
231
236- (MobileRTCMeetingItemRecordType)getDefaultAutoRecordType;
237
242- (BOOL)isSpecifiedDomainCanJoinFeatureOn;
243
248- (nullable NSArray <NSString *> *)getDefaultCanJoinUserSpecifiedDomains;
249
250@end
251
256@interface MobileRTCAlternativeHost : NSObject
257@property (nonatomic, retain, readonly) NSString * _Nullable email;
258@property (nonatomic, retain, readonly) NSString * _Nullable firstName;
259@property (nonatomic, retain, readonly) NSString * _Nullable lastName;
260@property (nonatomic, assign, readonly) unsigned long long PMINumber;
261
262- (id _Nonnull)initWithEmailAddress:(NSString * _Nonnull)emailAddress firstname:(NSString * _Nonnull)firstName lastName:(NSString * _Nonnull)lastName PMI:(unsigned long long)PMINumber;
263@end
MobileRTCUserType
Enumerates the types of users.
MobileRTCMeetingItemRecordType
Enumeration of meeting recording types in meeting.
MobileRTCNotificationServiceStatus
Enumeration of the type for alive connect service status.
MobileRTCNotificationServiceError
Enumeration of notification service error codes.
MobileRTCSDKError
Enumeration of 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()
Get user type.
nullable MobileRTCAccountInfo * getAccountInfo()
Specify to get the profile information of logged-in user.
MobileRTCNotificationServiceHelper *_Nullable getNotificationServiceHelper()
Get notification service controller interface.
MobileRTCSDKError unregisterNotificationService()
Unregister notification service.
BOOL logoutRTC()
Specify to logout MobileRTC.
BOOL isLoggedIn()
Check whether mobileRTC is logged-in or not.
NSString * jwtToken
Jwt auth token.
Helper for managing meeting transfer and presence features.