iOS SDK 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 Video Communications on 8/8/14.
6// Copyright (c) 2019 Zoom Video Communications, Inc. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
12
13@protocol MobileRTCAuthDelegate;
16
21@interface MobileRTCAuthService : NSObject
22
26@property (nullable, assign, nonatomic) id<MobileRTCAuthDelegate> delegate;
27
32@property (nullable, retain, nonatomic) NSString *clientKey;
33
38@property (nullable, retain, nonatomic) NSString *clientSecret;
39
44@property (nullable, retain, nonatomic) NSString *jwtToken;
45
51- (void)sdkAuth;
52
58- (BOOL)isLoggedIn;
59
66
67// @cond PRIVATE
68
74- (nullable NSString *)generateSSOLoginWebURL:(nonnull NSString*)vanityUrl;
75
81- (MobileRTCLoginFailReason)ssoLoginWithWebUriProtocol:(nonnull NSString*)uriProtocol;
82
83// @endcond
84
90- (BOOL)logoutRTC;
91
98
103- (void)enableAutoRegisterNotificationServiceForLogin:(BOOL)enable;
104
110- (MobileRTCSDKError)registerNotificationService:(nullable NSString*)accessToken;
111
117
123
124@end
125
129@protocol MobileRTCAuthDelegate <NSObject>
130
131@required
136- (void)onMobileRTCAuthReturn:(MobileRTCAuthError)returnValue;
137
138@optional
142- (void)onMobileRTCAuthExpired;
143
149- (void)onMobileRTCLoginResult:(MobileRTCLoginFailReason)resultValue;
150
155- (void)onMobileRTCLogoutReturn:(NSInteger)returnValue;
156
161- (void)onNotificationServiceStatus:(MobileRTCNotificationServiceStatus)status;
162
163@end
164
168@interface MobileRTCAccountInfo : NSObject
169
174- (nullable NSString*)getEmailAddress;
175
180- (nullable NSString*)getUserName;
181
186- (nullable NSString *)getPMIVanityURL;
187
192- (BOOL)isTelephoneOnlySupported;
193
198- (BOOL)isTelephoneAndVoipSupported;
199
204- (BOOL)is3rdPartyAudioSupported;
205
210- (nullable NSString *)get3rdPartyAudioInfo;
211
216- (MobileRTCMeetingItemAudioType)getDefaultAudioInfo;
217
222- (BOOL)onlyAllowSignedInUserJoinMeeting;
223
228- (nullable NSArray <MobileRTCAlternativeHost *> *)getCanScheduleForUsersList;
229
234- (BOOL)isLocalRecordingSupported;
235
240- (BOOL)isCloudRecordingSupported;
241
246- (MobileRTCMeetingItemRecordType)getDefaultAutoRecordType;
247
252- (BOOL)isSpecifiedDomainCanJoinFeatureOn;
253
258- (nullable NSArray <NSString *> *)getDefaultCanJoinUserSpecifiedDomains;
259
260@end
261
265@interface MobileRTCAlternativeHost : NSObject
266
267@property (nonatomic, retain, readonly) NSString * _Nullable email;
268@property (nonatomic, retain, readonly) NSString * _Nullable firstName;
269@property (nonatomic, retain, readonly) NSString * _Nullable lastName;
270@property (nonatomic, assign, readonly) unsigned long long PMINumber;
271
272- (id _Nonnull)initWithEmailAddress:(NSString * _Nonnull)emailAddress firstname:(NSString * _Nonnull)firstName lastName:(NSString * _Nonnull)lastName PMI:(unsigned long long)PMINumber;
273@end
MobileRTCUserType
MobileRTCUserType An enumeration of user types.
MobileRTCMeetingItemRecordType
MobileRTCMeetingItemRecordType An enumeration of meeting recording types in meeting.
MobileRTCNotificationServiceStatus
Enumerations of the type for alive connect service status.
MobileRTCSDKError
An enumeration of SDK error.
MobileRTCMeetingItemAudioType
MobileRTCMeetingItemAudioType An enumeration of audio types in meeting.
MobileRTCLoginFailReason
An enumeration of SDK login.
MobileRTCAuthError
An enumeration of SDK authentication.
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.
NSString * clientKey
APP Key got from zoom.us.
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.
id< MobileRTCAuthDelegate > delegate
The property to receive authentication/login events.
NSString * jwtToken
jwt auth token.
NSString * clientSecret
APP secret got from zoom.us.