com.opentok.Role Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentok-server-sdk Show documentation

The OpenTok Java SDK lets you generate sessions and tokens for OpenTok applications. This version of the SDK also includes support for working with OpenTok 2.0 archives.

There is a newer version: 4.15.0

Show newest version

/**
 * OpenTok Java SDK
 * Copyright (C) 2025 Vonage.
 * http://www.tokbox.com
 * 
 * Licensed under The MIT License (MIT). See LICENSE file for more information.
 */
package com.opentok;

/**
 * Defines values for the role parameter of the {@link TokenOptions.Builder#role(Role role)} method.
 */
public enum Role {
    /**
    * A subscriber can only subscribe to streams.
    */
    SUBSCRIBER,

    /**
    * A publisher can publish streams, subscribe to streams, and signal. (This is the default
    * value if you do not set a role by calling the {@link TokenOptions.Builder#role(Role role)}
    * method.
    */
    PUBLISHER,

    /**
    * 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.
    */
    MODERATOR,

    /**
     * Publish only privilege.
     */
    PUBLISHER_ONLY;

    @Override
    public String toString() {
        return name().toLowerCase().replace("_", "");
    }
}