Video SDK for iOS API Reference
All Classes Files Functions Enumerations Enumerator Properties
ZoomVideoSDKPhoneHelper Class Reference

#include <ZoomVideoSDKPhoneHelper.h>

Inherits NSObject.

Instance Methods

(BOOL) - isSupportPhoneFeature
 Determine if the session supports join by phone or not.
 
(NSArray< ZoomVideoSDKPhoneSupportCountryInfo * > *_Nullable) - getSupportCountryInfo
 Get the list of the country information where the session supports to join by telephone.
 
(ZoomVideoSDKError- inviteByPhone:phoneNumber:name:
 Invite the specified user to join the session by call out.
 
(ZoomVideoSDKError- invitePhoneUser:
 Invite the specified user to join the session by call out.
 
(ZoomVideoSDKError- cancelInviteByPhone
 Cancel the invitation that is being called out by phone.
 
(ZoomVideoSDKPhoneStatus- getInviteByPhoneStatus
 Get the status of the invitation by phone.
 
(NSArray< ZoomVideoSDKDialInNumberInfo * > *_Nullable) - getSessionDialInNumbers
 Get video sdk dial in number information list.
 

Detailed Description

Definition at line 95 of file ZoomVideoSDKPhoneHelper.h.

Method Documentation

◆ cancelInviteByPhone

- (ZoomVideoSDKError) cancelInviteByPhone

Cancel the invitation that is being called out by phone.

Returns
If the function succeeds, the return value is Errors_Success.Otherwise failed

◆ getInviteByPhoneStatus

- (ZoomVideoSDKPhoneStatus) getInviteByPhoneStatus

Get the status of the invitation by phone.

Returns
If the function succeeds, the method returns the ZoomVideoSDKPhoneStatus of the invitation by phone. To get extended error information, see [ZoomVideoSDKPhoneStatus].

◆ getSessionDialInNumbers

- (NSArray< ZoomVideoSDKDialInNumberInfo * > *_Nullable) getSessionDialInNumbers

Get video sdk dial in number information list.

Returns
If the function succeeds, will return dial in information list

◆ getSupportCountryInfo

- (NSArray< ZoomVideoSDKPhoneSupportCountryInfo * > *_Nullable) getSupportCountryInfo

Get the list of the country information where the session supports to join by telephone.

Returns
List of the country information returns if the session supports to join by telephone. Otherwise nil.

◆ inviteByPhone:phoneNumber:name:

- (ZoomVideoSDKError) inviteByPhone: (NSString *_Nonnull) countryCode
phoneNumber: (NSString *_Nonnull) phoneNumber
name: (NSString *_Nonnull) name 

Invite the specified user to join the session by call out.

Parameters
countryCodeThe country code of the specified user must be in the support list.
phoneNumberThe phone number of specified user.
nameThe screen name of the specified user in the session.
Returns
If the function succeeds, the return value is Errors_Success.Otherwise failed.

◆ invitePhoneUser:

- (ZoomVideoSDKError) invitePhoneUser: (ZoomVideoSDKInvitePhoneUserInfo *_Nullable) inviteInfo

Invite the specified user to join the session by call out.

Parameters
inviteInfoThe invite action's informations.
Returns
If the function succeeds, the return value is Errors_Success.Otherwise failed.

◆ isSupportPhoneFeature

- (BOOL) isSupportPhoneFeature

Determine if the session supports join by phone or not.

Returns
YES indicates join by phone is supported, otherwise NO.