com.uber.sdk.core.auth

Enum Scope

java.lang.Object

java.lang.Enum<Scope>

com.uber.sdk.core.auth.Scope

All Implemented Interfaces:

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

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

An Uber API scope. See Scopes for more information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scope.ScopeType Category of Scope that describes its level of access.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_TRIPS Request list of all trips belong to a user.
HISTORY Pull trip data of a user's historical pickups and drop-offs.
HISTORY_LITE Same as History without city information.
PAYMENT_METHODS Retrieve user's available registered payment methods.
PLACES Save and retrieve user's favorite places.
PROFILE Access basic profile information on a user's Uber account.
REQUEST Request ride on the behalf of an Uber account.
REQUEST_RECEIPT Request ride for a ride on the behalf of an Uber account.
RIDE_WIDGETS Access the Ride Request Widget.

Method Summary

Modifier and Type	Method and Description
int	getBitValue() Gets the bit value that represents this.
Scope.ScopeType	getScopeType() Gets the Scope.ScopeType associated with this Scope.
static java.util.Set<Scope>	parseScopes(int bitValues)
static java.util.Set<Scope>	parseScopes(java.lang.String concatenatedScopes)
static java.lang.String	toStandardString(java.util.Collection<Scope> scopes)
static Scope	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Scope[]	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

HISTORY

public static final Scope HISTORY

Pull trip data of a user's historical pickups and drop-offs.

HISTORY_LITE

public static final Scope HISTORY_LITE

Same as History without city information.

PAYMENT_METHODS

public static final Scope PAYMENT_METHODS

Retrieve user's available registered payment methods.

PLACES

public static final Scope PLACES

Save and retrieve user's favorite places.

PROFILE

public static final Scope PROFILE

Access basic profile information on a user's Uber account.

RIDE_WIDGETS

public static final Scope RIDE_WIDGETS

Access the Ride Request Widget.

REQUEST

public static final Scope REQUEST

Request ride on the behalf of an Uber account.

REQUEST_RECEIPT

public static final Scope REQUEST_RECEIPT

Request ride for a ride on the behalf of an Uber account.

ALL_TRIPS

public static final Scope ALL_TRIPS

Request list of all trips belong to a user.

Method Detail

values

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

Returns:

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

valueOf

public static Scope 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

getScopeType

public Scope.ScopeType getScopeType()

Gets the Scope.ScopeType associated with this Scope.

Returns:

the type of scope.

getBitValue

public int getBitValue()

Gets the bit value that represents this.

Returns:

the int value that represents this’.

parseScopes

public static java.util.Set<Scope> parseScopes(java.lang.String concatenatedScopes)

parseScopes

public static java.util.Set<Scope> parseScopes(int bitValues)

toStandardString

public static java.lang.String toStandardString(@Nonnull
                                                java.util.Collection<Scope> scopes)