Samy\OAuth2\ResponseInterface Interface Reference

Inheritance diagram for Samy\OAuth2\ResponseInterface:

Public Member Functions
	getTokenType ()
	withTokenType (string $TokenType)
	getAccessToken ()
	withAccessToken (string $AccessToken)
	getRefreshToken ()
	withRefreshToken (string $RefreshToken)
	getExpiresIn ()
	withExpiresIn (int $ExpiresIn)
	getScope ()
	withScope (string $Scope)
	getError ()
	withError (string $Error)
	getErrorDescription ()
	withErrorDescription (string $ErrorDescription)
	getErrorUri ()
	withErrorUri (string $ErrorUri)

Detailed Description

Describes OAuth2 Response interface.

See also

https://www.oauth.com/oauth2-servers/access-tokens/access-token-response/

Member Function Documentation

getAccessToken()

Samy\OAuth2\ResponseInterface::getAccessToken

(

)

Retrieve provided access token.

Returns

string

Implemented in Samy\OAuth2\Response.

getError()

Samy\OAuth2\ResponseInterface::getError

(

)

Retrieve provided error parameter

Returns

string

getErrorDescription()

Samy\OAuth2\ResponseInterface::getErrorDescription

(

)

Retrieve provided error description.

Returns

string

getErrorUri()

Samy\OAuth2\ResponseInterface::getErrorUri

(

)

Retrieve provided error uri.

Returns

string

getExpiresIn()

Samy\OAuth2\ResponseInterface::getExpiresIn

(

)

Retrieve provided token duration.

Returns

int

Implemented in Samy\OAuth2\Response.

getRefreshToken()

Samy\OAuth2\ResponseInterface::getRefreshToken

(

)

Retrieve provided refresh token.

Returns

string

Implemented in Samy\OAuth2\Response.

getScope()

Samy\OAuth2\ResponseInterface::getScope

(

)

Retrieve provided scope.

Returns

string

Implemented in Samy\OAuth2\Response.

getTokenType()

Samy\OAuth2\ResponseInterface::getTokenType

(

)

Retrieve provided token type.

Returns

string

Implemented in Samy\OAuth2\Response.

withAccessToken()

Samy\OAuth2\ResponseInterface::withAccessToken

(

string

$AccessToken

)

Return an instance with provided access token.

Parameters

[in]

string

$AccessToken

Access token

Returns

static

Implemented in Samy\OAuth2\Response.

withError()

Samy\OAuth2\ResponseInterface::withError

(

string

$Error

)

Return an instance with error parameter.

Parameters

[in]

string

$Error

Error parameter.

Returns

static

withErrorDescription()

Samy\OAuth2\ResponseInterface::withErrorDescription

(

string

$ErrorDescription

)

Return an instance with error description.

Parameters

[in]

string

$ErrorDescription

Error description.

Returns

static

withErrorUri()

Samy\OAuth2\ResponseInterface::withErrorUri

(

string

$ErrorUri

)

Return an instance with error uri.

Parameters

[in]

string

$ErrorUri

Error uri.

Returns

static

withExpiresIn()

Samy\OAuth2\ResponseInterface::withExpiresIn

(

int

$ExpiresIn

)

Return an instance with provided token duration.

Parameters

[in]

int

$ExpiresIn

Token duration

Returns

static

Implemented in Samy\OAuth2\Response.

withRefreshToken()

Samy\OAuth2\ResponseInterface::withRefreshToken

(

string

$RefreshToken

)

Return an instance with provided refresh token.

Parameters

[in]

string

$RefreshToken

Refresh token

Returns

static

Implemented in Samy\OAuth2\Response.

withScope()

Samy\OAuth2\ResponseInterface::withScope

(

string

$Scope

)

Return an instance with provided scope.

Parameters

[in]

string

$Scope

Scope

Returns

static

Implemented in Samy\OAuth2\Response.

withTokenType()

Samy\OAuth2\ResponseInterface::withTokenType

(

string

$TokenType

)

Return an instance with provided token type.

Parameters

[in]

string

$TokenType

Token type

Returns

static

Implemented in Samy\OAuth2\Response.

---

The documentation for this interface was generated from the following file:

• oauth2/ResponseInterface.php