Commercetools\Api\Models\ApiClient\ApiClientDraft Interface Reference

Inheritance diagram for Commercetools\Api\Models\ApiClient\ApiClientDraft:

Public Member Functions
	getName ()
	getScope ()
	getDeleteDaysAfterCreation ()
	getAccessTokenValiditySeconds ()
	getRefreshTokenValiditySeconds ()
	setName (?string $name)
	setScope (?string $scope)
	setDeleteDaysAfterCreation (?int $deleteDaysAfterCreation)
	setAccessTokenValiditySeconds (?int $accessTokenValiditySeconds)
	setRefreshTokenValiditySeconds (?int $refreshTokenValiditySeconds)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (callable $callable=null)

Public Attributes
const	FIELD_NAME = 'name'
const	FIELD_SCOPE = 'scope'
const	FIELD_DELETE_DAYS_AFTER_CREATION = 'deleteDaysAfterCreation'
const	FIELD_ACCESS_TOKEN_VALIDITY_SECONDS = 'accessTokenValiditySeconds'
const	FIELD_REFRESH_TOKEN_VALIDITY_SECONDS = 'refreshTokenValiditySeconds'

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\JsonObject
static	of ($data=null)
static	fromArray (array $data=[])
static	fromStdClass (stdClass $data=null)

Detailed Description

Definition at line 14 of file ApiClientDraft.php.

Member Function Documentation

getAccessTokenValiditySeconds()

Commercetools\Api\Models\ApiClient\ApiClientDraft::getAccessTokenValiditySeconds

(

)

Expiration time in seconds for each access token obtained by the APIClient. If not set the default value applies.

Returns

null|int

Implemented in Commercetools\Api\Models\ApiClient\ApiClientDraftModel.

getDeleteDaysAfterCreation()

Commercetools\Api\Models\ApiClient\ApiClientDraft::getDeleteDaysAfterCreation

(

)

If set, the Client will be deleted after the specified amount of days.

Returns

null|int

Implemented in Commercetools\Api\Models\ApiClient\ApiClientDraftModel.

getName()

Commercetools\Api\Models\ApiClient\ApiClientDraft::getName

(

)

Name of the APIClient.

Returns

null|string

Implemented in Commercetools\Api\Models\ApiClient\ApiClientDraftModel.

getRefreshTokenValiditySeconds()

Commercetools\Api\Models\ApiClient\ApiClientDraft::getRefreshTokenValiditySeconds

(

)

Inactivity expiration time in seconds for each refresh token obtained by the APIClient. The expiration time for refresh tokens is restarted each time the token is used. If not set the default value applies.

Returns

null|int

Implemented in Commercetools\Api\Models\ApiClient\ApiClientDraftModel.

getScope()

Commercetools\Api\Models\ApiClient\ApiClientDraft::getScope

(

)

Whitespace-separated list of OAuth scopes that can be used when obtaining an access token.

Returns

null|string

Implemented in Commercetools\Api\Models\ApiClient\ApiClientDraftModel.

setAccessTokenValiditySeconds()

Commercetools\Api\Models\ApiClient\ApiClientDraft::setAccessTokenValiditySeconds

(

?int

$accessTokenValiditySeconds

)

Parameters

?int	$accessTokenValiditySeconds

Implemented in Commercetools\Api\Models\ApiClient\ApiClientDraftModel.

setDeleteDaysAfterCreation()

Commercetools\Api\Models\ApiClient\ApiClientDraft::setDeleteDaysAfterCreation

(

?int

$deleteDaysAfterCreation

)

Parameters

?int	$deleteDaysAfterCreation

Implemented in Commercetools\Api\Models\ApiClient\ApiClientDraftModel.

setName()

Commercetools\Api\Models\ApiClient\ApiClientDraft::setName

(

?string

$name

)

Parameters

?string

$name

Implemented in Commercetools\Api\Models\ApiClient\ApiClientDraftModel.

setRefreshTokenValiditySeconds()

Commercetools\Api\Models\ApiClient\ApiClientDraft::setRefreshTokenValiditySeconds

(

?int

$refreshTokenValiditySeconds

)

Parameters

?int	$refreshTokenValiditySeconds

Implemented in Commercetools\Api\Models\ApiClient\ApiClientDraftModel.

setScope()

Commercetools\Api\Models\ApiClient\ApiClientDraft::setScope

(

?string

$scope

)

Parameters

?string

$scope

Implemented in Commercetools\Api\Models\ApiClient\ApiClientDraftModel.

Member Data Documentation

FIELD_ACCESS_TOKEN_VALIDITY_SECONDS

const Commercetools\Api\Models\ApiClient\ApiClientDraft::FIELD_ACCESS_TOKEN_VALIDITY_SECONDS = 'accessTokenValiditySeconds'

Definition at line 19 of file ApiClientDraft.php.

FIELD_DELETE_DAYS_AFTER_CREATION

const Commercetools\Api\Models\ApiClient\ApiClientDraft::FIELD_DELETE_DAYS_AFTER_CREATION = 'deleteDaysAfterCreation'

Definition at line 18 of file ApiClientDraft.php.

FIELD_NAME

const Commercetools\Api\Models\ApiClient\ApiClientDraft::FIELD_NAME = 'name'

Definition at line 16 of file ApiClientDraft.php.

FIELD_REFRESH_TOKEN_VALIDITY_SECONDS

const Commercetools\Api\Models\ApiClient\ApiClientDraft::FIELD_REFRESH_TOKEN_VALIDITY_SECONDS = 'refreshTokenValiditySeconds'

Definition at line 20 of file ApiClientDraft.php.

FIELD_SCOPE

const Commercetools\Api\Models\ApiClient\ApiClientDraft::FIELD_SCOPE = 'scope'

Definition at line 17 of file ApiClientDraft.php.

---

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

• lib/commercetools-api/src/Models/ApiClient/ApiClientDraft.php