Mac SDK
Instance Methods | Protected Attributes | Properties | List of all members
ZoomSDKRemoteControllerHelper Class Reference
Inheritance diagram for ZoomSDKRemoteControllerHelper:

Instance Methods

(ZoomSDKError) - canRequestRemoteControl:
 Determine if it is able for the current user to request to control others remotely. More...
 
(ZoomSDKError) - haveRemoteControlPrivilege:
 Determine if user has the privilege to control the specified user remotely. More...
 
(ZoomSDKError) - isInRemoteControlling:
 Determine if the current user is controlling the specified user remotely. More...
 
(ZoomSDKError) - startRemoteControl:
 Start controlling remotely the computer of specified user. More...
 
(ZoomSDKError) - stopRemoteControl:
 Stop controlling remotely. More...
 
(ZoomSDKError) - requestRemoteControl:
 Request to control remotely the specified user. More...
 
(ZoomSDKError) - giveUpRemoteControl:
 Give up controlling remotely the specified user. More...
 
(ZoomSDKError) - giveRemoteControlPrivilegeTo:
 Give the remote control privilege to the specified user. More...
 
(ZoomSDKError) - declineRemoteControlRequest:
 Refuse the request to remote control from the specified user. More...
 
(ZoomSDKError) - revokeRemoteControl
 Get back the authority of remote control. More...
 
(ZoomSDKError) - getCurrentRemoteController:
 Get the identity of current controller. More...
 
(ZoomSDKError) - sendRemoteControlEvent:ShareView:
 Send remote control action. More...
 

Protected Attributes

id< ZoomSDKRemoteControllerDelegate_delegate
 

Properties

id< ZoomSDKRemoteControllerDelegatedelegate
 

Method Documentation

◆ canRequestRemoteControl:

- (ZoomSDKError) canRequestRemoteControl: (unsigned int)  userid

Determine if it is able for the current user to request to control others remotely.

Parameters
useridThe ID of user to be controlled remotely.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ declineRemoteControlRequest:

- (ZoomSDKError) declineRemoteControlRequest: (unsigned int)  userid

Refuse the request to remote control from the specified user.

Parameters
useridThe ID of demander.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ getCurrentRemoteController:

- (ZoomSDKError) getCurrentRemoteController: (unsigned int *)  userid

Get the identity of current controller.

Parameters
useridThe pointer to unsigned int. If the function calls successfully, it will return the user id of current remote controller.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ giveRemoteControlPrivilegeTo:

- (ZoomSDKError) giveRemoteControlPrivilegeTo: (unsigned int)  userid

Give the remote control privilege to the specified user.

Parameters
useridThe ID of user that you ask to control yourself remotely.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ giveUpRemoteControl:

- (ZoomSDKError) giveUpRemoteControl: (unsigned int)  userid

Give up controlling remotely the specified user.

Parameters
useridThe ID of user having been controlled.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ haveRemoteControlPrivilege:

- (ZoomSDKError) haveRemoteControlPrivilege: (unsigned int)  userid

Determine if user has the privilege to control the specified user remotely.

Parameters
useridThe ID of user to be checked.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ isInRemoteControlling:

- (ZoomSDKError) isInRemoteControlling: (unsigned int)  userid

Determine if the current user is controlling the specified user remotely.

Parameters
useridThe ID of user to be checked.
Returns
If the current user is controlling, it will return ZoomSDKError_Success, otherwise not.

◆ requestRemoteControl:

- (ZoomSDKError) requestRemoteControl: (unsigned int)  userid

Request to control remotely the specified user.

Parameters
useridThe ID of user to be controlled.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ revokeRemoteControl

- (ZoomSDKError) revokeRemoteControl

Get back the authority of remote control.

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

◆ sendRemoteControlEvent:ShareView:

- (ZoomSDKError) sendRemoteControlEvent: (NSEvent *)  theEvent
ShareView: (NSView *)  shareView 

Send remote control action.

Parameters
theEventThe mouse or keyboard event.
shareViewThe view that you want to control remotely.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ startRemoteControl:

- (ZoomSDKError) startRemoteControl: (unsigned int)  userid

Start controlling remotely the computer of specified user.

Parameters
useridThe ID of user to be controlled remotely.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

◆ stopRemoteControl:

- (ZoomSDKError) stopRemoteControl: (unsigned int)  userid

Stop controlling remotely.

Parameters
useridThe ID of user who is controlled remotely by the current user.
Returns
If the function succeeds, it will return ZoomSDKError_Success, otherwise failed.

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