ZoomVideoSDKUserHelper Class Reference

User control interface. More...

#include <ZoomVideoSDKUserHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- changeName:withUser:
	Changes a specific user's name.
(BOOL)	- makeHost:
	Assigns a user as the session host.
(BOOL)	- makeManager:
	Assigns a user as the session manager.
(ZoomVideoSDKError)	- revokeManager:
	Revokes manager rights from a user.
(BOOL)	- removeUser:
	Removes user from session.
(BOOL)	- reclaimHost
	Reclaims host permission.

Detailed Description

User control interface.

Definition at line 13 of file ZoomVideoSDKUserHelper.h.

Method Documentation

changeName:withUser:

- (BOOL) changeName:		(NSString *_Nullable)	inputName
withUser:		(ZoomVideoSDKUser *_Nullable)	changeUser

Changes a specific user's name.

Parameters

inputName	The user's new name.
changeUser	The user in the session.

Returns

YES if the name change succeeds. Otherwise, NO.

makeHost:

- (BOOL) makeHost:

(ZoomVideoSDKUser *_Nullable)

user

Assigns a user as the session host.

Parameters

user	The user in the session.

Returns

YES if the user is now the host. Otherwise, NO.

Warning

Only session host can run this function, and user ID should not be myself.

makeManager:

- (BOOL) makeManager:

(ZoomVideoSDKUser *_Nullable)

user

Assigns a user as the session manager.

Parameters

user	The user in the session.

Returns

YES if the user is now the manager. Otherwise, NO.

Warning

Only session host can run this function, and user ID should not be myself.

reclaimHost

- (BOOL) reclaimHost

Reclaims host permission.

Returns

YES if the function succeeds. Otherwise, NO.

References reclaimHost.

Referenced by reclaimHost.

removeUser:

- (BOOL) removeUser:

(ZoomVideoSDKUser *_Nullable)

user

Removes user from session.

Parameters

user	The user in the session.

Returns

YES if the function succeeds. Otherwise, NO.

Warning

The method is available only for the host, and the host cannot remove himself.

revokeManager:

- (ZoomVideoSDKError) revokeManager:

(ZoomVideoSDKUser *_Nullable)

user

Revokes manager rights from a user.

Parameters

user	The user in the session.

Returns

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

Warning

Only session host can run this function, and user ID should not be myself.