DeviceVerificationAction Uses EnumTrait
The value of "action" in responses from Authlete's /api/device/verification API.
Tags
Table of Contents
- $EXPIRED : DeviceVerificationAction
- 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.
- $NOT_EXIST : DeviceVerificationAction
- The user code does not exist. The authorization server implementation should tell the end-user that the user code is invalid and urge her to retry to input a valid user code.
- $SERVER_ERROR : DeviceVerificationAction
- 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.
- $VALID : DeviceVerificationAction
- The user code is valid. This means that the user code exists, has not expired, and belongs to the service. The authorization server implementation should interact with the end-user to ask whether she approves or rejects the authorization request from the device.
- __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
$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 DeviceVerificationAction
$EXPIRED
Tags
$NOT_EXIST
The user code does not exist. The authorization server implementation should tell the end-user that the user code is invalid and urge her to retry to input a valid user code.
public
static DeviceVerificationAction
$NOT_EXIST
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 DeviceVerificationAction
$SERVER_ERROR
Tags
$VALID
The user code is valid. This means that the user code exists, has not expired, and belongs to the service. The authorization server implementation should interact with the end-user to ask whether she approves or rejects the authorization request from the device.
public
static DeviceVerificationAction
$VALID
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.