Zoom SDK meeting remote support controller. More...

#include <ZoomSDKMeetingRemoteSupportController.h>

Inherits NSObject.

Instance Methods
(BOOL)	- isSupportRemoteSupport
	Query Whether the meeting supports remote support.

(BOOL)	- canRequestRemoteSupport
	Whether if the current user can request remote support.

(NSArray *)	- getRemoteSupportUserList
	Gets the list of users'IDs that can be supported remotely.

(ZoomSDKError)	- requestRemoteSupport:remoteSupportType:
	Sends the request of remote support to the specified user.

(ZoomSDKError)	- stopRemoteSupport
	Stops the remote support to the specified user.

(ZoomSDKError)	- canSelectRemoteSupportScreen
	Whether if the current user is able to select remote support screen.

(ZoomSDKError)	- selectRemoteSupportScreen:
	Select the monitor of remote support to the specified user.

Properties
id< ZoomSDKMeetingRemoteSupportControllerDelegate >	delegate
	The delegate object to receive remote support events.

Detailed Description

Zoom SDK meeting remote support controller.

This class provides APIs to request, grant, and manage remote support sessions during meetings.

Definition at line 100 of file ZoomSDKMeetingRemoteSupportController.h.

Method Documentation

◆ canRequestRemoteSupport

- (BOOL) canRequestRemoteSupport

Whether if the current user can request remote support.

Returns: YES means can request remote support. Otherwise, NO.

◆ canSelectRemoteSupportScreen

- (ZoomSDKError) canSelectRemoteSupportScreen

Whether if the current user is able to select remote support screen.

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

◆ getRemoteSupportUserList

- (NSArray *) getRemoteSupportUserList

Gets the list of users'IDs that can be supported remotely.

Returns: If the function succeeds, it returns a pointer to the array object. Otherwise, this function fails and returns nil.

◆ isSupportRemoteSupport

- (BOOL) isSupportRemoteSupport

Query Whether the meeting supports remote support.

Returns: YES means supported, Otherwise, NO.

◆ requestRemoteSupport:remoteSupportType:

- (ZoomSDKError) requestRemoteSupport:		(unsigned int)	userId
remoteSupportType:		(ZoomSDKRemoteSupportType)	type

Sends the request of remote support to the specified user.

Parameters

userId	Specify the user ID that you want to send the request.
type	Specify category for remote support.

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

◆ selectRemoteSupportScreen:

- (ZoomSDKError) selectRemoteSupportScreen: (int) screenIndex

Select the monitor of remote support to the specified user.

Parameters

screenIndex Specify the monitor index that you want to control.

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

◆ stopRemoteSupport

- (ZoomSDKError) stopRemoteSupport

Stops the remote support to the specified user.

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

Property Documentation

◆ delegate

- (id<ZoomSDKMeetingRemoteSupportControllerDelegate>) delegate

readwritenonatomicassign

The delegate object to receive remote support events.

Definition at line 105 of file ZoomSDKMeetingRemoteSupportController.h.

Instance Methods

Properties