Commercetools\Api\Models\CustomObject\CustomObjectDraft Interface Reference

Inheritance diagram for Commercetools\Api\Models\CustomObject\CustomObjectDraft:

Public Member Functions
	getContainer ()
	getKey ()
	getValue ()
	getVersion ()
	setContainer (?string $container)
	setKey (?string $key)
	setValue ($value)
	setVersion (?int $version)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (callable $callable=null)

Public Attributes
const	FIELD_CONTAINER = 'container'
const	FIELD_KEY = 'key'
const	FIELD_VALUE = 'value'
const	FIELD_VERSION = 'version'

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

Member Function Documentation

getContainer()

Commercetools\Api\Models\CustomObject\CustomObjectDraft::getContainer

(

)

Namespace to group CustomObjects.

Returns

null|string

Implemented in Commercetools\Api\Models\CustomObject\CustomObjectDraftModel.

getKey()

Commercetools\Api\Models\CustomObject\CustomObjectDraft::getKey

(

)

User-defined unique identifier of the CustomObject within the defined container.

Returns

null|string

Implemented in Commercetools\Api\Models\CustomObject\CustomObjectDraftModel.

getValue()

Commercetools\Api\Models\CustomObject\CustomObjectDraft::getValue

(

)

JSON standard types Number, String, Boolean, Array, Object, and common API data types. For values of type Reference the integrity of the data is not guaranteed. If the referenced object is deleted, the API does not delete the corresponding reference to it and the value points to a non-existing object in such case.

Returns

null|mixed

Implemented in Commercetools\Api\Models\CustomObject\CustomObjectDraftModel.

getVersion()

Commercetools\Api\Models\CustomObject\CustomObjectDraft::getVersion

(

)

Current version of the CustomObject.

Returns

null|int

Implemented in Commercetools\Api\Models\CustomObject\CustomObjectDraftModel.

setContainer()

Commercetools\Api\Models\CustomObject\CustomObjectDraft::setContainer

(

?string

$container

)

Parameters

?string

$container

Implemented in Commercetools\Api\Models\CustomObject\CustomObjectDraftModel.

setKey()

Commercetools\Api\Models\CustomObject\CustomObjectDraft::setKey

(

?string

$key

)

Parameters

?string

$key

Implemented in Commercetools\Api\Models\CustomObject\CustomObjectDraftModel.

setValue()

Commercetools\Api\Models\CustomObject\CustomObjectDraft::setValue

(

$value

)

Parameters

mixed

$value

Implemented in Commercetools\Api\Models\CustomObject\CustomObjectDraftModel.

setVersion()

Commercetools\Api\Models\CustomObject\CustomObjectDraft::setVersion

(

?int

$version

)

Parameters

?int

$version

Implemented in Commercetools\Api\Models\CustomObject\CustomObjectDraftModel.

Member Data Documentation

FIELD_CONTAINER

const Commercetools\Api\Models\CustomObject\CustomObjectDraft::FIELD_CONTAINER = 'container'

Definition at line 16 of file CustomObjectDraft.php.

FIELD_KEY

const Commercetools\Api\Models\CustomObject\CustomObjectDraft::FIELD_KEY = 'key'

Definition at line 17 of file CustomObjectDraft.php.

FIELD_VALUE

const Commercetools\Api\Models\CustomObject\CustomObjectDraft::FIELD_VALUE = 'value'

Definition at line 18 of file CustomObjectDraft.php.

FIELD_VERSION

const Commercetools\Api\Models\CustomObject\CustomObjectDraft::FIELD_VERSION = 'version'

Definition at line 19 of file CustomObjectDraft.php.

---

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

• lib/commercetools-api/src/Models/CustomObject/CustomObjectDraft.php