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>

Inheritance diagram for ZoomSDKAuthService:

Instance Methods
(ZoomSDKError)	- sdkAuth:appSecret:
	Authenticate SDK. More...
(ZoomSDKError)	- sdkAuth:
	New authenticate SDK. More...
(BOOL)	- isAuthorized
	Determine if SDK is authorized. More...
(ZoomSDKError)	- login:Password:RememberMe:
	Login ZOOM with email. More...
(ZoomSDKError)	- loginSSO:
	Login ZOOM with SSO token. More...
(ZoomSDKError)	- loginSSO:RememberMe:
(ZoomSDKError)	- logout
	Logout ZOOM. More...
(ZoomSDKAccountInfo *)	- getAccountInfo
	Get user's account information. More...
(NSString *)	- getSDKIdentity
	Get SDK identity. More...
(ZoomSDKError)	- isEmailLoginEnabled:
	Determine if email login mode is enabled. More...

Protected Attributes
BOOL	_isLogin
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.

Method Documentation

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.

getSDKIdentity

- (NSString*) getSDKIdentity

Get SDK identity.

Returns

The SDK identity.

isAuthorized

- (BOOL) isAuthorized

Determine if SDK is authorized.

Returns

YES means that it is authorized, otherwise failed.

isEmailLoginEnabled:

- (ZoomSDKError) isEmailLoginEnabled:

(BOOL *)

isEnabled

Determine if email login mode is enabled.

Returns

If the function succeeds, otherwise not.

Note

You should call this APIs after you have receive callback of auth success event.

login:Password:RememberMe:

- (ZoomSDKError) login:		(NSString *)	userName
Password:		(NSString *)	password
RememberMe:		(BOOL)	rememberMe

Login ZOOM with email.

Parameters

userName	The email for login.
password	The password for login.
rememberMe	Set it to YES so that user can login automatically next time, otherwise not.

Returns

If the function succeeds, it will return ZoomSDKError_success, meanwhile it will return SDK login result when calling asynchronously onZoomSDKLogin.

loginSSO:

- (ZoomSDKError) loginSSO:		(1.)	0
		(4.3)	NS_DEPRECATED_MAC

Login ZOOM with SSO token.

Parameters

ssoToken	User's token information.
rememberMe	Set it to YES so that user can login automatically next time, otherwise not.

Returns

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

logout

- (ZoomSDKError) logout

Logout ZOOM.

Returns

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

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.

---

The documentation for this class was generated from the following file:

• ZoomSDKAuthService.h