# Class yii\authclient\OAuthToken

Inheritance | yii\authclient\OAuthToken » yii\base\BaseObject
Implements | yii\base\Configurable
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-authclient/blob/master/OAuthToken.php

Token represents OAuth token.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$createTimestamp | integer | Object creation timestamp. | yii\authclient\OAuthToken
$expireDuration | integer | Token expiration duration. Note that the type of this property differs in getter and setter. See getExpireDuration() and setExpireDuration() for details. | yii\authclient\OAuthToken
$expireDurationParamKey | string | Expire duration param key. | yii\authclient\OAuthToken
$isExpired | boolean | Is token expired. This property is read-only. | yii\authclient\OAuthToken
$isValid | boolean | Is token valid. This property is read-only. | yii\authclient\OAuthToken
$params | array | This property is read-only. | yii\authclient\OAuthToken
$token | string | Token value. | yii\authclient\OAuthToken
$tokenParamKey | string | Key in $params array, which stores token key. | yii\authclient\OAuthToken
$tokenSecret | string | Token secret value. | yii\authclient\OAuthToken
$tokenSecretParamKey | string | Key in $params array, which stores token secret key. | yii\authclient\OAuthToken

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\BaseObject
__construct() |  | yii\authclient\OAuthToken
__get() | Returns the value of an object property. | yii\base\BaseObject
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject
__set() | Sets value of an object property. | yii\base\BaseObject
__unset() | Sets an object property to null. | yii\base\BaseObject
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
getExpireDuration() | Returns the token expiration duration. | yii\authclient\OAuthToken
getExpireDurationParamKey() |  | yii\authclient\OAuthToken
getIsExpired() | Checks if token has expired. | yii\authclient\OAuthToken
getIsValid() | Checks if token is valid. | yii\authclient\OAuthToken
getParam() | Returns param by name. | yii\authclient\OAuthToken
getParams() |  | yii\authclient\OAuthToken
getToken() | Returns token value. | yii\authclient\OAuthToken
getTokenSecret() | Returns the token secret value. | yii\authclient\OAuthToken
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject
init() | Initializes the object. | yii\authclient\OAuthToken
setExpireDuration() | Sets token expire duration. | yii\authclient\OAuthToken
setExpireDurationParamKey() |  | yii\authclient\OAuthToken
setParam() | Sets param by name. | yii\authclient\OAuthToken
setParams() |  | yii\authclient\OAuthToken
setToken() | Sets token value. | yii\authclient\OAuthToken
setTokenSecret() | Sets the token secret value. | yii\authclient\OAuthToken

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
defaultExpireDurationParamKey() | Fetches default expire duration param key. | yii\authclient\OAuthToken

## Property Details

$createTimestamp public property

Object creation timestamp.

public integer $createTimestamp = null
$expireDuration public property

Token expiration duration. Note that the type of this property differs in getter and setter. See getExpireDuration() and setExpireDuration() for details.

public integer $expireDuration = null
$expireDurationParamKey public property

Expire duration param key.

public string $expireDurationParamKey = null
$isExpired public property

Is token expired. This property is read-only.

public boolean $isExpired = null
$isValid public property

Is token valid. This property is read-only.

public boolean $isValid = null
$params public property

This property is read-only.

public array $params = null
$token public property

Token value.

public string $token = null
$tokenParamKey public property

Key in $params array, which stores token key.

public string $tokenParamKey = 'oauth_token'
$tokenSecret public property

Token secret value.

public string $tokenSecret = null
$tokenSecretParamKey public property

Key in $params array, which stores token secret key.

public string $tokenSecretParamKey = 'oauth_token_secret'

## Method Details

__construct() public method

public void __construct ( array $config = [] )
$config |  |

defaultExpireDurationParamKey() protected method

Fetches default expire duration param key.

protected string defaultExpireDurationParamKey ( )
return | string | Expire duration param key.

getExpireDuration() public method

Returns the token expiration duration.

public integer getExpireDuration ( )
return | integer | Token expiration duration.

getExpireDurationParamKey() public method

public string getExpireDurationParamKey ( )
return | string | Expire duration param key.

getIsExpired() public method

Checks if token has expired.

public boolean getIsExpired ( )
return | boolean | Is token expired.

getIsValid() public method

Checks if token is valid.

public boolean getIsValid ( )
return | boolean | Is token valid.

getParam() public method

Returns param by name.

public mixed getParam ( $name )
$name | string | Param name.
return | mixed | Param value.

getParams() public method

public array getParams ( )

getToken() public method

Returns token value.

public string getToken ( )
return | string | Token value.

getTokenSecret() public method

Returns the token secret value.

public string getTokenSecret ( )
return | string | Token secret value.

init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

setExpireDuration() public method

Sets token expire duration.

public void setExpireDuration ( $expireDuration )
$expireDuration | string | Token expiration duration.

setExpireDurationParamKey() public method

public void setExpireDurationParamKey ( $expireDurationParamKey )
$expireDurationParamKey | string | Expire duration param key.

setParam() public method

Sets param by name.

public void setParam ( $name, $value )
$name | string | Param name.
$value | mixed | Param value,

setParams() public method

public void setParams ( array $params )
$params | array |

setToken() public method

Sets token value.

public $this setToken ( $token )
$token | string | Token value.
return | $this | The object itself

setTokenSecret() public method

Sets the token secret value.

public void setTokenSecret ( $tokenSecret )
$tokenSecret | string | Token secret.