ZMVideoSDKUserHelper Class Reference

User control interface. See ZMVideoSDK#GetUserHelper(). More...

Public Member Functions
bool	ChangeName (string name, ZMVideoSDKUser zmVideoSDKUser)
	Change a specific user's name.
bool	MakeHost (ZMVideoSDKUser zmVideoSDKUser)
	Assign a user as the session host.
bool	MakeManager (ZMVideoSDKUser zmVideoSDKUser)
	Assign a user as the session manager.
bool	RevokeManager (ZMVideoSDKUser zmVideoSDKUser)
	Revoke manager rights from a user.
bool	RemoveUser (ZMVideoSDKUser zmVideoSDKUser)
	Remove user from session.

Detailed Description

User control interface. See ZMVideoSDK#GetUserHelper().

Definition at line 6 of file ZMVideoSDKUserHelper.cs.

Member Function Documentation

ChangeName()

bool ZMVideoSDKUserHelper.ChangeName ( string  name, ZMVideoSDKUser  zmVideoSDKUser  )

inline

Change a specific user's name.

Parameters

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

Returns

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

Definition at line 40 of file ZMVideoSDKUserHelper.cs.

    {
        return _videoSDKUserHelper.ChangeName(name, zmVideoSDKUser);
    }

MakeHost()

bool ZMVideoSDKUserHelper.MakeHost ( ZMVideoSDKUser  zmVideoSDKUser )

inline

Assign a user as the session host.

Parameters

zmVideoSDKUser

User in the session

Returns

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

Definition at line 50 of file ZMVideoSDKUserHelper.cs.

    {
        return _videoSDKUserHelper.MakeHost(zmVideoSDKUser);
    }

MakeManager()

bool ZMVideoSDKUserHelper.MakeManager ( ZMVideoSDKUser  zmVideoSDKUser )

inline

Assign a user as the session manager.

Parameters

zmVideoSDKUser

User in the session.

Returns

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

Definition at line 60 of file ZMVideoSDKUserHelper.cs.

    {
        return _videoSDKUserHelper.MakeManager(zmVideoSDKUser);
    }

RemoveUser()

bool ZMVideoSDKUserHelper.RemoveUser ( ZMVideoSDKUser  zmVideoSDKUser )

inline

Remove user from session.

Parameters

zmVideoSDKUser

User in the session.

Returns

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

Definition at line 80 of file ZMVideoSDKUserHelper.cs.

    {
        return _videoSDKUserHelper.RemoveUser(zmVideoSDKUser);
    }

RevokeManager()

bool ZMVideoSDKUserHelper.RevokeManager ( ZMVideoSDKUser  zmVideoSDKUser )

inline

Revoke manager rights from a user.

Parameters

zmVideoSDKUser

User in the session.

Returns

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

Definition at line 70 of file ZMVideoSDKUserHelper.cs.

    {
        return _videoSDKUserHelper.RevokeManager(zmVideoSDKUser);
    }