us.zoom.sdk.PhoneHelper Interface Reference

Helper interface for phone-related operations in meetings. More...

Data Structures
interface	PhoneSupportCountryInfo
	Phone support country information interface. More...
enum	PhoneStatus
	Enumeration of phone call status. More...
enum	CallInNumberType
	Enumeration of the number types for calling to join the audio into a meeting. More...
enum	PhoneFailedReason
	Enumeration of the reasons for the telephone call’s failure. More...
interface	CallInPhoneNumberInfo
	Call-in phone number information interface. More...

Public Member Functions
void	addListener (PhoneHelperListener listener)
	Adds a phone helper listener.
void	removeListener (PhoneHelperListener listener)
	Removes the phone helper listener.
boolean	isSupportPhoneFeature ()
	Determines whether the user account supports calling out.
boolean	isDialOutSupported ()
	Determines whether it is able to dial out in the current meeting.
List< PhoneSupportCountryInfo >	getSupportCountryInfo ()
	Gets the list of countries which support calling out.
MobileRTCSDKError	inviteCallOutUser (String countryCode, String phoneNumber, String userName)
	Invites the specified user to join the meeting by calling out.
MobileRTCSDKError	cancelCallOutUser ()
	Cancels the invitation that is being called out by phone.
PhoneStatus	getInviteCallOutUserStatus ()
	Gets the invited user's status by calling out.
MobileRTCSDKError	callMe (String countryCode, String phoneNumber)
	Invites myself to join audio to the meeting by phone.
MobileRTCSDKError	hangUp ()
	Cancels the current CALL ME action.
PhoneStatus	getCallMeStatus ()
	Gets the status of the invitation by CALL ME.
List< CallInPhoneNumberInfo >	getCurrentMeetingCallInNumber ()
	Gets the list of call-in numbers supported by the meeting.
long	getCurrentMeetingCallInParticipantID ()
	Gets the ID of the participant who joins the meeting by calling in.

Detailed Description

Helper interface for phone-related operations in meetings.

Definition at line 8 of file PhoneHelper.java.

Member Function Documentation

addListener()

void us.zoom.sdk.PhoneHelper.addListener

(

PhoneHelperListener

listener

)

Adds a phone helper listener.

Parameters

listener

The phone helper listener. See PhoneHelperListener.

callMe()

MobileRTCSDKError us.zoom.sdk.PhoneHelper.callMe	(	String	countryCode,
		String	phoneNumber )

Invites myself to join audio to the meeting by phone.

Parameters

countryCode	The country code.
phoneNumber	The device's phone number.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

cancelCallOutUser()

MobileRTCSDKError us.zoom.sdk.PhoneHelper.cancelCallOutUser

(

)

Cancels the invitation that is being called out by phone.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

getCallMeStatus()

PhoneStatus us.zoom.sdk.PhoneHelper.getCallMeStatus

(

)

Gets the status of the invitation by CALL ME.

Returns

If the function succeeds, it returns the status of the invitation by CALL ME. Otherwise, this function fails and returns null.

getCurrentMeetingCallInNumber()

List< CallInPhoneNumberInfo > us.zoom.sdk.PhoneHelper.getCurrentMeetingCallInNumber

(

)

Gets the list of call-in numbers supported by the meeting.

Returns

If the function succeeds, it returns the list of call-in numbers. Otherwise, this function fails and returns null.

getCurrentMeetingCallInParticipantID()

long us.zoom.sdk.PhoneHelper.getCurrentMeetingCallInParticipantID

(

)

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

Returns

If the function succeeds, it returns the participant's ID. Otherwise, this function fails and returns 0.

getInviteCallOutUserStatus()

PhoneStatus us.zoom.sdk.PhoneHelper.getInviteCallOutUserStatus

(

)

Gets the invited user's status by calling out.

Returns

If the function succeeds, it returns the current call-out status. Otherwise, this function fails and returns null.

getSupportCountryInfo()

List< PhoneSupportCountryInfo > us.zoom.sdk.PhoneHelper.getSupportCountryInfo

(

)

Gets the list of countries which support calling out.

Returns

If the function succeeds, it returns the list of countries. Otherwise, this function fails and returns null. See PhoneSupportCountryInfo.

hangUp()

MobileRTCSDKError us.zoom.sdk.PhoneHelper.hangUp

(

)

Cancels the current CALL ME action.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

inviteCallOutUser()

MobileRTCSDKError us.zoom.sdk.PhoneHelper.inviteCallOutUser	(	String	countryCode,
		String	phoneNumber,
		String	userName )

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

Parameters

countryCode	The specified user's country code. Must be in the support list.
phoneNumber	The specified user's phone number.
userName	The specified user's in-meeting screen name.

Returns

If the function succeeds, it returns MobileRTCSDKError.SDKERR_SUCCESS. Otherwise, this function returns an error.

isDialOutSupported()

boolean us.zoom.sdk.PhoneHelper.isDialOutSupported

(

)

Determines whether it is able to dial out in the current meeting.

Returns

true if it is able to dial out. Otherwise, false.

isSupportPhoneFeature()

boolean us.zoom.sdk.PhoneHelper.isSupportPhoneFeature

(

)

Determines whether the user account supports calling out.

Returns

true if the client supports the phone call-out feature. Otherwise, false.

removeListener()

void us.zoom.sdk.PhoneHelper.removeListener

(

PhoneHelperListener

listener

)

Removes the phone helper listener.

Parameters

listener

The phone helper listener. See PhoneHelperListener.