com.amazon.device.simplesignin.model

Enum RequestStatus

java.lang.Object

java.lang.Enum<RequestStatus>

com.amazon.device.simplesignin.model.RequestStatus

All Implemented Interfaces:

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

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

Indicates the status of the requests made to SimpleSignIn SDK. This will be added to all Response objects.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DUPLICATE_REQUEST Indicates a duplicate request made for link user account, while another request at AppStore is in processing state.
FAILURE Indicates Non retryable failures while processing link user account request.
FEATURE_TURNED_OFF Indicates that user have turned OFF the SimpleSignIn feature, either for their Amazon account / FOS device / 3P app from which request is made.
INVALID_LINK_SIGNING_KEY Applicable only for LinkUserAccount API response.
INVALID_LINK_SIGNING_KEY_ENCRYPTION Applicable only for LinkUserAccount API response.
NOT_AVAILABLE Indicates that SSI feature is disabled by Amazon for any of the following reasons.
NOT_SUPPORTED Indicates this request cannot be handled on the device, stating that SSI feature is not available on the device.
RETRYABLE_FAILURE Transient errors like Timeout, SSI server 503 response falls under retryable failures.
SUCCESSFUL Indicates that the link user account request is successful.

Method Summary

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

SUCCESSFUL

public static final RequestStatus SUCCESSFUL

Indicates that the link user account request is successful.

FAILURE

public static final RequestStatus FAILURE

Indicates Non retryable failures while processing link user account request.

RETRYABLE_FAILURE

public static final RequestStatus RETRYABLE_FAILURE

Transient errors like Timeout, SSI server 503 response falls under retryable failures.

NOT_SUPPORTED

public static final RequestStatus NOT_SUPPORTED

Indicates this request cannot be handled on the device, stating that SSI feature is not available on the device.

NOT_AVAILABLE

public static final RequestStatus NOT_AVAILABLE

Indicates that SSI feature is disabled by Amazon for any of the following reasons.

• SSI Feature is disabled for a marketplace to which the device is registered
• SSI Feature is blocked for a particular 3P ASIN
• Device is running in child profile mode
• Device is running in Non-member mode, (i.e.) without registered to an Amazon account
• SSI API invoked by the 3P App is not supported. For example, ShowLoginSelection API is not supported in multi-model devices.

DUPLICATE_REQUEST

public static final RequestStatus DUPLICATE_REQUEST

Indicates a duplicate request made for link user account, while another request at AppStore is in processing state.

FEATURE_TURNED_OFF

public static final RequestStatus FEATURE_TURNED_OFF

Indicates that user have turned OFF the SimpleSignIn feature, either for their Amazon account / FOS device / 3P app from which request is made.

INVALID_LINK_SIGNING_KEY_ENCRYPTION

public static final RequestStatus INVALID_LINK_SIGNING_KEY_ENCRYPTION

Applicable only for LinkUserAccount API response. Indicates a the LinkSigningKey provided in the LinkUserAccount API request is NOT encrypted using AppStore PublicKey, hence the SSI Server cannot decode the same.

INVALID_LINK_SIGNING_KEY

public static final RequestStatus INVALID_LINK_SIGNING_KEY

Applicable only for LinkUserAccount API response. Indicates that LinkSigningKey provided in the LinkUserAccount API request is NOT a valid Elliptical Curve PrivateKey. This is sent back when the AppStore PublicKey encrypted LinkSigningKey is successfully decrypted using corresponding AppStore PrivateKey, but the decrypted content doesn't conform the expected standards of LinkSigningKey.

Method Detail

values

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

Returns:

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

valueOf

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