org.gitlab4j.api

Enum Constants.ApplicationScope

java.lang.Object

java.lang.Enum<Constants.ApplicationScope>

org.gitlab4j.api.Constants.ApplicationScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Constants.ApplicationScope>

Enclosing interface:

Constants

public static enum Constants.ApplicationScope
extends java.lang.Enum<Constants.ApplicationScope>

Enum for the various Application scope values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
API Access the authenticated user's API
EMAIL Allows read-only access to the user's primary email address using OpenID Connect
OPENID Authenticate using OpenID Connect
PROFILE Allows read-only access to the user's personal information using OpenID Connect
READ_REPOSITORY Allows read-access to the repository
READ_USER Read the authenticated user's personal information
SUDO Perform API actions as any user in the system

Method Summary

Modifier and Type	Method and Description
static Constants.ApplicationScope	forValue(java.lang.String value)
java.lang.String	toString()
java.lang.String	toValue()
static Constants.ApplicationScope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Constants.ApplicationScope[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

API

public static final Constants.ApplicationScope API

Access the authenticated user's API

READ_USER

public static final Constants.ApplicationScope READ_USER

Read the authenticated user's personal information

SUDO

public static final Constants.ApplicationScope SUDO

Perform API actions as any user in the system

READ_REPOSITORY

public static final Constants.ApplicationScope READ_REPOSITORY

Allows read-access to the repository

OPENID

public static final Constants.ApplicationScope OPENID

Authenticate using OpenID Connect

PROFILE

public static final Constants.ApplicationScope PROFILE

Allows read-only access to the user's personal information using OpenID Connect

EMAIL

public static final Constants.ApplicationScope EMAIL

Allows read-only access to the user's primary email address using OpenID Connect

Method Detail

values

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

Returns:

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

valueOf

public static Constants.ApplicationScope 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

forValue

public static Constants.ApplicationScope forValue(java.lang.String value)

toValue

public java.lang.String toValue()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Constants.ApplicationScope>