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

Container to manage all share elements. More...

#include <ZoomSDKShareContainer.h>

Inherits NSObject.

Instance Methods

(ZoomSDKError- createShareElement:
 Creates shared elements.
 
(ZoomSDKError- cleanShareElement:
 Clean shared elements.
 
(NSArray *_Nullable) - getShareElementArray
 Gets an array of shared elements.
 
(ZoomSDKShareElement *_Nullable) - getShareElementBySourceID:
 Gets an array of shared elements by user ID.
 

Protected Attributes

NSMutableArray * _elementArray
 
id< ZoomSDKShareContainerDelegate_delegate
 

Properties

id< ZoomSDKShareContainerDelegatedelegate
 Delegate for container-level share element callbacks.
 

Detailed Description

Container to manage all share elements.

Definition at line 92 of file ZoomSDKShareContainer.h.

Method Documentation

◆ cleanShareElement:

- (ZoomSDKError) cleanShareElement: (ZoomSDKShareElement *) element

Clean shared elements.

Parameters
elementThe pointer to ZoomSDKShareElement object.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ createShareElement:

- (ZoomSDKError) createShareElement: (ZoomSDKShareElement *_Nullable *_Nonnull) element

Creates shared elements.

Parameters
elementThe pointer to ZoomSDKShareElement object.
Returns
If the function succeeds, it returns ZoomSDKError_Success. Otherwise, this function returns an error.

◆ getShareElementArray

- (NSArray *_Nullable) getShareElementArray

Gets an array of shared elements.

Returns
If the function succeeds, it returns a NSArray containing all sharing elements. Otherwise, this function fails and returns nil.

◆ getShareElementBySourceID:

- (ZoomSDKShareElement *_Nullable) getShareElementBySourceID: (unsigned int) shareSourceID

Gets an array of shared elements by user ID.

Parameters
shareSourceIDThe specified source ID.
Returns
If the function succeeds, it returns an object of ZoomSDKShareElement. Otherwise, this function fails and returns nil.

Field Documentation

◆ _delegate

- (id<ZoomSDKShareContainerDelegate>) _delegate
protected

Definition at line 95 of file ZoomSDKShareContainer.h.

◆ _elementArray

- (NSMutableArray*) _elementArray
protected

Definition at line 94 of file ZoomSDKShareContainer.h.

Property Documentation

◆ delegate

- (id<ZoomSDKShareContainerDelegate>) delegate
readwritenonatomicassign

Delegate for container-level share element callbacks.

Definition at line 100 of file ZoomSDKShareContainer.h.