Video SDK for Windows API Reference
Loading...
Searching...
No Matches
IZoomVideoSDKPhoneHelper Class Referenceabstract

zoom video sdk phone helper interface. More...

#include <zoom_video_sdk_phone_helper_interface.h>

Public Member Functions

virtual bool isSupportPhoneFeature ()=0
 Determine if the session supports join by phone or not.
 
virtual IVideoSDKVector< IZoomVideoSDKPhoneSupportCountryInfo * > * getSupportCountryInfo ()=0
 Get the list of the country information where the session supports to join by telephone.
 
virtual ZoomVideoSDKErrors inviteByPhone (const zchar_t *countryCode, const zchar_t *phoneNumber, const zchar_t *name)=0
 Invite the specified user to join the session by call out.
 
virtual ZoomVideoSDKErrors invitePhoneUser (const InvitePhoneUserInfo &inviteInfo)=0
 
virtual ZoomVideoSDKErrors cancelInviteByPhone ()=0
 Cancel the invitation that is being invited by phone.
 
virtual PhoneStatus getInviteByPhoneStatus ()=0
 Get the status of the invitation by phone.
 
virtual IVideoSDKVector< IZoomVideoSDKSessionDialInNumberInfo * > * getSessionDialInNumbers ()=0
 Get the list of dial in numbers supported by session.
 

Detailed Description

zoom video sdk phone helper interface.

Definition at line 126 of file zoom_video_sdk_phone_helper_interface.h.

Member Function Documentation

◆ cancelInviteByPhone()

virtual ZoomVideoSDKErrors IZoomVideoSDKPhoneHelper::cancelInviteByPhone ( )
pure virtual

Cancel the invitation that is being invited by phone.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ getInviteByPhoneStatus()

virtual PhoneStatus IZoomVideoSDKPhoneHelper::getInviteByPhoneStatus ( )
pure virtual

Get the status of the invitation by phone.

Returns
If the function succeeds, the method returns the PhoneStatus of the invitation by phone. To get extended error information, see PhoneStatus enum

◆ getSessionDialInNumbers()

virtual IVideoSDKVector< IZoomVideoSDKSessionDialInNumberInfo * > * IZoomVideoSDKPhoneHelper::getSessionDialInNumbers ( )
pure virtual

Get the list of dial in numbers supported by session.

Returns
If the function succeeds, the return value is the list of the dial-in numbers. Otherwise failed. For more details, see ISessionDialInNumberInfo.

◆ getSupportCountryInfo()

virtual IVideoSDKVector< IZoomVideoSDKPhoneSupportCountryInfo * > * IZoomVideoSDKPhoneHelper::getSupportCountryInfo ( )
pure virtual

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 nullptr.

◆ inviteByPhone()

virtual ZoomVideoSDKErrors IZoomVideoSDKPhoneHelper::inviteByPhone ( const zchar_t * countryCode,
const zchar_t * phoneNumber,
const zchar_t * name )
pure virtual

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 SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Deprecated
This interface is marked as deprecated, and is replaced by invitePhoneUser(const InvitePhoneUserInfo& inviteInfo).

◆ invitePhoneUser()

virtual ZoomVideoSDKErrors IZoomVideoSDKPhoneHelper::invitePhoneUser ( const InvitePhoneUserInfo & inviteInfo)
pure virtual

\brief Invite the specified user to join the session by call out. \param inviteInfo The info for invite by phone. See InvitePhoneUserInfo. \return If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see \link SDKError \endlink enum.

◆ isSupportPhoneFeature()

virtual bool IZoomVideoSDKPhoneHelper::isSupportPhoneFeature ( )
pure virtual

Determine if the session supports join by phone or not.

Returns
True indicates join by phone is supported, otherwise false.