macOS SDK API Reference
Loading...
Searching...
No Matches
ZoomSDKAuthService.h
Go to the documentation of this file.
1
2
3#import <Cocoa/Cocoa.h>
4#import "ZoomSDKErrors.h"
6
7@interface ZoomSDKAuthContext : NSObject
8
12@property(nonatomic, copy) NSString *jwtToken;
13
14@end
15
20@property(nonatomic, copy,readonly) NSString *content;
24@property(nonatomic, copy,readonly) NSString *accountOwnerLink;
28@property(nonatomic, copy,readonly) NSString *termLink;
32@property(nonatomic, copy,readonly) NSString *policyLink;
33
34@end
35
36@interface ZoomSDKAccountInfo : NSObject
41- (NSString*) getDisplayName;
46- (ZoomSDKUserType) getSDKUserType;
47@end
48
49@protocol ZoomSDKAuthDelegate;
55@interface ZoomSDKAuthService : NSObject
56{
57 id<ZoomSDKAuthDelegate> _delegate;
58}
59@property (assign, nonatomic) id<ZoomSDKAuthDelegate> delegate;
60
61
69- (ZoomSDKError)sdkAuth:(NSString*)key appSecret:(NSString*)secret;
70
77- (ZoomSDKError)sdkAuth:(ZoomSDKAuthContext*)jwttoken;
78
83- (BOOL)isAuthorized;
84
85// @cond PRIVATE
86
92- (NSString*)generateSSOLoginWebURL:(NSString*)prefixOfVanityUrl;
93
99- (ZoomSDKError)SSOLoginWithWebUriProtocol:(NSString*)uriProtocol;
100
101// @endcond
106- (ZoomSDKError)logout;
107
112- (ZoomSDKAccountInfo*)getAccountInfo;
113
118- (NSString*)getSDKIdentity;
119
124- (NSString *)getWebinarRegistrationLegalNoticesPrompt;
125
130- (ZoomSDKWebinarRegistrationExplainInfo *)getWebinarRegistrationLegalNoticesExplained;
131
136- (void)enableAutoRegisterNotificationServiceForLogin:(BOOL)enable;
137
143- (ZoomSDKError)registerNotificationService:(NSString*)accessToken;
144
149- (ZoomSDKError)unregisterNotificationService;
150
155- (ZoomSDKNotificationServiceController *)getNotificationServiceController;
156@end
157
158
159@protocol ZoomSDKAuthDelegate <NSObject>
160
161@required
167- (void)onZoomSDKAuthReturn:(ZoomSDKAuthError)returnValue;
168
172 - (void)onZoomAuthIdentityExpired;
173
174@optional
180- (void)onZoomSDKLoginResult:(ZoomSDKLoginStatus)loginStatus failReason:(ZoomSDKLoginFailReason)reason;
184- (void)onZoomSDKLogout;
185
190- (void)onZoomIdentityExpired;
191
196- (void)onNotificationServiceStatus:(ZoomSDKNotificationServiceStatus)status;
197@end
ZoomSDKNotificationServiceStatus
Enumerations of the type for notification service status.
ZoomSDKAuthError
Enumeration of SDK authentication results.
ZoomSDKError
Enumeration of common errors of SDK.
ZoomSDKLoginFailReason
ZoomSDKUserType
An enumeration of user types.
Definition: ZoomSDKErrors.h:7
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