IMeetingPhoneHelper Class Reference

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.
virtual bool	IsSupportPhoneFeature ()=0
	Determine whether the meeting supports to join by the phone or not.
virtual bool	IsDialoutSupported ()=0
	Query if it is able to dial out in the current meeting.
virtual IList< IMeetingPhoneSupportCountryInfo * > *	GetSupportCountryInfo ()=0
	Get the list of the country information where the meeting supports to join by telephone.
virtual SDKError	InviteCallOutUser (const zchar_t *countryCode, const zchar_t *phoneNumber, const zchar_t *name)=0
	Invite the specified user to join the meeting by calling out.
virtual SDKError	CancelCallOut ()=0
	Cancel the invitation that is being called out by phone.
virtual PhoneStatus	GetInviteCalloutUserStatus ()=0
	Get the invited users' status by calling out.
virtual SDKError	CallMe (const zchar_t *countryCode, const zchar_t *phoneNumber)=0
	Use the CALL ME to invite the attendee who uses the specified number to join the meeting.
virtual SDKError	Hangup ()=0
	Cancel the current invitation by CALL ME.
virtual PhoneStatus	GetCallMeStatus ()=0
	Get the process of the invitation by CALL ME.
virtual IList< IMeetingCallInPhoneNumberInfo * > *	GetCurrentMeetingCallinNumber ()=0
	Get the list of call in numbers supported by meeting.
virtual unsigned int	GetCurrentMeetingCallinParticipantID ()=0
	Get the ID of the participant who joins the meeting by calling in.

Detailed Description

Meeting phone helper interface.

Definition at line 117 of file meeting_phone_helper_interface.h.

Member Function Documentation

CallMe()

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

pure virtual

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

Parameters

countryCode	The country code of the specified user must be in the support list.
phoneNumber	The 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 the 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 invited users' status by calling 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 nullptr.

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 zchar_t * countryCode, const zchar_t * phoneNumber, const zchar_t * name )

pure virtual

Invite the specified user to join the meeting by calling out.

Parameters

countryCode	The specified users' country code must be in the support list.
phoneNumber	The specified users' phone number.
name	The specified users' screen name in the meeting.

Returns

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

IsDialoutSupported()

virtual bool IMeetingPhoneHelper::IsDialoutSupported ( )

pure virtual

Query if it is able to dial out in the current meeting.

Returns

return true means able to dial out. Otherwise return false.

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

pEvent

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