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

A handle that represents a meeting indicator item and allows control of its visibility. More...

#include <ZoomSDKMeetingIndicatorController.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError- showIndicatorPanel:parentWindow:
 Shows the indicator panel window.
 
(ZoomSDKError- hideIndicatorPanel
 Hides the indicator panel window.
 

Properties

NSString * indicatorItemId
 The indicator item ID.
 
NSString * indicatorName
 The indicator name.
 
NSString * indicatorIcon
 The indicator icon URL.
 

Detailed Description

A handle that represents a meeting indicator item and allows control of its visibility.

Definition at line 33 of file ZoomSDKMeetingIndicatorController.h.

Method Documentation

◆ hideIndicatorPanel

- (ZoomSDKError) hideIndicatorPanel

Hides the indicator panel window.

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

◆ showIndicatorPanel:parentWindow:

- (ZoomSDKError) showIndicatorPanel: (NSPoint) point
parentWindow: (NSWindow *) parentWindow 

Shows the indicator panel window.

Parameters
pointThe original point to display indicator panel.
parentWindowShow the indicator panel's dynamic notice in this window.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

Property Documentation

◆ indicatorIcon

- (NSString*) indicatorIcon
readnonatomiccopy

The indicator icon URL.

Definition at line 46 of file ZoomSDKMeetingIndicatorController.h.

◆ indicatorItemId

- (NSString*) indicatorItemId
readnonatomiccopy

The indicator item ID.

Definition at line 38 of file ZoomSDKMeetingIndicatorController.h.

◆ indicatorName

- (NSString*) indicatorName
readnonatomiccopy

The indicator name.

Definition at line 42 of file ZoomSDKMeetingIndicatorController.h.