io.openvidu.java.client

Enum OpenViduRole

java.lang.Object

java.lang.Enum<OpenViduRole>

io.openvidu.java.client.OpenViduRole

All Implemented Interfaces:

Serializable, Comparable<OpenViduRole>

public enum OpenViduRole
extends Enum<OpenViduRole>

See TokenOptions.Builder.role(OpenViduRole)

Enum Constant Summary

Enum Constants

Enum Constant and Description
MODERATOR SUBSCRIBER + PUBLISHER permissions + can force the unpublishing or disconnection over a third-party Stream or Connection (call Session.forceUnpublish() and Session.forceDisconnect())
PUBLISHER SUBSCRIBER permissions + can publish their own Streams (call Session.publish())
SUBSCRIBER Can subscribe to published Streams of other users

Method Summary

Modifier and Type	Method and Description
static OpenViduRole	valueOf(String name) Returns the enum constant of this type with the specified name.
static OpenViduRole[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUBSCRIBER

public static final OpenViduRole SUBSCRIBER

Can subscribe to published Streams of other users

PUBLISHER

public static final OpenViduRole PUBLISHER

SUBSCRIBER permissions + can publish their own Streams (call Session.publish())

MODERATOR

public static final OpenViduRole MODERATOR

SUBSCRIBER + PUBLISHER permissions + can force the unpublishing or disconnection over a third-party Stream or Connection (call Session.forceUnpublish() and Session.forceDisconnect())

Method Detail

values

public static OpenViduRole[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OpenViduRole c : OpenViduRole.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OpenViduRole valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null