1. interface
  2. Hypervel
  3. \
  4. Saloon
  5. \
  6. Contracts
  7. \
  8. OAuthAuthenticator

OAuthAuthenticator

interface OAuthAuthenticator implements Authenticator

Methods

void
set(PendingRequest $pendingRequest)

Apply the authentication to the request.

from  Authenticator
string
getAccessToken()

Get the access token.

string|null
getRefreshToken()

Get the refresh token.

CarbonInterface|null
getExpiresAt()

Get the expiry.

bool
hasExpired()

Determine if the authenticator has expired.

bool
hasNotExpired()

Determine if the authenticator has not expired.

bool
isRefreshable()

Determine if the authenticator is refreshable.

bool
isNotRefreshable()

Determine if the authenticator is not refreshable.

Details

in Authenticator at line 14
void set(PendingRequest $pendingRequest)

Apply the authentication to the request.

Parameters

PendingRequest $pendingRequest

Return Value

void

at line 14
string getAccessToken()

Get the access token.

Return Value

string

at line 19
string|null getRefreshToken()

Get the refresh token.

Return Value

string|null

at line 24
CarbonInterface|null getExpiresAt()

Get the expiry.

Return Value

CarbonInterface|null

at line 29
bool hasExpired()

Determine if the authenticator has expired.

Return Value

bool

at line 34
bool hasNotExpired()

Determine if the authenticator has not expired.

Return Value

bool

at line 39
bool isRefreshable()

Determine if the authenticator is refreshable.

Return Value

bool

at line 44
bool isNotRefreshable()

Determine if the authenticator is not refreshable.

Return Value

bool