Zoom SMS Helper
- Description:
- Zoom SMS Helper
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onNeedRealNameAuthMeetingNotification |
function | If real name auth is needed, this callback will be triggered. |
onRetrieveSMSVerificationCodeResultNotification |
function | The callback event for retrieving SMS verification code. |
onVerifySMSVerificationCodeResultNotification |
function | The callback event for verification. |
Returns:
- Type
- ZoomSMSHelper
- Description:
- Zoom SMS Helper
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onNeedRealNameAuthMeetingNotification |
function | If real name auth is needed, this callback will be triggered. |
onRetrieveSMSVerificationCodeResultNotification |
function | The callback event for retrieving SMS verification code. |
onVerifySMSVerificationCodeResultNotification |
function | The callback event for verification. |
Returns:
- Type
- ZoomSMSHelper
Methods
(inner) EnableZoomAuthRealNameMeetingUIShown(b_enable) → {Boolean}
- Description:
- Set the visibility of the dialog box of auth real name when needed. Default value: TRUE.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
b_enable |
Boolean | TRUE indicates to display the dialog box. Otherwise not. |
Returns:
If the function succeeds, the return value is TRUE.
- Type
- Boolean
(inner) EnableZoomAuthRealNameMeetingUIShown(b_enable) → {Boolean}
- Description:
- Set the visibility of the dialog box of auth real name when needed. Default value: TRUE.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
b_enable |
Boolean | TRUE indicates to display the dialog box. Otherwise not. |
Returns:
If the function succeeds, the return value is TRUE.
- Type
- Boolean
(inner) GetReVerifySMSVerificationCodeHandler() → {Boolean}
- Description:
- Get verify SMS verification code handler interface.
- Source:
Returns:
If the function succeeds, the return value is TRUE. Otherwise returns False.
- Type
- Boolean
(inner) GetReVerifySMSVerificationCodeHandler() → {Boolean}
- Description:
- Get verify SMS verification code handler interface.
- Source:
Returns:
If the function succeeds, the return value is TRUE. Otherwise returns False.
- Type
- Boolean
(inner) GetResendSMSVerificationCodeHandler() → {Boolean}
- Description:
- Get retrieve SMS verification code handler interface.
- Source:
Returns:
If the function succeeds, the return value is TRUE. Otherwise returns False.
- Type
- Boolean
(inner) GetResendSMSVerificationCodeHandler() → {Boolean}
- Description:
- Get retrieve SMS verification code handler interface.
- Source:
Returns:
If the function succeeds, the return value is TRUE. Otherwise returns False.
- Type
- Boolean
(inner) GetSupportPhoneNumberCountryList() → {Array}
- Description:
- Get the list of the country information where the meeting supports real name auth.
- Source:
Returns:
List of the country information where the meeting supports real name auth.
- Type
- Array
(inner) GetSupportPhoneNumberCountryList() → {Array}
- Description:
- Get the list of the country information where the meeting supports real name auth.
- Source:
Returns:
List of the country information where the meeting supports real name auth.
- Type
- Array
(inner) Retrieve(country_code, phone_number) → {Boolean}
- Description:
- Retrieve the sms verification code.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
country_code |
String | Specifies the country code. |
phone_number |
String | Specifies the phone number. |
Returns:
If the function succeeds, the return value is TRUE.
- Type
- Boolean
(inner) Retrieve(country_code, phone_number) → {Boolean}
- Description:
- Retrieve the sms verification code.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
country_code |
String | Specifies the country code. |
phone_number |
String | Specifies the phone number. |
Returns:
If the function succeeds, the return value is TRUE.
- Type
- Boolean
(inner) Retrieve_CancelAndLeaveMeeting() → {Boolean}
- Description:
- Ignore the prompt of retrieving the verification code and leave meeting.
- Source:
Returns:
If the function succeeds, the return value is TRUE.
- Type
- Boolean
(inner) Retrieve_CancelAndLeaveMeeting() → {Boolean}
- Description:
- Ignore the prompt of retrieving the verification code and leave meeting.
- Source:
Returns:
If the function succeeds, the return value is TRUE.
- Type
- Boolean
(inner) SetDefaultCellPhoneInfo(country_code, phone_number) → {Boolean}
- Description:
- Set default cellphone information to let the user bypass the real name auth to start/join meeting directly.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
country_code |
String | Specifies the country code. |
phone_number |
String | Specifies the phone number. |
Returns:
If the function succeeds, the return value is TRUE.
- Type
- Boolean
(inner) SetDefaultCellPhoneInfo(country_code, phone_number) → {Boolean}
- Description:
- Set default cellphone information to let the user bypass the real name auth to start/join meeting directly.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
country_code |
String | Specifies the country code. |
phone_number |
String | Specifies the phone number. |
Returns:
If the function succeeds, the return value is TRUE.
- Type
- Boolean
(inner) SetNeedRealNameAuthMeetingNotificationCB(onNeedRealNameAuthMeetingNotification) → {Boolean}
- Description:
- Set onNeedRealNameAuthMeetingNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onNeedRealNameAuthMeetingNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetNeedRealNameAuthMeetingNotificationCB(onNeedRealNameAuthMeetingNotification) → {Boolean}
- Description:
- Set onNeedRealNameAuthMeetingNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onNeedRealNameAuthMeetingNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetRetrieveSMSVerificationCodeResultNotificationCB(onRetrieveSMSVerificationCodeResultNotification) → {Boolean}
- Description:
- Set onRetrieveSMSVerificationCodeResultNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onRetrieveSMSVerificationCodeResultNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetRetrieveSMSVerificationCodeResultNotificationCB(onRetrieveSMSVerificationCodeResultNotification) → {Boolean}
- Description:
- Set onRetrieveSMSVerificationCodeResultNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onRetrieveSMSVerificationCodeResultNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetVerifySMSVerificationCodeResultNotificationCB(onVerifySMSVerificationCodeResultNotification) → {Boolean}
- Description:
- Set onVerifySMSVerificationCodeResultNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onVerifySMSVerificationCodeResultNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) SetVerifySMSVerificationCodeResultNotificationCB(onVerifySMSVerificationCodeResultNotification) → {Boolean}
- Description:
- Set onVerifySMSVerificationCodeResultNotification callback.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
onVerifySMSVerificationCodeResultNotification |
function |
Returns:
true or false
- Type
- Boolean
(inner) Verify(country_code, phone_number, verification_code) → {Boolean}
- Description:
- Verify the sms verification code.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
country_code |
String | Specifies the country code. |
phone_number |
String | Specifies the phone number. |
verification_code |
String | Specifies the verification code. |
Returns:
If the function succeeds, the return value is TRUE.
- Type
- Boolean
(inner) Verify(country_code, phone_number, verification_code) → {Boolean}
- Description:
- Verify the sms verification code.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
country_code |
String | Specifies the country code. |
phone_number |
String | Specifies the phone number. |
verification_code |
String | Specifies the verification code. |
Returns:
If the function succeeds, the return value is TRUE.
- Type
- Boolean
(inner) Verify_CancelAndLeaveMeeting() → {Boolean}
- Description:
- Ignore the prompt of verifying the verification code and leave meeting.
- Source:
Returns:
If the function succeeds, the return value is TRUE.
- Type
- Boolean
(inner) Verify_CancelAndLeaveMeeting() → {Boolean}
- Description:
- Ignore the prompt of verifying the verification code and leave meeting.
- Source:
Returns:
If the function succeeds, the return value is TRUE.
- Type
- Boolean
Events
onNeedRealNameAuthMeetingNotification
- Description:
- If real name auth is needed, this callback will be triggered.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
support_country_list |
Array | The list of the supporting country information. |
privacy_url |
String | The privacy url. |
onNeedRealNameAuthMeetingNotification
- Description:
- If real name auth is needed, this callback will be triggered.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
support_country_list |
Array | The list of the supporting country information. |
privacy_url |
String | The privacy url. |
onRetrieveSMSVerificationCodeResultNotification
- Description:
- The callback event for retrieving SMS verification code.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
result |
String | Specifies the result of retrieve SMSVerificationCodeErr |
onRetrieveSMSVerificationCodeResultNotification
- Description:
- The callback event for retrieving SMS verification code.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
result |
String | Specifies the result of retrieve SMSVerificationCodeErr |
onVerifySMSVerificationCodeResultNotification
- Description:
- The callback event for verification.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
result |
String | Specifies the result of verification SMSVerificationCodeErr |
onVerifySMSVerificationCodeResultNotification
- Description:
- The callback event for verification.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
result |
String | Specifies the result of verification SMSVerificationCodeErr |