ZoomSDKAuthService Class Reference

Provides APIs to authorize the Zoom SDK and manage login or logout. More...

#include <ZoomSDKAuthService.h>

Inherits NSObject.

Instance Methods
(ZoomSDKError)	- sdkAuth:
	New authenticate SDK.
(BOOL)	- isAuthorized
	Determines if SDK is authorized.
(ZoomSDKError)	- logout
	Logout ZOOM.
(ZoomSDKAccountInfo *_Nullable)	- getAccountInfo
	Gets account information of the user.
(NSString *_Nullable)	- getSDKIdentity
	Gets SDK identity.
(void)	- enableAutoRegisterNotificationServiceForLogin:
	Enables or disable auto register notification service. This is enabled by default.
(ZoomSDKError)	- registerNotificationService:
	Register notification service.
(ZoomSDKError)	- unregisterNotificationService
	Unregister notification service.
(ZoomSDKNotificationServiceController *)	- getNotificationServiceController
	Gets notification service controller interface.

Protected Attributes
id< ZoomSDKAuthDelegate >	_delegate

Properties
id< ZoomSDKAuthDelegate >	delegate
	Delegate to receive auth and login or logout events.

Detailed Description

Provides APIs to authorize the Zoom SDK and manage login or logout.

Definition at line 78 of file ZoomSDKAuthService.h.

Method Documentation

enableAutoRegisterNotificationServiceForLogin:

- (void) enableAutoRegisterNotificationServiceForLogin:

(BOOL)

enable

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

Parameters

enable

YES if enabled, NO otherwise.

getAccountInfo

- (ZoomSDKAccountInfo *_Nullable) getAccountInfo

Gets account information of the user.

Returns

When user logged in, it returns ZoomSDKAccountInfo object if the function calls successfully. Otherwise, this function fails and returns nil.

References getAccountInfo.

Referenced by getAccountInfo.

getNotificationServiceController

- (ZoomSDKNotificationServiceController *) getNotificationServiceController

Gets notification service controller interface.

Returns

If the function succeeds, it returns ZoomSDKZpnsServiceController object. Otherwise, this function fails and returns nil.

References getNotificationServiceController.

Referenced by getNotificationServiceController.

getSDKIdentity

- (NSString *_Nullable) getSDKIdentity

Gets SDK identity.

Returns

If the function succeeds, it returns the SDK identity. Otherwise, this function fails and returns nil.

References getSDKIdentity.

Referenced by getSDKIdentity.

isAuthorized

- (BOOL) isAuthorized

Determines if SDK is authorized.

Returns

YES if it is authorized. Otherwise, NO.

References isAuthorized.

Referenced by isAuthorized.

logout

- (ZoomSDKError) logout

Logout ZOOM.

/**

Returns

If the function succeeds, it returns ZoomSDKError_Success, meanwhile it will call asynchronously onZoomSDKLogout. Otherwise, this function returns an error.

References logout.

Referenced by logout.

registerNotificationService:

- (ZoomSDKError) registerNotificationService:

(NSString *)

accessToken

Register notification service.

Parameters

accessToken

Initialize parameter of notification service.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

sdkAuth:

- (ZoomSDKError) sdkAuth:

(ZoomSDKAuthContext *)

authContext

New authenticate SDK.

Parameters

authContext

A ZoomSDKAuthContext object containing auth information.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Note

If the jwttoken expired, will return ZoomSDKAuthDelegate::onZoomAuthIdentityExpired callback.

unregisterNotificationService

- (ZoomSDKError) unregisterNotificationService

Unregister notification service.

Returns

If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References unregisterNotificationService.

Referenced by unregisterNotificationService.

Field Documentation

_delegate

- (id<ZoomSDKAuthDelegate>) _delegate

protected

Definition at line 80 of file ZoomSDKAuthService.h.

Property Documentation

delegate

- (id<ZoomSDKAuthDelegate>) delegate

readwritenonatomicassign

Delegate to receive auth and login or logout events.

Definition at line 85 of file ZoomSDKAuthService.h.