ZoomVideoSDKUserHelper Class Reference

User control interface. More...

#include <ZoomVideoSDKUserHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- changeName:withUser:
	Change a specific user's name.
(BOOL)	- makeHost:
	Assign a user as the session host.
(BOOL)	- makeManager:
	Assign a user as the session manager.
(BOOL)	- revokeManager:
	Revoke manager rights from a user.
(BOOL)	- removeUser:
	Remove user from session.
(BOOL)	- reclaimHost
	Reclaim host permission.

Detailed Description

User control interface.

Definition at line 16 of file ZoomVideoSDKUserHelper.h.

Method Documentation

changeName:withUser:

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

Change a specific user's name.

Parameters

inputName	user new name
changeUser	user in the session

Returns

YES indicates that name change is success. Otherwise, this function returns NO.

makeHost:

- (BOOL) makeHost:

(ZoomVideoSDKUser *_Nullable)

user

Assign a user as the session host.

Parameters

user	user in the session

Returns

YES indicates that the user is now the host. Otherwise, this function returns NO.

Warning

only session host can run this function, and userId should not be myself.

makeManager:

- (BOOL) makeManager:

(ZoomVideoSDKUser *_Nullable)

user

Assign a user as the session manager.

Parameters

user	user in the session

Returns

YES indicates that the user is now the manager. Otherwise, this function returns NO.

Warning

only session host can run this function, and userId should not be myself.

reclaimHost

- (BOOL) reclaimHost

Reclaim host permission.

Returns

YES indicates that the function succeeds. Otherwise, this function returns NO.

removeUser:

- (BOOL) removeUser:

(ZoomVideoSDKUser *_Nullable)

user

Remove user from session.

Parameters

user	user in the session

Returns

YES indicates that the function succeeds. Otherwise, this function returns NO.

Warning

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

revokeManager:

- (BOOL) revokeManager:

(ZoomVideoSDKUser *_Nullable)

user

Revoke manager rights from a user.

Parameters

user	user in the session

Returns

YES indicates that the user no longer has manager rights. Otherwise, this function returns NO.

Warning

only session host can run this function, and userId should not be myself.