Documentation

TokenUpdateAction Uses EnumTrait

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

Table of Contents

$BAD_REQUEST  : TokenUpdateAction
The request from the caller was wrong.
$FORBIDDEN  : TokenUpdateAction
The request from the caller was not allowed.
$INTERNAL_SERVER_ERROR  : TokenUpdateAction
An error occurred on Authlete side.
$NOT_FOUND  : TokenUpdateAction
The specified access token does not exist.
$OK  : TokenUpdateAction
The access token was updated successfully.
__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

$BAD_REQUEST

The request from the caller was wrong.

public static TokenUpdateAction $BAD_REQUEST

For example, this happens when the accessToken request parameter was missing.

Tags
static

$FORBIDDEN

The request from the caller was not allowed.

public static TokenUpdateAction $FORBIDDEN

For example, this happens when the access token identified by the accessToken request parameter does not belong to the service identified by the API key used for the API call.

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