Provides methods for managing phone-related session features such as dial-in and phone invites. More...

#include <ZMVideoSDKPhoneHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSupportPhoneFeature
	Determine if the session supports join by phone or not.

(NSArray< ZMVideoSDKPhoneSupportCountryInfo * > *_Nullable)	- getSupportCountryInfo
	Get the list of the country information where the session supports to join by telephone.

(ZMVideoSDKErrors)	- inviteByPhone:phoneNumber:name:
	Invite the specified user to join the session by phone.

(ZMVideoSDKErrors)	- invitePhoneUser:
	Invite the specified user to join the session by phone.

(ZMVideoSDKErrors)	- cancelInviteByPhone
	Cancel the invitation that is being called out by phone.

(ZMPhoneStatus)	- getInviteByPhoneStatus
	Get the status of the invitation by phone.

(NSArray< ZMVideoSDKDialInNumberInfo * > *_Nullable)	- getSessionDialInNumbers
	Get the list of dial in numbers supported by session.

Detailed Description

Provides methods for managing phone-related session features such as dial-in and phone invites.

Definition at line 94 of file ZMVideoSDKPhoneHelper.h.

Method Documentation

◆ cancelInviteByPhone

- (ZMVideoSDKErrors) cancelInviteByPhone

Cancel the invitation that is being called out by phone.

Returns: If the function succeeds, the return value is ZMVideoSDKErrors_Success, otherwise not.

◆ getInviteByPhoneStatus

- (ZMPhoneStatus) getInviteByPhoneStatus

Get the status of the invitation by phone.

Returns: If the function succeeds, the method returns the ZMPhoneStatus of the invitation by phone.

◆ getSessionDialInNumbers

- (NSArray< ZMVideoSDKDialInNumberInfo * > *_Nullable) getSessionDialInNumbers

Get the list of dial in numbers supported by session.

Returns: If the function succeeds, the return value is the list of the call-in numbers. Otherwise failed.

◆ getSupportCountryInfo

- (NSArray< ZMVideoSDKPhoneSupportCountryInfo * > *_Nullable) getSupportCountryInfo

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

Returns: If the function succeeds, the return value is the array of the country information, otherwise returns nil.

◆ inviteByPhone:phoneNumber:name:

- (ZMVideoSDKErrors) inviteByPhone:	(NSString *)	countryCode
phoneNumber:	(NSString *)	phoneNumber
name:	(NSString *)	name

Invite the specified user to join the session by phone.

Parameters

countryCode	The country code of the specified user must be in the support list.
phoneNumber	The phone number of specified user.
name	The screen name of the specified user in the session.

Returns: If the function succeeds, the return value is ZMVideoSDKErrors_Success, otherwise not.

Deprecated: Use ZMVideoSDKPhoneHelper::invitePhoneUser: instead.

◆ invitePhoneUser:

- (ZMVideoSDKErrors) invitePhoneUser: (ZMVideoSDKInvitePhoneUserInfo *) inviteInfo

Invite the specified user to join the session by phone.

Parameters

inviteInfo The info for invite by phone.

Returns: If the function succeeds, the return value is ZMVideoSDKErrors_Success, otherwise not.

◆ isSupportPhoneFeature

- (BOOL) isSupportPhoneFeature

Determine if the session supports join by phone or not.

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

Instance Methods