com.mb3364.twitch.api.auth

Enum Scopes

java.lang.Object

java.lang.Enum<Scopes>

com.mb3364.twitch.api.auth.Scopes

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Scopes>

public enum Scopes
extends java.lang.Enum<Scopes>

When requesting authorization from users, the scope parameter allows you to specify which permissions your app requires. These scopes are ties to the access token you receive upon a successful authorization. Without specifying scopes, your app only has access to basic information about the authenticated user. You may specify any or all of the following scopes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANNEL_CHECK_SUBSCRIPTION Read access to check if a user is subscribed to your channel.
CHANNEL_COMMERCIAL Access to trigger commercials on channel.
CHANNEL_EDITOR Write access to channel metadata (game, status, etc).
CHANNEL_READ Read access to non-public channel information, including email address and stream key.
CHANNEL_STREAM Ability to reset a channel's stream key.
CHANNEL_SUBSCRIPTIONS Read access to all subscribers to your channel.
CHAT_LOGIN Ability to log into chat and send messages.
USER_BLOCKS_EDIT Ability to ignore or unignore on behalf of a user.
USER_BLOCKS_READ Read access to a user's list of ignored users.
USER_FOLLOWS_EDIT Access to manage a user's followed channels.
USER_READ Read access to non-public user information, such as email address.
USER_SUBSCRIPTIONS Read access to subscriptions of a user.

Method Summary

Modifier and Type	Method and Description
static Scopes	fromString(java.lang.String text) Convert the string representation of the Scope to the Enum.
java.lang.String	getKey() Get the identifier that twitch will recognize.
static java.lang.String	join(Scopes... scopes) Combine Scopes into a '+' separated String.
static Scopes	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Scopes[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

USER_READ

public static final Scopes USER_READ

Read access to non-public user information, such as email address.

USER_BLOCKS_EDIT

public static final Scopes USER_BLOCKS_EDIT

Ability to ignore or unignore on behalf of a user.

USER_BLOCKS_READ

public static final Scopes USER_BLOCKS_READ

Read access to a user's list of ignored users.

USER_FOLLOWS_EDIT

public static final Scopes USER_FOLLOWS_EDIT

Access to manage a user's followed channels.

CHANNEL_READ

public static final Scopes CHANNEL_READ

Read access to non-public channel information, including email address and stream key.

CHANNEL_EDITOR

public static final Scopes CHANNEL_EDITOR

Write access to channel metadata (game, status, etc).

CHANNEL_COMMERCIAL

public static final Scopes CHANNEL_COMMERCIAL

Access to trigger commercials on channel.

CHANNEL_STREAM

public static final Scopes CHANNEL_STREAM

Ability to reset a channel's stream key.

CHANNEL_SUBSCRIPTIONS

public static final Scopes CHANNEL_SUBSCRIPTIONS

Read access to all subscribers to your channel.

USER_SUBSCRIPTIONS

public static final Scopes USER_SUBSCRIPTIONS

Read access to subscriptions of a user.

CHANNEL_CHECK_SUBSCRIPTION

public static final Scopes CHANNEL_CHECK_SUBSCRIPTION

Read access to check if a user is subscribed to your channel.

CHAT_LOGIN

public static final Scopes CHAT_LOGIN

Ability to log into chat and send messages.

Method Detail

values

public static Scopes[] 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 (Scopes c : Scopes.values())
    System.out.println(c);

Returns:

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

valueOf

public static Scopes 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 name

java.lang.NullPointerException - if the argument is null

join

public static java.lang.String join(Scopes... scopes)

Combine Scopes into a '+' separated String. This is the required input format for twitch.tv

Parameters:

scopes - Scopes to combine.

Returns:

String representing '+' separated list of Scopes

fromString

public static Scopes fromString(java.lang.String text)

Convert the string representation of the Scope to the Enum.

Parameters:

text - Text representation of Enum value

Returns:

Enum value that the text represents

getKey

public java.lang.String getKey()

Get the identifier that twitch will recognize.

Returns:

A String identifier