javastrava.api.v3.auth.ref

Enum AuthorisationApprovalPrompt

java.lang.Object

java.lang.Enum<AuthorisationApprovalPrompt>

javastrava.api.v3.auth.ref.AuthorisationApprovalPrompt

All Implemented Interfaces:

Serializable, Comparable<AuthorisationApprovalPrompt>

public enum AuthorisationApprovalPrompt
extends Enum<AuthorisationApprovalPrompt>

FORCE or AUTO

Use FORCE to always show the authorisation prompt even if the user has already authorised the current application

Default is AUTO

Author:

Dan Shannon

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Tells Strava's authorisation process not to show the authorisation prompt page if the user hqs already authorised the application with the requested authorisation scope(s)
FORCE Forces Strava's authorisation process to show the authorisation prompt page, even if the user has already authorised the application with the requested authorisation scope(s)
UNKNOWN Should never occur but may if Strava API behaviour has changed

Method Summary

Modifier and Type	Method and Description
static AuthorisationApprovalPrompt	create(String id) Used by AuthorisationApprovalPromptSerializer.deserialize(com.google.gson.JsonElement, java.lang.reflect.Type, com.google.gson.JsonDeserializationContext) when deserialising JSON returned by the Strava API
String	getId() Note that this is also used by AuthorisationApprovalPromptSerializer.serialize(AuthorisationApprovalPrompt, java.lang.reflect.Type, com.google.gson.JsonSerializationContext) when serialising to JSON
String	toString()
static AuthorisationApprovalPrompt	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthorisationApprovalPrompt[]	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

FORCE

public static final AuthorisationApprovalPrompt FORCE

Forces Strava's authorisation process to show the authorisation prompt page, even if the user has already authorised the application with the requested authorisation scope(s)

AUTO

public static final AuthorisationApprovalPrompt AUTO

Tells Strava's authorisation process not to show the authorisation prompt page if the user hqs already authorised the application with the requested authorisation scope(s)

UNKNOWN

public static final AuthorisationApprovalPrompt UNKNOWN

Should never occur but may if Strava API behaviour has changed

Method Detail

values

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

Returns:

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

valueOf

public static AuthorisationApprovalPrompt 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 AuthorisationApprovalPrompt create(String id)

Used by AuthorisationApprovalPromptSerializer.deserialize(com.google.gson.JsonElement, java.lang.reflect.Type, com.google.gson.JsonDeserializationContext) when deserialising JSON returned by the Strava API

Parameters:

id - The text representation returned by Strava

Returns:

The instance of AuthorisationApprovalPrompt with the correct id

getId

public String getId()

Note that this is also used by AuthorisationApprovalPromptSerializer.serialize(AuthorisationApprovalPrompt, java.lang.reflect.Type, com.google.gson.JsonSerializationContext) when serialising to JSON

Returns:

the id

toString

public String toString()

Overrides:

toString in class Enum<AuthorisationApprovalPrompt>

See Also:

Enum.toString()