ZoomSDKPhoneHelper Class Reference

Inheritance diagram for ZoomSDKPhoneHelper:

Instance Methods
(BOOL)	- isSupportPhone
	Determine if the user account supports to call out. More...
(NSArray *)	- getSupportCountryInfo
	Get the list of the countries which support to call out. More...
(ZoomSDKError)	- inviteCalloutUser:PhoneNumber:CountryCode:
	Invite the specified user to join the meeting by calling out. More...
(ZoomSDKError)	- cancelCalloutUser
	Cancel the invitation that is being called out by phone. More...
(PhoneStatus)	- getInviteCalloutUserStatus
	Get the status of the invited user by calling out. More...
(ZoomSDKError)	- callMe:CountryCode:
	Invite myself to join audio to the meeting by phone. More...
(ZoomSDKError)	- hangUp
	Cancel the current CALL ME action. More...
(PhoneStatus)	- getCallMeStatus
	Get the status of myself by CALL ME. More...
(unsigned int)	- getCallInParticipantID
	Get my participant ID to join meeting by calling in. More...
(NSArray *)	- getCallInNumberInfo
	Get the information of number that user can call in to join meeting. More...

Protected Attributes
id< ZoomSDKPhoneHelperDelegate >	_delegate
PhoneStatus	_callMeStatus

Properties
id< ZoomSDKPhoneHelperDelegate >	delegate

Method Documentation

callMe:CountryCode:

- (ZoomSDKError) callMe:		(NSString *)	number
CountryCode:		(NSString *)	countryCode

Invite myself to join audio to the meeting by phone.

Parameters

number	The phone number of the device.
countryCode	The country code.

Returns

If the function succeeds, it will return ZoomSDKError_success, otherwise failed.

cancelCalloutUser

- (ZoomSDKError) cancelCalloutUser

Cancel the invitation that is being called out by phone.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

getCallInNumberInfo

- (NSArray*) getCallInNumberInfo

Get the information of number that user can call in to join meeting.

Returns

If the function succeeds, it will return an array of ZoomSDKCallInPhoneNumInfo objects.

getCallInParticipantID

- (unsigned int) getCallInParticipantID

Get my participant ID to join meeting by calling in.

Returns

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

getCallMeStatus

- (PhoneStatus) getCallMeStatus

Get the status of myself by CALL ME.

Returns

If the function succeeds, the return value is the process of the invitation by CALL ME.

getInviteCalloutUserStatus

- (PhoneStatus) getInviteCalloutUserStatus

Get the status of the invited user by calling out.

Returns

If the function succeeds, the return value is the current callout process.

getSupportCountryInfo

- (NSArray*) getSupportCountryInfo

Get the list of the countries which support to call out.

Returns

An NSArray contains ZoomSDKPhoneSupportCountryInfoList objects of all countries supporting to call out. Otherwise nil.

hangUp

- (ZoomSDKError) hangUp

Cancel the current CALL ME action.

Returns

If the function succeeds, it will return ZoomSDKError_success, otherwise failed.

inviteCalloutUser:PhoneNumber:CountryCode:

- (ZoomSDKError) inviteCalloutUser:		(NSString *)	userName
PhoneNumber:		(NSString *)	number
CountryCode:		(NSString *)	countryCode

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

Parameters

userName	User name to be displayed in the meeting.
number	The phone number of destination.
countryCode	The country code of the specified user must be in the support list.

Returns

If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

isSupportPhone

- (BOOL) isSupportPhone

Determine if the user account supports to call out.

Returns

YES means that client supports the feature of phone callout, otherwise not.

---

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

• ZoomSDKPhoneHelper.h