DeviceCompleteAction Uses EnumTrait
The value of "action" in responses from Authlete's /api/device/complete API.
Tags
Table of Contents
- $INVALID_REQUEST : DeviceCompleteAction
- The API call is invalid. Probably, the authorization server implementation has some bugs.
- $SERVER_ERROR : DeviceCompleteAction
- An error occurred on Authlete side. The authorization server implementation should tell the end-user that something wrong happened and urge her to re-initiate a device flow.
- $SUCCESS : DeviceCompleteAction
- The API call has been processed successfully. The authorization server should return a successful response to the web browser the end-user is using.
- $USER_CODE_EXPIRED : DeviceCompleteAction
- The user code has expired. The authorization server implementation should tell the end-user that the user code has expired and urge her to re-initiate a device flow.
- $USER_CODE_NOT_EXIST : DeviceCompleteAction
- The user code does not exist. The authorization server implementation should tell the end-user that the user code has been invalidated and urge her to re-initiate a device flow.
- __toString() : string
- Get the name of this instance.
- name() : string
- Get the name of this instance.
- valueOf() : static
- Get an instance of this class that the given argument represents.
- values() : array<string|int, mixed>
- Get the list of public class variables listed in this class.
Properties
$INVALID_REQUEST
The API call is invalid. Probably, the authorization server implementation has some bugs.
public
static DeviceCompleteAction
$INVALID_REQUEST
Tags
$SERVER_ERROR
An error occurred on Authlete side. The authorization server implementation should tell the end-user that something wrong happened and urge her to re-initiate a device flow.
public
static DeviceCompleteAction
$SERVER_ERROR
Tags
$SUCCESS
The API call has been processed successfully. The authorization server should return a successful response to the web browser the end-user is using.
public
static DeviceCompleteAction
$SUCCESS
Tags
$USER_CODE_EXPIRED
The user code has expired. The authorization server implementation should tell the end-user that the user code has expired and urge her to re-initiate a device flow.
public
static DeviceCompleteAction
$USER_CODE_EXPIRED
Tags
$USER_CODE_NOT_EXIST
The user code does not exist. The authorization server implementation should tell the end-user that the user code has been invalidated and urge her to re-initiate a device flow.
public
static DeviceCompleteAction
$USER_CODE_NOT_EXIST
Tags
Methods
__toString()
Get the name of this instance.
public
__toString() : string
Return values
string —The name of this instance.
name()
Get the name of this instance.
public
name() : string
Return values
string —The name of this instance.
valueOf()
Get an instance of this class that the given argument represents.
public
static valueOf(mixed $value) : static
If the given argument is an instance of this class, the instance itself is returned.
Otherwise, if the given argument is null, null is returned.
Otherwise, if the type of the given argument is not string,
an InvalidArgumentException is returned.
Otherwise, a class variable whose name is equal to the given
argument is looked up. If found, the instance is returned.
If not found, an InvalidArgumentException is thrown.
Parameters
- $value : mixed
-
A string that represents an instance of this class, or an instance of this class, or
null.
Return values
static —An instance of this class.
values()
Get the list of public class variables listed in this class.
public
static values() : array<string|int, mixed>
Return values
array<string|int, mixed> —Instances of this class which are defined as public class variables.