Class shardimage\shardimagephp\services\AccessTokenService

All Classes | Properties | Methods

Inheritance	shardimage\shardimagephp\services\AccessTokenService » shardimage\shardimagephp\services\Service » shardimage\shardimagephpapi\base\BaseObject

Shardimage security service.

Protected Properties

Property	Type	Description	Defined By
$client	shardimage\shardimagephp\auth\Client	Shardimage API Client	shardimage\shardimagephp\services\Service
$lastError	mixed	Last error in the service	shardimage\shardimagephp\services\Service
$version	string	Shardimage module version	shardimage\shardimagephp\services\Service

Method	Description	Defined By
__construct()	Creates the service.	shardimage\shardimagephp\services\Service
__get()	Returns the value of a non-defined property, it there is a getter method.	shardimage\shardimagephpapi\base\BaseObject
__isset()	Does the non-defined property with a getter exist and is it not NULL?	shardimage\shardimagephpapi\base\BaseObject
__set()	Sets the value of a non-defined property, if there is a setter method.	shardimage\shardimagephpapi\base\BaseObject
__unset()	Sets the value of a non-defined property to NULL, if there is a setter.	shardimage\shardimagephpapi\base\BaseObject
create()	Creates a new access token.	shardimage\shardimagephp\services\AccessTokenService
exists()	Returns whether the access token exists.	shardimage\shardimagephp\services\AccessTokenService
getController()	Shardimage controller	shardimage\shardimagephp\services\AccessTokenService
getLastError()	Returns the last error in the service.	shardimage\shardimagephp\services\Service
getModule()	Shardimage module	shardimage\shardimagephp\services\AccessTokenService
revoke()	Deletes an access token.	shardimage\shardimagephp\services\AccessTokenService
toArray()	Converts the object an array.	shardimage\shardimagephpapi\base\BaseObject
update()	Updates an access token.	shardimage\shardimagephp\services\AccessTokenService
view()	Fetches an access token.	shardimage\shardimagephp\services\AccessTokenService

Method	Description	Defined By
ensureClass()	Creates an object from the given parameters.	shardimage\shardimagephpapi\base\BaseObject
init()	Custom initialization.	shardimage\shardimagephpapi\base\BaseObject
sendRequest()	Sends the request to the Shardimage API and returns with the Response object or the ID for the request if deferred.	shardimage\shardimagephp\services\Service

create() public method

Creates a new access token.

public shardimage\shardimagephp\models\accesstoken\AccessToken\|shardimage\shardimagephpapi\api\Response create ( $params, $optParams = [] )
$params	shardimage\shardimagephp\models\accesstoken\AccessToken	Access Token object
$optParams	array	Optional API parameters
throws	shardimage\shardimagephpapi\base\exceptions\InvalidParamException

exists() public method

Returns whether the access token exists.

public boolean exists ( $params, $optParams = [] )
$params	shardimage\shardimagephp\models\accesstoken\AccessToken\|string	Access Token object or Access Token ID
$optParams	array	Optional API parameters

getController() public static method

Shardimage controller

public static void getController ( )

getModule() public static method

Shardimage module

public static void getModule ( )

revoke() public method

Deletes an access token.

public boolean revoke ( $params, $optParams = [] )
$params	shardimage\shardimagephp\models\accesstoken\AccessToken\|string	Access Token object or Access Token ID
$optParams	array	Optional API parameters

update() public method

Updates an access token.

public shardimage\shardimagephp\models\accesstoken\AccessToken\|shardimage\shardimagephpapi\api\Response update ( $params, $optParams = [] )
$params	shardimage\shardimagephp\models\accesstoken\AccessToken	Access Token object
$optParams	array	Optional API parameters
throws	shardimage\shardimagephpapi\base\exceptions\InvalidParamException

view() public method

Fetches an access token.

public shardimage\shardimagephp\models\accesstoken\AccessToken\|shardimage\shardimagephpapi\api\Response view ( $params, $optParams = [] )
$params	shardimage\shardimagephp\models\accesstoken\AccessToken\|string	Access Token object or Access Token ID
$optParams	array	Optional API parameters