Inheritance diagram for ZoomSDKPremeetingService:

Instance Methods
(ZoomSDKScheduleMeetingItem *)	- createScheduleMeetingItem
	Create an object of ZoomSDKScheduleMeetingItem. More...

(ZoomSDKScheduleMeetingItem *)	- createEditMeetingItemWithMeetingID:
	Create an object of ZoomSDKScheduleMeetingItem for edit meeting. More...

(ZoomSDKError)	- destoryScheduleMeetingItem:
	Destroy the object of ZoomSDKScheduleMeetingItem. More...

(ZoomSDKError)	- scheduleMeeting:
	Schedule a ZOOM meeting with the items you created. More...

(ZoomSDKError)	- editMeeting:MeetingUniqueID:
	Edit the specified meeting. More...

(ZoomSDKError)	- deleteMeeting:
	Delete the specified meeting. More...

(ZoomSDKError)	- listMeeting
	List all meetings. More...

(ZoomSDKMeetingItem *)	- getMeetingItem:
	Get meeting item information of the specified meeting. More...

(ZoomSDKError)	- showScheduleEditMeetingWindow:Window:MeetingID:
	Display the Zoom native window of schedule or edit meeting. More...

(ZoomSDKOutlookPluginHelper *)	- getOutlookPluginHelper
	Get Outlook plugin integration helper object. More...

(void)	- enableForceAutoStartMyVideoWhenJoinMeeting:
	Turn on the video of participant when he joins the meeting. More...

(void)	- enableForceAutoStopMyVideoWhenJoinMeeting:
	Turn off the video of participant when he joins the meeting. More...

(void)	- disableAutoShowSelectJoinAudioDlgWhenJoinMeeting:
	Set the visibility of the dialog SELECT JOIN AUDIO when joining meeting. Default: enabled. More...

(BOOL)	- isUserForceStartMyVideoWhenInMeeting
	Query if the current user is forced to enable video when joining the meeting. More...

(BOOL)	- isUserForceStopMyVideoWhenInMeeting
	Query if the current user is forced to turn off video when joining the meeting. More...

(BOOL)	- isUserForceDisableShowJoinAudioDlgWhenInMeeting
	Query if the feature that hide the dialog of joining meeting with audio in the meeting is enabled. More...

(ZoomSDKDirectShareHelper *)	- getDirectShareHelper
	Get the helper to share directly. More...

(void)	- hideScheduleComponent:hide:
	Hide schedule window components. More...

(BOOL)	- isDisabledPMI
	Determine if the personal meeting ID is diabled or not. More...

Protected Attributes
id< ZoomSDKPremeetingServiceDelegate >	_delegate

ZoomSDKOutlookPluginHelper *	_outlookPluginHelper

ZoomSDKDirectShareHelper *	_directShareHelper

Properties
id< ZoomSDKPremeetingServiceDelegate >	delegate

Method Documentation

◆ createEditMeetingItemWithMeetingID:

- (ZoomSDKScheduleMeetingItem*) createEditMeetingItemWithMeetingID: (long long) meetingUniqueID

Create an object of ZoomSDKScheduleMeetingItem for edit meeting.

Parameters

meetingUniqueID The unique ID of meeting to be edited.

Returns: If the function succeeds, it will return the object of ZoomSDKScheduleMeetingItem.

◆ createScheduleMeetingItem

- (ZoomSDKScheduleMeetingItem*) createScheduleMeetingItem

Create an object of ZoomSDKScheduleMeetingItem.

Returns: If the function succeeds, it will return the object of ZoomSDKScheduleMeetingItem.

◆ deleteMeeting:

- (ZoomSDKError) deleteMeeting: (long long) meetingUniqueID

Delete the specified meeting.

Parameters

meetingUniqueID The specified meeting unique ID.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ destoryScheduleMeetingItem:

- (ZoomSDKError) destoryScheduleMeetingItem: (ZoomSDKScheduleMeetingItem *) meetingItem

Destroy the object of ZoomSDKScheduleMeetingItem.

Parameters

meetingItem The object of ZoomSDKScheduleMeetingItem that you created by Api of createScheduleMeetingItem.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ disableAutoShowSelectJoinAudioDlgWhenJoinMeeting:

- (void) disableAutoShowSelectJoinAudioDlgWhenJoinMeeting: (BOOL) disable

Set the visibility of the dialog SELECT JOIN AUDIO when joining meeting. Default: enabled.

Parameters

disable YES means disabled, otherwise not.

◆ editMeeting:MeetingUniqueID:

- (ZoomSDKError) editMeeting:	(ZoomSDKScheduleMeetingItem *)	meetingItem
MeetingUniqueID:	(long long)	meetingUniqueID

Edit the specified meeting.

Parameters

meetingItem	The object of ZoomSDKScheduleMeetingItem that you created by Api of createEditMeetingItemWithMeetingID.
meetingUniqueID	The unique ID of meeting to be edited.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ enableForceAutoStartMyVideoWhenJoinMeeting:

- (void) enableForceAutoStartMyVideoWhenJoinMeeting: (BOOL) enable

Turn on the video of participant when he joins the meeting.

Parameters

enable YES means enabled, otherwise not.

◆ enableForceAutoStopMyVideoWhenJoinMeeting:

- (void) enableForceAutoStopMyVideoWhenJoinMeeting: (BOOL) enable

Turn off the video of participant when he joins the meeting.

Parameters

enable YES means enabled, otherwise not.

◆ getDirectShareHelper

- (ZoomSDKDirectShareHelper*) getDirectShareHelper

Get the helper to share directly.

Returns: If the function succeeds, it will return a ZoomSDKDirectShareHelper object.

◆ getMeetingItem:

- (ZoomSDKMeetingItem*) getMeetingItem: (long long) meetingUniqueID

Get meeting item information of the specified meeting.

Parameters

meetingUniqueID The unique ID of the specified meeting.

Returns: If the function succeeds, it will return a ZoomSDKMeetingItem object. Otherwise failed.

◆ getOutlookPluginHelper

- (ZoomSDKOutlookPluginHelper*) getOutlookPluginHelper

Get Outlook plugin integration helper object.

Returns: If the function succeeds, it will return a ZoomSDKOutlookPluginHelper object. Otherwise failed.

◆ hideScheduleComponent:hide:

- (void) hideScheduleComponent:	(ScheduleComponent)	component
hide:	(BOOL)	hide

Hide schedule window components.

Parameters

component	An enumeration of components for schedule window.
hide	YES means to hide, NO to show.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ isDisabledPMI

- (BOOL) isDisabledPMI

Determine if the personal meeting ID is diabled or not.

Returns: YES means personal meeting ID is disabled, otherwise not.

◆ isUserForceDisableShowJoinAudioDlgWhenInMeeting

- (BOOL) isUserForceDisableShowJoinAudioDlgWhenInMeeting

Query if the feature that hide the dialog of joining meeting with audio in the meeting is enabled.

Returns: YES means hiding the dialog, otherwise not.

◆ isUserForceStartMyVideoWhenInMeeting

- (BOOL) isUserForceStartMyVideoWhenInMeeting

Query if the current user is forced to enable video when joining the meeting.

Returns: YES means to force the current user to enable video, otherwise not.

◆ isUserForceStopMyVideoWhenInMeeting

- (BOOL) isUserForceStopMyVideoWhenInMeeting

Query if the current user is forced to turn off video when joining the meeting.

Returns: YES means that the current user's video is forced to stop, otherwise not.

◆ listMeeting

- (ZoomSDKError) listMeeting

List all meetings.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ scheduleMeeting:

- (ZoomSDKError) scheduleMeeting: (ZoomSDKScheduleMeetingItem *) meetingItem

Schedule a ZOOM meeting with the items you created.

Parameters

meetingItem The object of ZoomSDKScheduleMeetingItem that you created by Api of createScheduleMeetingItem.

Returns: If the function succeeds, it will return ZoomSDKError_Success. Otherwise failed.

◆ showScheduleEditMeetingWindow:Window:MeetingID:

- (ZoomSDKError) showScheduleEditMeetingWindow:	(BOOL)	show
Window:	(NSWindow **)	window
MeetingID:	(long long)	meetingUniqueID

Display the Zoom native window of schedule or edit meeting.

Note: Webinar or meeting using PMI are not supported.

Parameters

show	One(1) means display the window, zero(0) not.
window	If the function succeeds, it will return a window object to schedule/edit meeting.
meetingUniqueID	The ID of the specified meeting to be edited.

Returns: If the function succeeds, it will return a ZoomSDKError_Success. Otherwise failed.

Property Documentation

◆ delegate

- (id<ZoomSDKPremeetingServiceDelegate>) delegate

readwritenonatomicassign

It provides support for premeeting event once logged in with working email or with SSO.

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

ZoomSDKPremeetingService.h

Instance Methods

Protected Attributes

Properties

Method Documentation

◆ createEditMeetingItemWithMeetingID:

◆ createScheduleMeetingItem

◆ deleteMeeting:

◆ destoryScheduleMeetingItem:

◆ disableAutoShowSelectJoinAudioDlgWhenJoinMeeting:

◆ editMeeting:MeetingUniqueID:

◆ enableForceAutoStartMyVideoWhenJoinMeeting:

◆ enableForceAutoStopMyVideoWhenJoinMeeting:

◆ getDirectShareHelper

◆ getMeetingItem:

◆ getOutlookPluginHelper

◆ hideScheduleComponent:hide:

◆ isDisabledPMI

◆ isUserForceDisableShowJoinAudioDlgWhenInMeeting

◆ isUserForceStartMyVideoWhenInMeeting

◆ isUserForceStopMyVideoWhenInMeeting

◆ listMeeting

◆ scheduleMeeting:

◆ showScheduleEditMeetingWindow:Window:MeetingID:

Property Documentation

◆ delegate