ZoomSDKAuthService Class Reference

Callback event of ZOOM SDK authorization. Authorize Zoom SDK and the custom application with the key/secret before usage. Once authorize successfully, ZoomSDKAuthDelegate will return ZoomSDKAuthError_Success via onZoomSDKAuthReturn. More...

#import <ZoomSDKAuthService.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- sdkAuth:appSecret:
	Authenticate SDK.
(ZoomSDKError)	- sdkAuth:
	New authenticate SDK.
(BOOL)	- isAuthorized
	Determine if SDK is authorized.
(ZoomSDKError)	- logout
	Logout ZOOM.
(ZoomSDKAccountInfo *)	- getAccountInfo
	Get user's account information.
(NSString *)	- getSDKIdentity
	Get SDK identity.
(NSString *)	- getWebinarRegistrationLegalNoticesPrompt
	Get the webinal legal notices prompt.
(ZoomSDKWebinarRegistrationExplainInfo *)	- getWebinarRegistrationLegalNoticesExplained
	Get the webinal legal notices explained.
(void)	- enableAutoRegisterNotificationServiceForLogin:
	Enable or disable auto register notification service. This is enabled by default.
(ZoomSDKError)	- registerNotificationService:
	Register notification service.
(ZoomSDKError)	- unregisterNotificationService
	Unregister notification service.
(ZoomSDKNotificationServiceController *)	- getNotificationServiceController
	Get notification service controller interface.

Protected Attributes
id< ZoomSDKAuthDelegate >	_delegate

Properties
id< ZoomSDKAuthDelegate >	delegate

Detailed Description

Callback event of ZOOM SDK authorization. Authorize Zoom SDK and the custom application with the key/secret before usage. Once authorize successfully, ZoomSDKAuthDelegate will return ZoomSDKAuthError_Success via onZoomSDKAuthReturn.

Note

You should authorize ZOOM SDK firstly before using it, or no, it may not work.

Definition at line 55 of file ZoomSDKAuthService.h.

Method Documentation

enableAutoRegisterNotificationServiceForLogin:

- (void) enableAutoRegisterNotificationServiceForLogin:

(BOOL)

enable

Enable or disable auto register notification service. This is enabled by default.

Parameters

enable

YES means enabled, otherwise not.

getAccountInfo

- (ZoomSDKAccountInfo *) getAccountInfo

Get user's account information.

Returns

When user logged in, it will return ZoomSDKAccountInfo object if the function calls successfully. Otherwise returns nil.

getNotificationServiceController

- (ZoomSDKNotificationServiceController *) getNotificationServiceController

Get notification service controller interface.

Returns

If the function succeeds, it will return a ZoomSDKZpnsServiceController object.

getSDKIdentity

- (NSString *) getSDKIdentity

Get SDK identity.

Returns

The SDK identity.

getWebinarRegistrationLegalNoticesExplained

- (ZoomSDKWebinarRegistrationExplainInfo *) getWebinarRegistrationLegalNoticesExplained

Get the webinal legal notices explained.

Returns

If the function succeeds, it will return the webinal legal notices explained. Otherwise nil.

getWebinarRegistrationLegalNoticesPrompt

- (NSString *) getWebinarRegistrationLegalNoticesPrompt

Get the webinal legal notices prompt.

Returns

If the function succeeds, it will return the webinal legal notices prompt. Otherwise nil.

isAuthorized

- (BOOL) isAuthorized

Determine if SDK is authorized.

Returns

YES means that it is authorized, otherwise failed.

logout

- (ZoomSDKError) logout

Logout ZOOM.

/**

Returns

If the function succeeds, it will return ZoomSDKError_success, meanwhile it will call asynchronously onZoomSDKLogout.

registerNotificationService:

- (ZoomSDKError) registerNotificationService:

(NSString *)

accessToken

Register notification service.

Parameters

accessToken

Initialize parameter of notification service.

Returns

If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed. To get extended error information, see ZoomSDKError.

sdkAuth:

- (ZoomSDKError) sdkAuth:

(ZoomSDKAuthContext *)

jwttoken

New authenticate SDK.

Parameters

jwttoken

A Class object containing auth information.

Returns

If the function succeeds, it will return ZoomSDKError_success.

Note

If the jwttoken expired,will return "onZoomAuthIdentityExpired" callback.

sdkAuth:appSecret:

- (ZoomSDKError) sdkAuth:		(NSString *)	key
appSecret:		(NSString *)	secret

Authenticate SDK.

Parameters

key	The key of your client, also known as API key.
secret	The secret of your client. DO NOT publish it.

Note

If the client key or secret is empty, user will get error:ZoomSDKError_InvalidPrameter directly.

Returns

If the function succeeds, it will return ZoomSDKError_success, meanwhile it will return SDK auth when calling synchronously onZoomSDKAuthReturn.

unregisterNotificationService

- (ZoomSDKError) unregisterNotificationService

Unregister notification service.

Returns

If the function succeeds, it will return ZoomSDKError_success. Otherwise failed.

Field Documentation

_delegate

- (id<ZoomSDKAuthDelegate>) _delegate

protected

Definition at line 57 of file ZoomSDKAuthService.h.

Property Documentation

delegate

- (id<ZoomSDKAuthDelegate>) delegate

readwritenonatomicassign

Definition at line 59 of file ZoomSDKAuthService.h.