Zoom SDK Authentication Service Init
- Description:
- Zoom SDK Authentication Service Init
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
authcb |
function | Notification of authentication result. |
logoutcb |
function | Notification of logout. |
onZoomIdentityExpired |
function | Notification of Zoom identity has expired, please re-login or generate a new zoom access token via REST Api. |
onZoomAuthIdentityExpired |
function | Notification of Zoom authentication identity will be expired in 10 minutes, please re-auth. |
onLoginReturnWithReason |
function | Notification of login result with fail reason. |
Returns:
- Type
- ZoomAuth
- Description:
- Zoom SDK Authentication Service Init
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
authcb |
function | Notification of authentication result. |
logoutcb |
function | Notification of logout. |
onZoomIdentityExpired |
function | Notification of Zoom identity has expired, please re-login or generate a new zoom access token via REST Api. |
onZoomAuthIdentityExpired |
function | Notification of Zoom authentication identity will be expired in 10 minutes, please re-auth. |
onLoginReturnWithReason |
function | Notification of login result with fail reason. |
Returns:
- Type
- ZoomAuth
Methods
(inner) AuthWithJwtToken(authContext) → {Number}
- Description:
- SDK Authentication with jwt token.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
authContext |
String | The parameter to be used for authentication SDK. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) AuthWithJwtToken(authContext) → {Number}
- Description:
- SDK Authentication with jwt token.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
authContext |
String | The parameter to be used for authentication SDK. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) GenerateSSOLoginWebURL(prefixOfVanityUrl) → {Number}
- Description:
- Get SSO login web url.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
prefixOfVanityUrl |
String | prefix of vanity url. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) GenerateSSOLoginWebURL(prefixOfVanityUrl) → {Number}
- Description:
- Get SSO login web url.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
prefixOfVanityUrl |
String | prefix of vanity url. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) GetAuthResult() → {Number}
- Description:
- Get authentication status.
- Source:
Returns:
The return value is authentication status.
- Type
- Number
(inner) GetAuthResult() → {Number}
- Description:
- Get authentication status.
- Source:
Returns:
The return value is authentication status.
- Type
- Number
(inner) GetLoginStatus() → {Number}
- Description:
- Get login status.
- Source:
Returns:
The return value is login status.
- Type
- Number
(inner) GetLoginStatus() → {Number}
- Description:
- Get login status.
- Source:
Returns:
The return value is login status.
- Type
- Number
(inner) Logout() → {Number}
- Description:
- Account logout.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) Logout() → {Number}
- Description:
- Account logout.
- Source:
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SSOLoginWithWebUriProtocol(uriProtocol) → {Number}
- Description:
- Account login.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
uriProtocol |
String | For the parameter to be used for sso account login. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SSOLoginWithWebUriProtocol(uriProtocol) → {Number}
- Description:
- Account login.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
uriProtocol |
String | For the parameter to be used for sso account login. |
Returns:
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed.
- Type
- Number
(inner) SetLoginReturnWithReasonCB(onLoginReturnWithReason) → {Boolean}
- Description:
- Set onLoginReturnWithReason callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onLoginReturnWithReason |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetLoginReturnWithReasonCB(onLoginReturnWithReason) → {Boolean}
- Description:
- Set onLoginReturnWithReason callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onLoginReturnWithReason |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetLogoutCB(logoutcb) → {Boolean}
- Description:
- Set logoutcb callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
logoutcb |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetLogoutCB(logoutcb) → {Boolean}
- Description:
- Set logoutcb callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
logoutcb |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnAuthReturnCB(authcb) → {Boolean}
- Description:
- Set authcb callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
authcb |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnAuthReturnCB(authcb) → {Boolean}
- Description:
- Set authcb callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
authcb |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnZoomAuthIdentityExpiredCB(onZoomAuthIdentityExpired) → {Boolean}
- Description:
- Set onZoomAuthIdentityExpired callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onZoomAuthIdentityExpired |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnZoomAuthIdentityExpiredCB(onZoomAuthIdentityExpired) → {Boolean}
- Description:
- Set onZoomAuthIdentityExpired callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onZoomAuthIdentityExpired |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnZoomIdentityExpiredCB(onZoomIdentityExpired) → {Boolean}
- Description:
- Set onZoomIdentityExpired callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onZoomIdentityExpired |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetOnZoomIdentityExpiredCB(onZoomIdentityExpired) → {Boolean}
- Description:
- Set onZoomIdentityExpired callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onZoomIdentityExpired |
function |
Returns:
true or false
- Type
- Boolean
Events
onAuthenticationReturn
- Description:
- Notification of authentication result.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
ret |
Number | Authentication result value. |
onAuthenticationReturn
- Description:
- Notification of authentication result.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
ret |
Number | Authentication result value. |
onLoginReturnWithReason
- Description:
- Notification of login result with fail reason.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
status |
Number | Login status. |
reason |
Number | Login fail reason. Valid when the ret is LOGIN_FAILED. Otherwise LoginFail_None. |
onLoginReturnWithReason
- Description:
- Notification of login result with fail reason.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
status |
Number | Login status. |
reason |
Number | Login fail reason. Valid when the ret is LOGIN_FAILED. Otherwise LoginFail_None. |
onLogout
- Description:
- Notification of logout.
- Source:
onLogout
- Description:
- Notification of logout.
- Source:
onZoomAuthIdentityExpired
- Description:
- Notification of Zoom authentication identity will be expired in 10 minutes, please re-auth.
- Source:
onZoomAuthIdentityExpired
- Description:
- Notification of Zoom authentication identity will be expired in 10 minutes, please re-auth.
- Source:
onZoomIdentityExpired
- Description:
- Notification of Zoom identity has expired, please re-login or generate a new zoom access token via REST Api.
- Source:
onZoomIdentityExpired
- Description:
- Notification of Zoom identity has expired, please re-login or generate a new zoom access token via REST Api.
- Source: