Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKAuthService.h
Go to the documentation of this file.
1
2
3#import <Cocoa/Cocoa.h>
4#import <ZoomSDK/ZoomSDKErrors.h>
5#import <ZoomSDK/ZoomSDKNotificationServiceController.h>
6
7NS_ASSUME_NONNULL_BEGIN
8@interface ZoomSDKAuthContext : NSObject
9
13@property(nonatomic, copy, nullable) NSString *jwtToken;
14
15@end
16
21@property(nonatomic, copy, readonly, nullable) NSString *content;
25@property(nonatomic, copy, readonly, nullable) NSString *accountOwnerLink;
29@property(nonatomic, copy, readonly, nullable) NSString *termLink;
33@property(nonatomic, copy, readonly, nullable) NSString *policyLink;
34
35@end
36
37@interface ZoomSDKAccountInfo : NSObject
42- (NSString*_Nullable) getDisplayName;
47- (ZoomSDKUserType) getSDKUserType;
48@end
49
50@protocol ZoomSDKAuthDelegate;
56@interface ZoomSDKAuthService : NSObject
57{
58 id<ZoomSDKAuthDelegate> _delegate;
59}
60@property (assign, nonatomic, nullable) id<ZoomSDKAuthDelegate> delegate;
61
68- (ZoomSDKError)sdkAuth:(ZoomSDKAuthContext*)jwttoken;
69
74- (BOOL)isAuthorized;
75
76// @cond PRIVATE
77
83- (NSString*_Nullable)generateSSOLoginWebURL:(NSString*)prefixOfVanityUrl;
84
90- (ZoomSDKError)SSOLoginWithWebUriProtocol:(NSString*)uriProtocol;
91
92// @endcond
97- (ZoomSDKError)logout;
98
103- (ZoomSDKAccountInfo *_Nullable)getAccountInfo;
104
109- (NSString*_Nullable)getSDKIdentity;
110
115- (void)enableAutoRegisterNotificationServiceForLogin:(BOOL)enable;
116
122- (ZoomSDKError)registerNotificationService:(NSString*)accessToken;
123
128- (ZoomSDKError)unregisterNotificationService;
129
134- (ZoomSDKNotificationServiceController *)getNotificationServiceController;
135@end
136
137
138@protocol ZoomSDKAuthDelegate <NSObject>
139
140@required
146- (void)onZoomSDKAuthReturn:(ZoomSDKAuthError)returnValue;
147
151 - (void)onZoomAuthIdentityExpired;
152
153@optional
159- (void)onZoomSDKLoginResult:(ZoomSDKLoginStatus)loginStatus failReason:(ZoomSDKLoginFailReason)reason;
163- (void)onZoomSDKLogout;
164
169- (void)onZoomIdentityExpired;
170
176- (void)onNotificationServiceStatus:(ZoomSDKNotificationServiceStatus)status error:(ZoomSDKNotificationServiceError)error;
177@end
178NS_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
An enumeration of user types.
ZoomSDKLoginStatus
Enumeration of ZOOM SDK login status.
NSString * jwtToken
jwtToken The new auth token.
Callback event of ZOOM SDK authorization. Authorize Zoom SDK and the custom application with the key/...
id< ZoomSDKAuthDelegate > _delegate