ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
IMeetingPhoneHelper Class Referenceabstract

Meeting phone helper interface. More...

#include <meeting_phone_helper_interface.h>

Public Member Functions

virtual SDKError SetEvent (IMeetingPhoneHelperEvent *pEvent)=0
 Set meeting phone helper callback event handler. More...
 
virtual bool IsSupportPhoneFeature ()=0
 Determine whether the meeting supports to join by the phone or not. More...
 
virtual IList< IMeetingPhoneSupportCountryInfo *> * GetSupportCountryInfo ()=0
 Get the list of the country information where the meeting supports to join by telephone. More...
 
virtual SDKError InviteCallOutUser (const wchar_t *countryCode, const wchar_t *phoneNumber, const wchar_t *name)=0
 Invite the specified user to join the meeting by call out. More...
 
virtual SDKError CancelCallOut ()=0
 Cancel the invitation that is being called out by phone. More...
 
virtual PhoneStatus GetInviteCalloutUserStatus ()=0
 Get the process of the invitation by call out. More...
 
virtual SDKError CallMe (const wchar_t *countryCode, const wchar_t *phoneNumber)=0
 Use the CALL ME to invite the attendee who uses the specified number to join the meeting. More...
 
virtual SDKError Hangup ()=0
 Cancel the current invitation by CALL ME. More...
 
virtual PhoneStatus GetCallMeStatus ()=0
 Get the process of the invitation by CALL ME. More...
 
virtual IList< IMeetingCallInPhoneNumberInfo * > * GetCurrentMeetingCallinNumber ()=0
 Get the list of call in numbers supported by meeting. More...
 
virtual unsigned int GetCurrentMeetingCallinParticipantID ()=0
 Get the ID of participant who joins the meeting by calling in. More...
 

Detailed Description

Meeting phone helper interface.

Member Function Documentation

◆ CallMe()

virtual SDKError IMeetingPhoneHelper::CallMe ( const wchar_t *  countryCode,
const wchar_t *  phoneNumber 
)
pure virtual

Use the CALL ME to invite the attendee who uses the specified number to join the meeting.

Parameters
countryCodeThe country code of the specified user must be in the support list.
phoneNumberThe specified phone number.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ CancelCallOut()

virtual SDKError IMeetingPhoneHelper::CancelCallOut ( )
pure virtual

Cancel the invitation that is being called out by phone.

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

◆ GetCallMeStatus()

virtual PhoneStatus IMeetingPhoneHelper::GetCallMeStatus ( )
pure virtual

Get the process of the invitation by CALL ME.

Returns
If the function succeeds, the return value is the process of the invitation by CALL ME. Otherwise failed. To get extended error information, see PhoneStatus enum.

◆ GetCurrentMeetingCallinNumber()

virtual IList<IMeetingCallInPhoneNumberInfo*>* IMeetingPhoneHelper::GetCurrentMeetingCallinNumber ( )
pure virtual

Get the list of call in numbers supported by meeting.

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

◆ GetCurrentMeetingCallinParticipantID()

virtual unsigned int IMeetingPhoneHelper::GetCurrentMeetingCallinParticipantID ( )
pure virtual

Get the ID of participant who joins the meeting by calling in.

Returns
If the function succeeds, the return value is the participant ID.

◆ GetInviteCalloutUserStatus()

virtual PhoneStatus IMeetingPhoneHelper::GetInviteCalloutUserStatus ( )
pure virtual

Get the process of the invitation by call out.

Returns
If the function succeeds, the return value is the current call-out process. To get extended error information, see PhoneStatus enum

◆ GetSupportCountryInfo()

virtual IList<IMeetingPhoneSupportCountryInfo* >* IMeetingPhoneHelper::GetSupportCountryInfo ( )
pure virtual

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

Returns
List of the country information returns if the meeting supports to join by telephone. Otherwise NULL.

◆ Hangup()

virtual SDKError IMeetingPhoneHelper::Hangup ( )
pure virtual

Cancel the current invitation by CALL ME.

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

◆ InviteCallOutUser()

virtual SDKError IMeetingPhoneHelper::InviteCallOutUser ( const wchar_t *  countryCode,
const wchar_t *  phoneNumber,
const wchar_t *  name 
)
pure virtual

Invite the specified user to join the meeting 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 meeting.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ IsSupportPhoneFeature()

virtual bool IMeetingPhoneHelper::IsSupportPhoneFeature ( )
pure virtual

Determine whether the meeting supports to join by the phone or not.

Returns
TRUE indicates to support to join by phone. FALSE not.

◆ SetEvent()

virtual SDKError IMeetingPhoneHelper::SetEvent ( IMeetingPhoneHelperEvent pEvent)
pure virtual

Set meeting phone helper callback event handler.

Parameters
pEventA pointer to the IMeetingPhoneHelperEvent that receives the phone event.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

The documentation for this class was generated from the following file: