Package com.opentok
Enum Role
- java.lang.Object
-
- java.lang.Enum<Role>
-
- com.opentok.Role
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<Role>
public enum Role extends java.lang.Enum<Role>
Defines values for the role parameter of theTokenOptions.Builder.role(Role role)
method.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description MODERATOR
In addition to the privileges granted to a publisher, a moderator can perform moderation functions, such as forcing clients to disconnect, to stop publishing streams, or to mute audio in published streams.PUBLISHER
A publisher can publish streams, subscribe to streams, and signal.PUBLISHER_ONLY
Publish only privilege.SUBSCRIBER
A subscriber can only subscribe to streams.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
toString()
static Role
valueOf​(java.lang.String name)
Returns the enum constant of this type with the specified name.static Role[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
SUBSCRIBER
public static final Role SUBSCRIBER
A subscriber can only subscribe to streams.
-
PUBLISHER
public static final Role PUBLISHER
A publisher can publish streams, subscribe to streams, and signal. (This is the default value if you do not set a role by calling theTokenOptions.Builder.role(Role role)
method.
-
MODERATOR
public static final Role MODERATOR
In addition to the privileges granted to a publisher, a moderator can perform moderation functions, such as forcing clients to disconnect, to stop publishing streams, or to mute audio in published streams. See the Moderation developer guide.
-
PUBLISHER_ONLY
public static final Role PUBLISHER_ONLY
Publish only privilege.
-
-
Method Detail
-
values
public static Role[] 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 (Role c : Role.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Role valueOf​(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Enum<Role>
-
-