Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKAuthService.h
Go to the documentation of this file.
1
6#import <Cocoa/Cocoa.h>
7#import <ZoomSDK/ZoomSDKErrors.h>
8#import <ZoomSDK/ZoomSDKNotificationServiceController.h>
9
10NS_ASSUME_NONNULL_BEGIN
15@interface ZoomSDKAuthContext : NSObject
16
20@property(nonatomic, copy, nullable) NSString *jwtToken;
21
22@end
23
24
33@property(nonatomic, copy, readonly, nullable) NSString *content;
37@property(nonatomic, copy, readonly, nullable) NSString *accountOwnerLink;
41@property(nonatomic, copy, readonly, nullable) NSString *termLink;
45@property(nonatomic, copy, readonly, nullable) NSString *policyLink;
46
47@end
48
49
54@interface ZoomSDKAccountInfo : NSObject
59- (NSString*_Nullable) getDisplayName;
64- (ZoomSDKUserType) getSDKUserType;
65@end
66
67
68
69@protocol ZoomSDKAuthDelegate;
74@interface ZoomSDKAuthService : NSObject
75{
76 id<ZoomSDKAuthDelegate> _delegate;
77}
81@property (assign, nonatomic, nullable) id<ZoomSDKAuthDelegate> delegate;
82
89- (ZoomSDKError)sdkAuth:(ZoomSDKAuthContext*)jwttoken;
90
95- (BOOL)isAuthorized;
96
97// @cond PRIVATE
98
104- (NSString*_Nullable)generateSSOLoginWebURL:(NSString*)prefixOfVanityUrl;
105
111- (ZoomSDKError)SSOLoginWithWebUriProtocol:(NSString*)uriProtocol;
112
113// @endcond
118- (ZoomSDKError)logout;
119
124- (ZoomSDKAccountInfo *_Nullable)getAccountInfo;
125
130- (NSString*_Nullable)getSDKIdentity;
131
136- (void)enableAutoRegisterNotificationServiceForLogin:(BOOL)enable;
137
143- (ZoomSDKError)registerNotificationService:(NSString*)accessToken;
144
149- (ZoomSDKError)unregisterNotificationService;
150
155- (ZoomSDKNotificationServiceController *)getNotificationServiceController;
156@end
157
158
163@protocol ZoomSDKAuthDelegate <NSObject>
164
165@required
171- (void)onZoomSDKAuthReturn:(ZoomSDKAuthError)returnValue;
172
176 - (void)onZoomAuthIdentityExpired;
177
178@optional
184- (void)onZoomSDKLoginResult:(ZoomSDKLoginStatus)loginStatus failReason:(ZoomSDKLoginFailReason)reason;
188- (void)onZoomSDKLogout;
189
194- (void)onZoomIdentityExpired;
195
201- (void)onNotificationServiceStatus:(ZoomSDKNotificationServiceStatus)status error:(ZoomSDKNotificationServiceError)error;
202@end
203NS_ASSUME_NONNULL_END
ZoomSDKNotificationServiceStatus
Enumeration of the status of the notification service.
ZoomSDKNotificationServiceError
Enumeration of notification service error codes.
ZoomSDKAuthError
Enumeration of SDK authentication results.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKLoginFailReason
Enumeration of the login failure reasons.
ZoomSDKUserType
Enumeration of user types.
ZoomSDKLoginStatus
Enumeration of ZOOM SDK login status.
Provides information about the currently logged-in user account.
Context object containing authentication token information.
NSString * jwtToken
JWT token used for SDK authentication.
Provides APIs to authorize the Zoom SDK and manage login/logout.
id< ZoomSDKAuthDelegate > _delegate
Controller class to manage meeting transfer and presence features.
Holds explanatory information related to webinar registration.