BackchannelAuthenticationFailResponse extends ApiResponse
Response from Authlete's /api/backchannel/authentication/fail API.
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() : BackchannelAuthenticationFailAction
- Get the next action that the backchannel authentication endpoint should take.
- getResponseContent() : string
- Get the content of the response body of the response to the client.
- 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() : BackchannelAuthenticationFailResponse
- Set the next action that the backchannel authentication endpoint should take.
- setResponseContent() : BackchannelAuthenticationFailResponse
- Set the content of the response body of the response to the client.
- 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 backchannel authentication endpoint should take.
public
getAction() : BackchannelAuthenticationFailAction
Return values
BackchannelAuthenticationFailAction —The next action that the backchannel authentication endpoint should take.
getResponseContent()
Get the content of the response body of the response to the client.
public
getResponseContent() : string
Its format is always JSON.
Return values
string —The response content.
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 backchannel authentication endpoint should take.
public
setAction([BackchannelAuthenticationFailAction $action = null ]) : BackchannelAuthenticationFailResponse
Parameters
- $action : BackchannelAuthenticationFailAction = null
-
The next action that the backchannel authentication endpoint should take.
Return values
BackchannelAuthenticationFailResponse —$this object.
setResponseContent()
Set the content of the response body of the response to the client.
public
setResponseContent(string $responseContent) : BackchannelAuthenticationFailResponse
Parameters
- $responseContent : string
-
The response content.
Return values
BackchannelAuthenticationFailResponse —$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.