Commercetools\Api\Models\Subscription\SubscriptionDraft Interface Reference

Inheritance diagram for Commercetools\Api\Models\Subscription\SubscriptionDraft:

Public Member Functions
	getChanges ()
	getDestination ()
	getKey ()
	getMessages ()
	getFormat ()
	setChanges (?ChangeSubscriptionCollection $changes)
	setDestination (?Destination $destination)
	setKey (?string $key)
	setMessages (?MessageSubscriptionCollection $messages)
	setFormat (?DeliveryFormat $format)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (callable $callable=null)

Public Attributes
const	FIELD_CHANGES = 'changes'
const	FIELD_DESTINATION = 'destination'
const	FIELD_KEY = 'key'
const	FIELD_MESSAGES = 'messages'
const	FIELD_FORMAT = 'format'

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

Member Function Documentation

getChanges()

Commercetools\Api\Models\Subscription\SubscriptionDraft::getChanges

(

)

Change notifications to be subscribed to.

Returns

null|ChangeSubscriptionCollection

Implemented in Commercetools\Api\Models\Subscription\SubscriptionDraftModel.

getDestination()

Commercetools\Api\Models\Subscription\SubscriptionDraft::getDestination

(

)

Messaging service to which the messages are sent.

Returns

null|Destination

Implemented in Commercetools\Api\Models\Subscription\SubscriptionDraftModel.

getFormat()

Commercetools\Api\Models\Subscription\SubscriptionDraft::getFormat

(

)

Format in which the payload is delivered. When not provided, the PlatformFormat is selected by default.

Returns

null|DeliveryFormat

Implemented in Commercetools\Api\Models\Subscription\SubscriptionDraftModel.

getKey()

Commercetools\Api\Models\Subscription\SubscriptionDraft::getKey

(

)

User-defined unique identifier for the Subscription.

Returns

null|string

Implemented in Commercetools\Api\Models\Subscription\SubscriptionDraftModel.

getMessages()

Commercetools\Api\Models\Subscription\SubscriptionDraft::getMessages

(

)

Messages to be subscribed to.

Returns

null|MessageSubscriptionCollection

Implemented in Commercetools\Api\Models\Subscription\SubscriptionDraftModel.

setChanges()

Commercetools\Api\Models\Subscription\SubscriptionDraft::setChanges

(

?ChangeSubscriptionCollection

$changes

)

Parameters

?ChangeSubscriptionCollection

$changes

Implemented in Commercetools\Api\Models\Subscription\SubscriptionDraftModel.

setDestination()

Commercetools\Api\Models\Subscription\SubscriptionDraft::setDestination

(

?Destination

$destination

)

Parameters

?Destination

$destination

Implemented in Commercetools\Api\Models\Subscription\SubscriptionDraftModel.

setFormat()

Commercetools\Api\Models\Subscription\SubscriptionDraft::setFormat

(

?DeliveryFormat

$format

)

Parameters

?DeliveryFormat

$format

Implemented in Commercetools\Api\Models\Subscription\SubscriptionDraftModel.

setKey()

Commercetools\Api\Models\Subscription\SubscriptionDraft::setKey

(

?string

$key

)

Parameters

?string

$key

Implemented in Commercetools\Api\Models\Subscription\SubscriptionDraftModel.

setMessages()

Commercetools\Api\Models\Subscription\SubscriptionDraft::setMessages

(

?MessageSubscriptionCollection

$messages

)

Parameters

?MessageSubscriptionCollection

$messages

Implemented in Commercetools\Api\Models\Subscription\SubscriptionDraftModel.

Member Data Documentation

FIELD_CHANGES

const Commercetools\Api\Models\Subscription\SubscriptionDraft::FIELD_CHANGES = 'changes'

Definition at line 16 of file SubscriptionDraft.php.

FIELD_DESTINATION

const Commercetools\Api\Models\Subscription\SubscriptionDraft::FIELD_DESTINATION = 'destination'

Definition at line 17 of file SubscriptionDraft.php.

FIELD_FORMAT

const Commercetools\Api\Models\Subscription\SubscriptionDraft::FIELD_FORMAT = 'format'

Definition at line 20 of file SubscriptionDraft.php.

FIELD_KEY

const Commercetools\Api\Models\Subscription\SubscriptionDraft::FIELD_KEY = 'key'

Definition at line 18 of file SubscriptionDraft.php.

FIELD_MESSAGES

const Commercetools\Api\Models\Subscription\SubscriptionDraft::FIELD_MESSAGES = 'messages'

Definition at line 19 of file SubscriptionDraft.php.

---

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

• lib/commercetools-api/src/Models/Subscription/SubscriptionDraft.php