Commercetools\Api\Models\Extension\ExtensionDraft Interface Reference

Inheritance diagram for Commercetools\Api\Models\Extension\ExtensionDraft:

Public Member Functions
	getKey ()
	getDestination ()
	getTriggers ()
	getTimeoutInMs ()
	setKey (?string $key)
	setDestination (?ExtensionDestination $destination)
	setTriggers (?ExtensionTriggerCollection $triggers)
	setTimeoutInMs (?int $timeoutInMs)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (callable $callable=null)

Public Attributes
const	FIELD_KEY = 'key'
const	FIELD_DESTINATION = 'destination'
const	FIELD_TRIGGERS = 'triggers'
const	FIELD_TIMEOUT_IN_MS = 'timeoutInMs'

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 ExtensionDraft.php.

Member Function Documentation

getDestination()

Commercetools\Api\Models\Extension\ExtensionDraft::getDestination

(

)

Defines where the Extension can be reached.

Returns

null|ExtensionDestination

Implemented in Commercetools\Api\Models\Extension\ExtensionDraftModel.

getKey()

Commercetools\Api\Models\Extension\ExtensionDraft::getKey

(

)

User-defined unique identifier for the Extension.

Returns

null|string

Implemented in Commercetools\Api\Models\Extension\ExtensionDraftModel.

getTimeoutInMs()

Commercetools\Api\Models\Extension\ExtensionDraft::getTimeoutInMs

(

)

Maximum time (in milliseconds) the Extension can respond within. If no timeout is provided, the default value is used for all types of Extensions. The maximum value is 10000 ms (10 seconds) for payment Extensions and 2000 ms (2 seconds) for all other Extensions.

This limit can be increased per Project after we review the performance impact. Please contact our support via the Support Portal and provide the Region, Project key, and use case.

Returns

null|int

Implemented in Commercetools\Api\Models\Extension\ExtensionDraftModel.

getTriggers()

Commercetools\Api\Models\Extension\ExtensionDraft::getTriggers

(

)

Describes what triggers the Extension.

Returns

null|ExtensionTriggerCollection

Implemented in Commercetools\Api\Models\Extension\ExtensionDraftModel.

setDestination()

Commercetools\Api\Models\Extension\ExtensionDraft::setDestination

(

?ExtensionDestination

$destination

)

Parameters

?ExtensionDestination

$destination

Implemented in Commercetools\Api\Models\Extension\ExtensionDraftModel.

setKey()

Commercetools\Api\Models\Extension\ExtensionDraft::setKey

(

?string

$key

)

Parameters

?string

$key

Implemented in Commercetools\Api\Models\Extension\ExtensionDraftModel.

setTimeoutInMs()

Commercetools\Api\Models\Extension\ExtensionDraft::setTimeoutInMs

(

?int

$timeoutInMs

)

Parameters

?int	$timeoutInMs

Implemented in Commercetools\Api\Models\Extension\ExtensionDraftModel.

setTriggers()

Commercetools\Api\Models\Extension\ExtensionDraft::setTriggers

(

?ExtensionTriggerCollection

$triggers

)

Parameters

?ExtensionTriggerCollection

$triggers

Implemented in Commercetools\Api\Models\Extension\ExtensionDraftModel.

Member Data Documentation

FIELD_DESTINATION

const Commercetools\Api\Models\Extension\ExtensionDraft::FIELD_DESTINATION = 'destination'

Definition at line 17 of file ExtensionDraft.php.

FIELD_KEY

const Commercetools\Api\Models\Extension\ExtensionDraft::FIELD_KEY = 'key'

Definition at line 16 of file ExtensionDraft.php.

FIELD_TIMEOUT_IN_MS

const Commercetools\Api\Models\Extension\ExtensionDraft::FIELD_TIMEOUT_IN_MS = 'timeoutInMs'

Definition at line 19 of file ExtensionDraft.php.

FIELD_TRIGGERS

const Commercetools\Api\Models\Extension\ExtensionDraft::FIELD_TRIGGERS = 'triggers'

Definition at line 18 of file ExtensionDraft.php.

---

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

• lib/commercetools-api/src/Models/Extension/ExtensionDraft.php