zoom_sms_helper

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 succeed, 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 succeed, the return value is TRUE.
Type
Boolean

(inner) GetReVerifySMSVerificationCodeHandler() → {Number}

Description:
  • Get verify SMS verification code handler interface.
Source:
Returns:
If the function failed, returns NULL.
Type
Number

(inner) GetReVerifySMSVerificationCodeHandler() → {Number}

Description:
  • Get verify SMS verification code handler interface.
Source:
Returns:
If the function failed, returns NULL.
Type
Number

(inner) GetResendSMSVerificationCodeHandler() → {Number}

Description:
  • Get retrieve SMS verification code handler interface.
Source:
Returns:
If the function failed, returns NULL.
Type
Number

(inner) GetResendSMSVerificationCodeHandler() → {Number}

Description:
  • Get retrieve SMS verification code handler interface.
Source:
Returns:
If the function failed, returns NULL.
Type
Number

(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. The handler will become invalid after calling this function successfully.
Source:
Parameters:
Name Type Description
country_code String Specifies the country code.
phone_number String Specifies the phone number.
Returns:
If the function succeed, the return value is TRUE.
Type
Boolean

(inner) Retrieve(country_code, phone_number) → {Boolean}

Description:
  • Retrieve the sms verification code. The handler will become invalid after calling this function successfully.
Source:
Parameters:
Name Type Description
country_code String Specifies the country code.
phone_number String Specifies the phone number.
Returns:
If the function succeed, the return value is TRUE.
Type
Boolean

(inner) Retrieve_CancelAndLeaveMeeting() → {Boolean}

Description:
  • Retrieve Cancel And Leave Meeting
Source:
Returns:
Type
Boolean

(inner) Retrieve_CancelAndLeaveMeeting() → {Boolean}

Description:
  • Retrieve Cancel And Leave Meeting
Source:
Returns:
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 succeed, 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 succeed, the return value is TRUE.
Type
Boolean

(inner) SetNeedRealNameAuthMeetingNotificationCB(onNeedRealNameAuthMeetingNotification) → {Boolean}

Description:
  • Set Need Real Name Auth Meeting Notification Callback
Source:
Parameters:
Name Type Description
onNeedRealNameAuthMeetingNotification function
Returns:
Type
Boolean

(inner) SetNeedRealNameAuthMeetingNotificationCB(onNeedRealNameAuthMeetingNotification) → {Boolean}

Description:
  • Set Need Real Name Auth Meeting Notification Callback
Source:
Parameters:
Name Type Description
onNeedRealNameAuthMeetingNotification function
Returns:
Type
Boolean

(inner) SetRetrieveSMSVerificationCodeResultNotificationCB(onRetrieveSMSVerificationCodeResultNotification) → {Boolean}

Description:
  • Set Retrieve SMS Verification Code Result Notification Callback
Source:
Parameters:
Name Type Description
onRetrieveSMSVerificationCodeResultNotification function
Returns:
Type
Boolean

(inner) SetRetrieveSMSVerificationCodeResultNotificationCB(onRetrieveSMSVerificationCodeResultNotification) → {Boolean}

Description:
  • Set Retrieve SMS Verification Code Result Notification Callback
Source:
Parameters:
Name Type Description
onRetrieveSMSVerificationCodeResultNotification function
Returns:
Type
Boolean

(inner) SetVerifySMSVerificationCodeResultNotificationCB(onVerifySMSVerificationCodeResultNotification) → {Boolean}

Description:
  • Set Verify SMS Verification Code Result Notification Callback
Source:
Parameters:
Name Type Description
onVerifySMSVerificationCodeResultNotification function
Returns:
Type
Boolean

(inner) SetVerifySMSVerificationCodeResultNotificationCB(onVerifySMSVerificationCodeResultNotification) → {Boolean}

Description:
  • Set Verify SMS Verification Code Result Notification Callback
Source:
Parameters:
Name Type Description
onVerifySMSVerificationCodeResultNotification function
Returns:
Type
Boolean

(inner) Verify(country_code, phone_number, verification_code) → {Boolean}

Description:
  • Verify the sms verification code. The handler will become invalid after calling this function successfully.
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 succeed, the return value is TRUE.
Type
Boolean

(inner) Verify(country_code, phone_number, verification_code) → {Boolean}

Description:
  • Verify the sms verification code. The handler will become invalid after calling this function successfully.
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 succeed, the return value is TRUE.
Type
Boolean

(inner) Verify_CancelAndLeaveMeeting() → {Boolean}

Description:
  • Verify Cancel And Leave Meeting
Source:
Returns:
Type
Boolean

(inner) Verify_CancelAndLeaveMeeting() → {Boolean}

Description:
  • Verify Cancel And Leave Meeting
Source:
Returns:
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. Defined in: SMSVerificationCodeErr

onRetrieveSMSVerificationCodeResultNotification

Description:
  • The callback event for retrieving SMS verification code.
Source:
Parameters:
Name Type Description
result String Specifies the result of retrieve. Defined in: SMSVerificationCodeErr

onVerifySMSVerificationCodeResultNotification

Description:
  • The callback event for verification.
Source:
Parameters:
Name Type Description
result String Specifies the result of verification.

onVerifySMSVerificationCodeResultNotification

Description:
  • The callback event for verification.
Source:
Parameters:
Name Type Description
result String Specifies the result of verification.
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 succeed, 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 succeed, the return value is TRUE.
Type
Boolean

(inner) GetReVerifySMSVerificationCodeHandler() → {Number}

Description:
  • Get verify SMS verification code handler interface.
Source:
Returns:
If the function failed, returns NULL.
Type
Number

(inner) GetReVerifySMSVerificationCodeHandler() → {Number}

Description:
  • Get verify SMS verification code handler interface.
Source:
Returns:
If the function failed, returns NULL.
Type
Number

(inner) GetResendSMSVerificationCodeHandler() → {Number}

Description:
  • Get retrieve SMS verification code handler interface.
Source:
Returns:
If the function failed, returns NULL.
Type
Number

(inner) GetResendSMSVerificationCodeHandler() → {Number}

Description:
  • Get retrieve SMS verification code handler interface.
Source:
Returns:
If the function failed, returns NULL.
Type
Number

(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. The handler will become invalid after calling this function successfully.
Source:
Parameters:
Name Type Description
country_code String Specifies the country code.
phone_number String Specifies the phone number.
Returns:
If the function succeed, the return value is TRUE.
Type
Boolean

(inner) Retrieve(country_code, phone_number) → {Boolean}

Description:
  • Retrieve the sms verification code. The handler will become invalid after calling this function successfully.
Source:
Parameters:
Name Type Description
country_code String Specifies the country code.
phone_number String Specifies the phone number.
Returns:
If the function succeed, the return value is TRUE.
Type
Boolean

(inner) Retrieve_CancelAndLeaveMeeting() → {Boolean}

Description:
  • Retrieve Cancel And Leave Meeting
Source:
Returns:
Type
Boolean

(inner) Retrieve_CancelAndLeaveMeeting() → {Boolean}

Description:
  • Retrieve Cancel And Leave Meeting
Source:
Returns:
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 succeed, 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 succeed, the return value is TRUE.
Type
Boolean

(inner) SetNeedRealNameAuthMeetingNotificationCB(onNeedRealNameAuthMeetingNotification) → {Boolean}

Description:
  • Set Need Real Name Auth Meeting Notification Callback
Source:
Parameters:
Name Type Description
onNeedRealNameAuthMeetingNotification function
Returns:
Type
Boolean

(inner) SetNeedRealNameAuthMeetingNotificationCB(onNeedRealNameAuthMeetingNotification) → {Boolean}

Description:
  • Set Need Real Name Auth Meeting Notification Callback
Source:
Parameters:
Name Type Description
onNeedRealNameAuthMeetingNotification function
Returns:
Type
Boolean

(inner) SetRetrieveSMSVerificationCodeResultNotificationCB(onRetrieveSMSVerificationCodeResultNotification) → {Boolean}

Description:
  • Set Retrieve SMS Verification Code Result Notification Callback
Source:
Parameters:
Name Type Description
onRetrieveSMSVerificationCodeResultNotification function
Returns:
Type
Boolean

(inner) SetRetrieveSMSVerificationCodeResultNotificationCB(onRetrieveSMSVerificationCodeResultNotification) → {Boolean}

Description:
  • Set Retrieve SMS Verification Code Result Notification Callback
Source:
Parameters:
Name Type Description
onRetrieveSMSVerificationCodeResultNotification function
Returns:
Type
Boolean

(inner) SetVerifySMSVerificationCodeResultNotificationCB(onVerifySMSVerificationCodeResultNotification) → {Boolean}

Description:
  • Set Verify SMS Verification Code Result Notification Callback
Source:
Parameters:
Name Type Description
onVerifySMSVerificationCodeResultNotification function
Returns:
Type
Boolean

(inner) SetVerifySMSVerificationCodeResultNotificationCB(onVerifySMSVerificationCodeResultNotification) → {Boolean}

Description:
  • Set Verify SMS Verification Code Result Notification Callback
Source:
Parameters:
Name Type Description
onVerifySMSVerificationCodeResultNotification function
Returns:
Type
Boolean

(inner) Verify(country_code, phone_number, verification_code) → {Boolean}

Description:
  • Verify the sms verification code. The handler will become invalid after calling this function successfully.
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 succeed, the return value is TRUE.
Type
Boolean

(inner) Verify(country_code, phone_number, verification_code) → {Boolean}

Description:
  • Verify the sms verification code. The handler will become invalid after calling this function successfully.
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 succeed, the return value is TRUE.
Type
Boolean

(inner) Verify_CancelAndLeaveMeeting() → {Boolean}

Description:
  • Verify Cancel And Leave Meeting
Source:
Returns:
Type
Boolean

(inner) Verify_CancelAndLeaveMeeting() → {Boolean}

Description:
  • Verify Cancel And Leave Meeting
Source:
Returns:
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. Defined in: SMSVerificationCodeErr

onRetrieveSMSVerificationCodeResultNotification

Description:
  • The callback event for retrieving SMS verification code.
Source:
Parameters:
Name Type Description
result String Specifies the result of retrieve. Defined in: SMSVerificationCodeErr

onVerifySMSVerificationCodeResultNotification

Description:
  • The callback event for verification.
Source:
Parameters:
Name Type Description
result String Specifies the result of verification.

onVerifySMSVerificationCodeResultNotification

Description:
  • The callback event for verification.
Source:
Parameters:
Name Type Description
result String Specifies the result of verification.