Zoom SDK Authentication Service Init
- Description:
- Zoom SDK Authentication Service Init
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
authcb |
function | Authentication result callback. |
logoutcb |
function | Logout result callback. |
onZoomIdentityExpired |
function | Zoom identity has expired, please re-login or generate a new Zoom access token via REST Api. |
onZoomAuthIdentityExpired |
function | Zoom authentication identity will be expired in 10 minutes, please re-auth. |
onLoginReturnWithReason |
function | Callback of login result with fail reason. |
Returns:
- Type
- ZoomAuth
- Description:
- Zoom SDK Authentication Service Init
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
authcb |
function | Authentication result callback. |
logoutcb |
function | Logout result callback. |
onZoomIdentityExpired |
function | Zoom identity has expired, please re-login or generate a new Zoom access token via REST Api. |
onZoomAuthIdentityExpired |
function | Zoom authentication identity will be expired in 10 minutes, please re-auth. |
onLoginReturnWithReason |
function | Callback of login result with fail reason. |
Returns:
- Type
- ZoomAuth
Methods
(inner) AuthWithJwtToken(sdk_context) → {Number}
- Description:
- Auth With Jwt Token
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
sdk_context |
String |
Returns:
Defined in: ZoomSDKError
- Type
- Number
(inner) AuthWithJwtToken(sdk_context) → {Number}
- Description:
- Auth With Jwt Token
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
sdk_context |
String |
Returns:
Defined in: ZoomSDKError
- Type
- Number
(inner) GetAuthResult() → {Number}
- Description:
- Get Authentication Status
- Source:
Returns:
Defined in: ZoomAuthResult
- Type
- Number
(inner) GetAuthResult() → {Number}
- Description:
- Get Authentication Status
- Source:
Returns:
Defined in: ZoomAuthResult
- Type
- Number
(inner) GetLoginStatus() → {Number}
- Description:
- Get Login Status
- Source:
Returns:
Defined in: ZoomAuthResult
- Type
- Number
(inner) GetLoginStatus() → {Number}
- Description:
- Get Login Status
- Source:
Returns:
Defined in: ZoomAuthResult
- Type
- Number
(inner) Logout() → {Number}
- Description:
- Account Logout
- Source:
Returns:
Defined in: ZoomSDKError
- Type
- Number
(inner) Logout() → {Number}
- Description:
- Account Logout
- Source:
Returns:
Defined in: ZoomSDKError
- Type
- Number
(inner) SetLoginReturnWithReasonCB(onLoginReturnWithReason) → {Boolean}
- Description:
- Set Login Return With Reason Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onLoginReturnWithReason |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetLoginReturnWithReasonCB(onLoginReturnWithReason) → {Boolean}
- Description:
- Set Login Return With Reason Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onLoginReturnWithReason |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetLogoutCB(logoutcb) → {Boolean}
- Description:
- Set logout callback function.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
logoutcb |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetLogoutCB(logoutcb) → {Boolean}
- Description:
- Set logout callback function.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
logoutcb |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnAuthReturnCB(authcb) → {Boolean}
- Description:
- Set auth callback function.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
authcb |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnAuthReturnCB(authcb) → {Boolean}
- Description:
- Set auth callback function.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
authcb |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnZoomAuthIdentityExpiredCB(onZoomAuthIdentityExpired) → {Boolean}
- Description:
- Set On Zoom Auth Identity Expired Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onZoomAuthIdentityExpired |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnZoomAuthIdentityExpiredCB(onZoomAuthIdentityExpired) → {Boolean}
- Description:
- Set On Zoom Auth Identity Expired Callback
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onZoomAuthIdentityExpired |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnZoomIdentityExpiredCB(onZoomIdentityExpired) → {Boolean}
- Description:
- Set Zoom identity expired callback function.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onZoomIdentityExpired |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnZoomIdentityExpiredCB(onZoomIdentityExpired) → {Boolean}
- Description:
- Set Zoom identity expired callback function.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onZoomIdentityExpired |
function |
Returns:
true or false
- Type
- Boolean
Events
logoutcb
- Description:
- Logout result callback.
- Source:
logoutcb
- Description:
- Logout result callback.
- Source:
onAuthenticationReturn
- Description:
- Authentication result callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
Authentication |
Number | Defined in: ZoomAuthResult |
onAuthenticationReturn
- Description:
- Authentication result callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
Authentication |
Number | Defined in: ZoomAuthResult |
onLoginReturnWithReason
- Description:
- Callback of login result with fail reason.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
loginStatus |
Number | Defined in: ZoomAuthResult |
loginFailReason |
Number | Login fail reason. Valid when the ret is LOGIN_FAILED. Otherwise LoginFail_None. Defined in: LoginFailReason |
onLoginReturnWithReason
- Description:
- Callback of login result with fail reason.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
loginStatus |
Number | Defined in: ZoomAuthResult |
loginFailReason |
Number | Login fail reason. Valid when the ret is LOGIN_FAILED. Otherwise LoginFail_None. Defined in: LoginFailReason |
onZoomAuthIdentityExpired
- Description:
- Zoom authentication identity will be expired in 10 minutes, please re-auth.
- Source:
onZoomAuthIdentityExpired
- Description:
- Zoom authentication identity will be expired in 10 minutes, please re-auth.
- Source:
onZoomIdentityExpired
- Description:
- Zoom identity has expired, please re-login or generate a new Zoom access token via REST Api.
- Source:
onZoomIdentityExpired
- Description:
- Zoom identity has expired, please re-login or generate a new Zoom access token via REST Api.
- Source: