Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKAuthService.h
Go to the documentation of this file.
1
5
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
25@property(nonatomic, copy, nullable) NSString *publicAppKey;
26@end
27
28
37@property(nonatomic, copy, readonly, nullable) NSString *content;
41@property(nonatomic, copy, readonly, nullable) NSString *accountOwnerLink;
45@property(nonatomic, copy, readonly, nullable) NSString *termLink;
49@property(nonatomic, copy, readonly, nullable) NSString *policyLink;
50
51@end
52
53
58@interface ZoomSDKAccountInfo : NSObject
63- (NSString*_Nullable) getDisplayName;
69@end
70
71
72
73@protocol ZoomSDKAuthDelegate;
78@interface ZoomSDKAuthService : NSObject
79{
80 id<ZoomSDKAuthDelegate> _delegate;
81}
85@property (assign, nonatomic, nullable) id<ZoomSDKAuthDelegate> delegate;
86
93- (ZoomSDKError)sdkAuth:(ZoomSDKAuthContext*)authContext;
94
100
101// @cond PRIVATE
102
108- (NSString*_Nullable)generateSSOLoginWebURL:(NSString*)prefixOfVanityUrl;
109
115- (ZoomSDKError)SSOLoginWithWebUriProtocol:(NSString*)uriProtocol;
116
117// @endcond
123
129
134- (NSString*_Nullable)getSDKIdentity;
135
140- (void)enableAutoRegisterNotificationServiceForLogin:(BOOL)enable;
141
147- (ZoomSDKError)registerNotificationService:(NSString*)accessToken;
148
154
160@end
161
162
167@protocol ZoomSDKAuthDelegate <NSObject>
168
169@required
175- (void)onZoomSDKAuthReturn:(ZoomSDKAuthError)returnValue;
176
181
182@optional
188- (void)onZoomSDKLoginResult:(ZoomSDKLoginStatus)loginStatus failReason:(ZoomSDKLoginFailReason)reason;
193
199
205- (void)onNotificationServiceStatus:(ZoomSDKNotificationServiceStatus)status error:(ZoomSDKNotificationServiceError)error;
206@end
207NS_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.
ZoomSDKUserType getSDKUserType()
Gets the type of user.
NSString *_Nullable getDisplayName()
Gets screen name of the user.
Context object containing authentication token information.
NSString * publicAppKey
Public app key used for SDK authentication. Alternative to JWT token.
NSString * jwtToken
JWT token used for SDK authentication.
Provides APIs to authorize the Zoom SDK and manage login or logout.
id< ZoomSDKAuthDelegate > delegate
Delegate to receive auth and login or logout events.
id< ZoomSDKAuthDelegate > _delegate
ZoomSDKError logout()
Logout ZOOM.
ZoomSDKError unregisterNotificationService()
Unregister notification service.
BOOL isAuthorized()
Determines if SDK is authorized.
ZoomSDKAccountInfo *_Nullable getAccountInfo()
Gets account information of the user.
ZoomSDKNotificationServiceController * getNotificationServiceController()
Gets notification service controller interface.
NSString *_Nullable getSDKIdentity()
Gets SDK identity.
Controller class to manage meeting transfer and presence features.
Holds explanatory information related to webinar registration.
NSString * policyLink
PolicyLink of the webinar Registration Explain Info.
NSString * termLink
TermLink of the webinar Registration Explain Info.
NSString * content
Content of the webinar Registration Explain Info.
NSString * accountOwnerLink
AccountOwnerLink of the webinar Registration Explain Info.
void onZoomAuthIdentityExpired()
Specify to get the response of ZOOM SDK authorization identity expired.
void onZoomIdentityExpired()
Specify to get the response if ZOOM identity is expired.
void onZoomSDKLogout()
Specify to get the response of ZOOM SDK logout.