IZoomVideoSDKUserHelper Class Reference

User helper interface. More...

#include <zoom_video_sdk_user_helper_interface.h>

Public Member Functions
virtual bool	changeName (const zchar_t *name, IZoomVideoSDKUser *pUser)=0
	Change a specific user's name.
virtual bool	makeHost (IZoomVideoSDKUser *pUser)=0
	Assign a user as the session host.
virtual bool	makeManager (IZoomVideoSDKUser *pUser)=0
	Assign a user as the session manager.
virtual bool	revokeManager (IZoomVideoSDKUser *pUser)=0
	Revoke manager rights from a user.
virtual bool	removeUser (IZoomVideoSDKUser *pUser)=0
	Remove user from session.
virtual bool	reclaimHost ()=0
	Reclaim host permission.

Detailed Description

User helper interface.

Definition at line 440 of file zoom_video_sdk_user_helper_interface.h.

Member Function Documentation

changeName()

virtual bool IZoomVideoSDKUserHelper::changeName ( const zchar_t * name, IZoomVideoSDKUser * pUser )

pure virtual

Change a specific user's name.

Parameters

name	The new name of the user object.
pUser	User in the session

Returns

True indicates that name change is success. Otherwise, this function returns false.

makeHost()

virtual bool IZoomVideoSDKUserHelper::makeHost ( IZoomVideoSDKUser * pUser )

pure virtual

Assign a user as the session host.

Parameters

pUser

User in the session

Returns

True indicates that the user is now the host. Otherwise, this function returns false.

makeManager()

virtual bool IZoomVideoSDKUserHelper::makeManager ( IZoomVideoSDKUser * pUser )

pure virtual

Assign a user as the session manager.

Parameters

pUser

User in the session.

Returns

True indicates that the user is now the manager. Otherwise, this function returns false.

reclaimHost()

virtual bool IZoomVideoSDKUserHelper::reclaimHost ( )

pure virtual

Reclaim host permission.

Returns

True indicates that reclaim host is success. Otherwise, this function returns false.

removeUser()

virtual bool IZoomVideoSDKUserHelper::removeUser ( IZoomVideoSDKUser * pUser )

pure virtual

Remove user from session.

Parameters

pUser

User in the session.

Returns

True indicates that remove user is success. Otherwise, this function returns false.

revokeManager()

virtual bool IZoomVideoSDKUserHelper::revokeManager ( IZoomVideoSDKUser * pUser )

pure virtual

Revoke manager rights from a user.

Parameters

pUser

User in the session.

Returns

True indicates that the user no longer has manager rights. Otherwise, this function returns false.