javastrava.api.v3.auth.ref

Enum AuthorisationScope

java.lang.Object

java.lang.Enum<AuthorisationScope>

javastrava.api.v3.auth.ref.AuthorisationScope

All Implemented Interfaces:

Serializable, Comparable<AuthorisationScope>

public enum AuthorisationScope
extends Enum<AuthorisationScope>

view_private and/or write, leave blank for read-only permissions.

Author:

Dan Shannon

Enum Constant Summary

Enum Constants

Enum Constant and Description
UNKNOWN Should never occur but may if the Strava API behaviour has changed
VIEW_PRIVATE This authorisation scope allows the Strava API to return data from within the authenticated user's privacy zones
WRITE This authorisation scope allows the Strava API to write data - that is to update athlete details, activity details, and to make comments and give kudos to other riders' activities

Method Summary

Modifier and Type	Method and Description
static AuthorisationScope	create(String id) Used when deserialising JSON returned by the Strava API
String	getDescription()
String	getId()
String	toString()
static AuthorisationScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthorisationScope[]	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

VIEW_PRIVATE

public static final AuthorisationScope VIEW_PRIVATE

This authorisation scope allows the Strava API to return data from within the authenticated user's privacy zones

WRITE

public static final AuthorisationScope WRITE

This authorisation scope allows the Strava API to write data - that is to update athlete details, activity details, and to make comments and give kudos to other riders' activities

UNKNOWN

public static final AuthorisationScope UNKNOWN

Should never occur but may if the Strava API behaviour has changed

Method Detail

values

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

Returns:

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

valueOf

public static AuthorisationScope valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

create

public static AuthorisationScope create(String id)

Used when deserialising JSON returned by the Strava API

Parameters:

id - String value returned by Strava

Returns:

Returns the matching instance of AuthorisationScope, or UNKNOWN if there is no match

See Also:

AuthorisationScopeSerializer.deserialize(com.google.gson.JsonElement, java.lang.reflect.Type, com.google.gson.JsonDeserializationContext)

getDescription

public String getDescription()

Returns:

the description

getId

public String getId()

Returns:

the id

See Also:

AuthorisationScopeSerializer.serialize(AuthorisationScope, java.lang.reflect.Type, com.google.gson.JsonSerializationContext)

toString

public String toString()

Overrides:

toString in class Enum<AuthorisationScope>

See Also:

Enum.toString()