Meeting SDK for macOS API Reference
Loading...
Searching...
No Matches
ZoomSDKPhoneHelper Class Reference

#include <ZoomSDKPhoneHelper.h>

Inherits NSObject.

Instance Methods

(BOOL) - isSupportPhone
 Query if it is able to dial out in the current meeting.
 
(BOOL) - isDialoutSupported
 Query if it is able to dial out in the current meeting.
 
(NSArray *) - getSupportCountryInfo
 Get the list of the countries which support calling out.
 
(ZoomSDKError- inviteCalloutUser:PhoneNumber:CountryCode:
 Invite the specified user to join the meeting by calling out.
 
(ZoomSDKError- cancelCalloutUser
 Cancel the invitation that is being called out by phone.
 
(PhoneStatus- getInviteCalloutUserStatus
 Get the invited user’s status by calling out.
 
(ZoomSDKError- callMe:CountryCode:
 Invite myself to join audio to the meeting by phone.
 
(ZoomSDKError- hangUp
 Cancel the current CALL ME action.
 
(PhoneStatus- getCallMeStatus
 Get the status of myself by CALL ME.
 
(unsigned int) - getCallInParticipantID
 Get the ID of the participant who joins the meeting by calling in.
 
(NSArray *_Nullable) - getCallInNumberInfo
 Get the list of call-in numbers supported by the meeting.
 

Protected Attributes

id< ZoomSDKPhoneHelperDelegate_delegate
 
PhoneStatus _callMeStatus
 

Properties

id< ZoomSDKPhoneHelperDelegatedelegate
 

Detailed Description

Definition at line 72 of file ZoomSDKPhoneHelper.h.

Method Documentation

◆ callMe:CountryCode:

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

Invite myself to join audio to the meeting by phone.

Parameters
numberThe device’s phone number.
countryCodeThe 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 *_Nullable) getCallInNumberInfo

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

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

◆ getCallInParticipantID

- (unsigned int) getCallInParticipantID

Get the ID of the participant who joins the 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 invited user’s status 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 calling 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
userNameThe specified user’s in-meeting screen name.
numberThe specified user’s phone number.
countryCodeThe specified user’s country code must be in the support list.
Returns
If the function succeeds, the return value is ZoomSDKError_Success. Otherwise failed.

◆ isDialoutSupported

- (BOOL) isDialoutSupported

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

Returns
YES means able. Otherwise return NO.

◆ isSupportPhone

- (BOOL) isSupportPhone

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

Returns
YES means able to dial out. Otherwise return NO.

Field Documentation

◆ _callMeStatus

- (PhoneStatus) _callMeStatus
protected

Definition at line 75 of file ZoomSDKPhoneHelper.h.

◆ _delegate

- (id<ZoomSDKPhoneHelperDelegate>) _delegate
protected

Definition at line 74 of file ZoomSDKPhoneHelper.h.

Property Documentation

◆ delegate

- (id<ZoomSDKPhoneHelperDelegate>) delegate
readwritenonatomicassign

Definition at line 77 of file ZoomSDKPhoneHelper.h.