Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCSMSService Class Reference

For SMS service usage like following flow. More...

#include <MobileRTCSMSService.h>

Inherits NSObject.

Instance Methods

(void) - enableZoomAuthRealNameMeetingUIShown:
 Enables or disables the auth real name service. The callback function will be called when needed (judged by SDK logic).
 
(MobileRTCRetrieveSMSHandler *_Nullable) - getResendSMSVerificationCodeHandler
 Gets a new retrieve handle.
 
(MobileRTCVerifySMSHandler *_Nullable) - getReVerifySMSVerificationCodeHandler
 Gets a new verify handle.
 
(NSArray< MobileRTCRealNameCountryInfo * > *_Nullable) - getSupportPhoneNumberCountryList
 Gets the support phone number country list.
 
(BOOL) - setDefaultCellPhoneInfo:phoneNum:
 Sets the default cellphone for signed account.
 

Properties

id< MobileRTCSMSServiceDelegate > _Nullable delegate
 

Detailed Description

For SMS service usage like following flow.

Warning
1.need enable sms service by 'enableZoomAuthRealNameMeetingUIShown'.
2.try to join meeting or start meeting. if Real Name verify not pass, will call the callback 'onNeedRealNameAuth: privacyURL: retrieveHandle:'.
3.try to send sms with retrieveHandle, or you can use the retrieve handle cancel and leave the meeting, 'cancelAndLeaveMeeting'.
4.if success in step 3, pop up the dialog for input the verify code, in the same time, you will receive a sms and a callback 'onRetrieveSMSVerificationCodeResultNotification: verifyHandle:'.
If failed, please try to get retrieve handle 60s later, and go to step 3.
5.you can verify sms by verifyHandle. or you can cancel and leave meeting. 'cancelAndLeaveMeeting'.
6.you will receive callback 'onVerifySMSVerificationCodeResultNotification:' for the verify result.

Definition at line 77 of file MobileRTCSMSService.h.

Method Documentation

◆ enableZoomAuthRealNameMeetingUIShown:

- (void) enableZoomAuthRealNameMeetingUIShown: (bool) enable

Enables or disables the auth real name service. The callback function will be called when needed (judged by SDK logic).

Parameters
enableYES to enable, NO to disable.
Warning
Enable/disable auth real name service.

◆ getResendSMSVerificationCodeHandler

- (MobileRTCRetrieveSMSHandler *_Nullable) getResendSMSVerificationCodeHandler

Gets a new retrieve handle.

Returns
If the function succeeds, it returns a MobileRTCRetrieveSMSHandler object. Otherwise, this function fails and returns nil.
Warning
Need get new handle 60s later.

◆ getReVerifySMSVerificationCodeHandler

- (MobileRTCVerifySMSHandler *_Nullable) getReVerifySMSVerificationCodeHandler

Gets a new verify handle.

Returns
If the function succeeds, it returns a MobileRTCVerifySMSHandler object. Otherwise, this function fails and returns nil.
Warning
Need get new handle 60s later.

◆ getSupportPhoneNumberCountryList

- (NSArray< MobileRTCRealNameCountryInfo * > *_Nullable) getSupportPhoneNumberCountryList

Gets the support phone number country list.

Returns
If the function succeeds, it returns an NSArray of MobileRTCRealNameCountryInfo objects. Otherwise, this function fails and returns nil.
Warning
Get country code list after call join meeting or start meeting interface.

◆ setDefaultCellPhoneInfo:phoneNum:

- (BOOL) setDefaultCellPhoneInfo: (NSString *_Nullable) countryCode
phoneNum: (NSString *_Nullable) phoneNum 

Sets the default cellphone for signed account.

Parameters
countryCodeThe user account's country code.
phoneNumThe default phone number.
Returns
YES if the function succeeds. Otherwise, NO.

Property Documentation

◆ delegate

- (id<MobileRTCSMSServiceDelegate> _Nullable) delegate
readwritenonatomicweak

Definition at line 78 of file MobileRTCSMSService.h.