ZMVideoSDKUserHelper Class Reference

User control interface. More...

#include <ZMVideoSDKUserHelper.h>

Inherits NSObject.

Instance Methods
(BOOL)	- changeName:user:
	Changes a specific user's name.
(BOOL)	- makeHost:
	Assign a user as the session host.
(BOOL)	- makeManager:
	Assign a user as the session manager.
(ZMVideoSDKErrors)	- revokeManager:
	Revoke manager rights from a user.
(BOOL)	- removeUser:
	Removes user from session.
(BOOL)	- reclaimHost
	Reclaim host permission. Allow the user whose role_type = 1 to reclaim the host role.

Detailed Description

User control interface.

Definition at line 606 of file ZMVideoSDKUserHelper.h.

Method Documentation

changeName:user:

- (BOOL) changeName:		(NSString *)	name
user:		(ZMVideoSDKUser *)	user

Changes a specific user's name.

Parameters

name	The new user name.
user	User in the session.

Returns

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

makeHost:

- (BOOL) makeHost:

(ZMVideoSDKUser *)

user

Assign a user as the session host.

Parameters

user	User in the session.

Returns

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

makeManager:

- (BOOL) makeManager:

(ZMVideoSDKUser *)

user

Assign a user as the session manager.

Parameters

user	User in the session.

Returns

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

reclaimHost

- (BOOL) reclaimHost

Reclaim host permission. Allow the user whose role_type = 1 to reclaim the host role.

Returns

If the function succeeds, it returns YES. Otherwise, this function returns NO.

References reclaimHost.

Referenced by reclaimHost.

removeUser:

- (BOOL) removeUser:

(ZMVideoSDKUser *)

user

Removes user from session.

Parameters

user	User in the session.

Returns

If the function succeeds, it returns YES. Otherwise, this function returns NO.

revokeManager:

- (ZMVideoSDKErrors) revokeManager:

(ZMVideoSDKUser *)

user

Revoke manager rights from a user.

Parameters

user	User in the session.

Returns

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