API Documentation
\
OCLC
Auth

\OCLC\AuthRefreshToken

A class that represents a client's OCLC Refresh Token.

Summary

Methods
Properties
Constants
getValue()
getExpiresIn()
getExpiresAt()
isExpired()
__construct()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$refreshToken
$expiresIn
$expiresAt
N/A

Properties

$refreshToken

$refreshToken : string

The refresh Token

Type

string

$expiresIn

$expiresIn : string

The number of milliseconds when the refresh tokens expires in

Type

string

$expiresAt

$expiresAt : \OCLC\Auth\unknown

The time in UTC when the refresh token expires

Type

\OCLC\Auth\unknown

Methods

getValue()

getValue() : string

Get Refresh Token

Returns

string

getExpiresIn()

getExpiresIn() : integer

Get Refresh Token Expires In

Returns

integer

getExpiresAt()

getExpiresAt() : string

Get Refresh Token Expires At

Returns

string

isExpired()

isExpired() : boolean

Return if the Refresh Token is Expired on Not

Returns

boolean

__construct()

__construct(string  $tokenValue, string  $expiresIn, string  $expiresAt)

Construct a new Refresh Token

Parameters

string $tokenValue
string $expiresIn
string $expiresAt