DeviceCompleteResponse extends ApiResponse
Response from Authlete's /api/device/complete API.
Authlete's /api/device/complete API returns JSON which can be mapped to
this class. The authorization server implementation should retrieve the
value of the action response parameter (which can be obtained by
getAction() method of this class) from the response and take the following
steps according to the value.
When the value returned from getAction() method is
DeviceCompleteAction::$SUCCESS, it means that the API call has been
processed successfully. The authorization server should return a successful
response to the web browser the end-user is using.
When the value returned from getAction() method is
DeviceCompleteAction::$INVALID_REQUEST, it means that the API call is
invalid. Probably, the authorization server implementation has some bugs.
When the value returned from getAction() method is
DeviceCompleteAction::$USER_CODE_EXPIRED, it means that the user code
included in the API call 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.
When the value returned from getAction() method is
DeviceCompleteAction::$USER_CODE_NOT_EXIST, it means that the user code
included in the API call 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.
When the value returned from getAction() method is
DeviceCompleteAction::$SERVER_ERROR, it means that 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.
Tags
Table of Contents
- copyFromArray() : mixed
- Copy the content of the given array into this object.
- copyToArray() : mixed
- Copy the content of this object into the given array.
- fromArray() : static
- Convert an array into an instance of this class.
- fromJson() : static
- Convert a JSON string into an instance of this class.
- getAction() : DeviceAuthorizationAction
- Get the next action that the authorization server should take.
- getResultCode() : string
- Get the code of the result of an Authlete API call.
- getResultMessage() : string
- Get the message of the result of an Authlete API call.
- setAction() : DeviceCompleteResponse
- Set the next action that the authorization server should take.
- setResultCode() : ApiResponse
- Set the code of the result of an Authlete API call.
- setResultMessage() : ApiResponse
- Set the message of the result of an Authlete API call.
- toArray() : array<string|int, mixed>
- Convert this object into an array.
- toJson() : string
- Convert this object into a JSON string.
Methods
copyFromArray()
Copy the content of the given array into this object.
public
copyFromArray(array<string|int, mixed> &$array) : mixed
Parameters
- $array : array<string|int, mixed>
Return values
mixed —copyToArray()
Copy the content of this object into the given array.
public
copyToArray(array<string|int, mixed> &$array) : mixed
Parameters
- $array : array<string|int, mixed>
Return values
mixed —fromArray()
Convert an array into an instance of this class.
public
static fromArray([array<string|int, mixed> $array = null ]) : static
This static function returns a new instance of this class.
If $array is null, null is returned.
Parameters
- $array : array<string|int, mixed> = null
-
An array
Return values
static —An instance of this class.
fromJson()
Convert a JSON string into an instance of this class.
public
static fromJson(string $json) : static
This static function returns a new instance of this class.
If $json is null or the type of $json is not string,
null is returned.
Parameters
- $json : string
-
A JSON string.
Return values
static —An instance of this class.
getAction()
Get the next action that the authorization server should take.
public
getAction() : DeviceAuthorizationAction
Return values
DeviceAuthorizationAction —The next action that the authorization server should take.
getResultCode()
Get the code of the result of an Authlete API call.
public
getResultCode() : string
Return values
string —The result code.
getResultMessage()
Get the message of the result of an Authlete API call.
public
getResultMessage() : string
Return values
string —The result message.
setAction()
Set the next action that the authorization server should take.
public
setAction([DeviceCompleteAction $action = null ]) : DeviceCompleteResponse
Parameters
- $action : DeviceCompleteAction = null
-
The next action that the authorization server should take.
Return values
DeviceCompleteResponse —$this object.
setResultCode()
Set the code of the result of an Authlete API call.
public
setResultCode(string $resultCode) : ApiResponse
Parameters
- $resultCode : string
-
The result code.
Return values
ApiResponse —$this object.
setResultMessage()
Set the message of the result of an Authlete API call.
public
setResultMessage(string $resultMessage) : ApiResponse
Parameters
- $resultMessage : string
-
The result message.
Return values
ApiResponse —$this object.
toArray()
Convert this object into an array.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array.
toJson()
Convert this object into a JSON string.
public
toJson(int $options) : string
Parameters
- $options : int
-
Options passed to
json_encode(). This parameter is optional and its default value is 0.
Return values
string —A JSON string.