Documentation

TokenIssueAction Uses EnumTrait

The value of "action" in responses from Authlete's /api/auth/token/issue API.

Table of Contents

$INTERNAL_SERVER_ERROR  : TokenIssueAction
The request from your system was wrong or an error occurred in Authlete.
$OK  : TokenIssueAction
Authlete's /api/auth/token/issue API successfully generated an access token.
__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

$INTERNAL_SERVER_ERROR

The request from your system was wrong or an error occurred in Authlete.

public static TokenIssueAction $INTERNAL_SERVER_ERROR

The token endpoint should return 500 Internal Server Error to the client application.

Tags
static

$OK

Authlete's /api/auth/token/issue API successfully generated an access token.

public static TokenIssueAction $OK

The token endpoint should return 200 OK to the client application with the access token.

Tags
static

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.

Search results