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

Provides helper APIs for H.323 device management in Zoom meetings. More...

#include <ZoomSDKH323Helper.h>

Inherits NSObject.

Instance Methods

(NSArray *) - getH323DeviceAddress
 Gets the H.323 device address of the current meeting.
(NSString *) - getH323Password
 Gets the H.323 device password of the current meeting.
(ZoomSDKError- sendMeetingPairingCode:meetingNum:
 Sends meeting paring code.
(ZoomSDKError- calloutH323Device:
 Calls out a H.323 device.
(NSArray *_Nullable) - getRoomH323DeviceArray
 Gets the list of H.323 devices for the current meeting.
(ZoomSDKError- cancelCallOutH323
 Cancels the latest operation of calling out H.323 device.
(ZoomSDKError- inviteToMeetingByDefaultMail
 Invites others to meeting by default email.
(ZoomSDKError- inviteToMeetingByGmail
 Invites others to meeting by gmail.
(ZoomSDKError- inviteToMeetingByYahooMail
 Invites others to meeting by Yahoo mail.

Protected Attributes

id< ZoomSDKH323HelperDelegate_delegate

Properties

id< ZoomSDKH323HelperDelegatedelegate
 Sets or get the delegate to receive H.323 related events.

Detailed Description

Provides helper APIs for H.323 device management in Zoom meetings.

Definition at line 71 of file ZoomSDKH323Helper.h.

Method Documentation

◆ calloutH323Device:

- (ZoomSDKError) calloutH323Device: (H323DeviceInfo *) deviceInfo

Calls out a H.323 device.

Parameters
deviceInfoThe information of H.323 device that you want to call out.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ cancelCallOutH323

- (ZoomSDKError) cancelCallOutH323

Cancels the latest operation of calling out H.323 device.

Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References cancelCallOutH323.

Referenced by cancelCallOutH323.

◆ getH323DeviceAddress

- (NSArray *) getH323DeviceAddress

Gets the H.323 device address of the current meeting.

Returns
If the function succeeds, it returns the address. Otherwise, this function fails and returns nil.

References getH323DeviceAddress.

Referenced by getH323DeviceAddress.

◆ getH323Password

- (NSString *) getH323Password

Gets the H.323 device password of the current meeting.

Returns
If the function succeeds, it returns the password. Otherwise, this function fails and returns nil.

References getH323Password.

Referenced by getH323Password.

◆ getRoomH323DeviceArray

- (NSArray *_Nullable) getRoomH323DeviceArray

Gets the list of H.323 devices for the current meeting.

Returns
If the function succeeds, it returns the list. Otherwise, this function fails and returns nil.

References getRoomH323DeviceArray.

Referenced by getRoomH323DeviceArray.

◆ inviteToMeetingByDefaultMail

- (ZoomSDKError) inviteToMeetingByDefaultMail

Invites others to meeting by default email.

Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References inviteToMeetingByDefaultMail.

Referenced by inviteToMeetingByDefaultMail.

◆ inviteToMeetingByGmail

- (ZoomSDKError) inviteToMeetingByGmail

Invites others to meeting by gmail.

Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References inviteToMeetingByGmail.

Referenced by inviteToMeetingByGmail.

◆ inviteToMeetingByYahooMail

- (ZoomSDKError) inviteToMeetingByYahooMail

Invites others to meeting by Yahoo mail.

Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

References inviteToMeetingByYahooMail.

Referenced by inviteToMeetingByYahooMail.

◆ sendMeetingPairingCode:meetingNum:

- (ZoomSDKError) sendMeetingPairingCode: (NSString *) pairCode
meetingNum: (long long) meetingNum 

Sends meeting paring code.

Parameters
pairCodePairing code of the specified meeting.
meetingNumMeeting number for pairing.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Field Documentation

◆ _delegate

- (id<ZoomSDKH323HelperDelegate>) _delegate
protected

Definition at line 73 of file ZoomSDKH323Helper.h.

Property Documentation

◆ delegate

- (id<ZoomSDKH323HelperDelegate>) delegate
readwritenonatomicassign

Sets or get the delegate to receive H.323 related events.

Definition at line 78 of file ZoomSDKH323Helper.h.