Commercetools\Api\Models\Channel\ChannelDraft Interface Reference

Inheritance diagram for Commercetools\Api\Models\Channel\ChannelDraft:

Public Member Functions
	getKey ()
	getRoles ()
	getName ()
	getDescription ()
	getAddress ()
	getCustom ()
	getGeoLocation ()
	setKey (?string $key)
	setRoles (?array $roles)
	setName (?LocalizedString $name)
	setDescription (?LocalizedString $description)
	setAddress (?BaseAddress $address)
	setCustom (?CustomFieldsDraft $custom)
	setGeoLocation (?GeoJson $geoLocation)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (callable $callable=null)

Public Attributes
const	FIELD_KEY = 'key'
const	FIELD_ROLES = 'roles'
const	FIELD_NAME = 'name'
const	FIELD_DESCRIPTION = 'description'
const	FIELD_ADDRESS = 'address'
const	FIELD_CUSTOM = 'custom'
const	FIELD_GEO_LOCATION = 'geoLocation'

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 18 of file ChannelDraft.php.

Member Function Documentation

getAddress()

Commercetools\Api\Models\Channel\ChannelDraft::getAddress

(

)

Address where the Channel is located.

Returns

null|BaseAddress

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

getCustom()

Commercetools\Api\Models\Channel\ChannelDraft::getCustom

(

)

Custom fields defined for the Channel.

Returns

null|CustomFieldsDraft

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

getDescription()

Commercetools\Api\Models\Channel\ChannelDraft::getDescription

(

)

Description of the Channel.

Returns

null|LocalizedString

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

getGeoLocation()

Commercetools\Api\Models\Channel\ChannelDraft::getGeoLocation

(

)

GeoJSON geometry object encoding the geo location of the Channel. Currently, only the Point type is supported.

Returns

null|GeoJson

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

getKey()

Commercetools\Api\Models\Channel\ChannelDraft::getKey

(

)

User-defined unique identifier for the Channel.

Returns

null|string

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

getName()

Commercetools\Api\Models\Channel\ChannelDraft::getName

(

)

Name of the Channel.

Returns

null|LocalizedString

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

getRoles()

Commercetools\Api\Models\Channel\ChannelDraft::getRoles

(

)

Roles of the Channel. Each channel must have at least one role. If not specified, then InventorySupply is assigned by default.

Returns

null|array

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

setAddress()

Commercetools\Api\Models\Channel\ChannelDraft::setAddress

(

?BaseAddress

$address

)

Parameters

?BaseAddress

$address

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

setCustom()

Commercetools\Api\Models\Channel\ChannelDraft::setCustom

(

?CustomFieldsDraft

$custom

)

Parameters

?CustomFieldsDraft

$custom

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

setDescription()

Commercetools\Api\Models\Channel\ChannelDraft::setDescription

(

?LocalizedString

$description

)

Parameters

?LocalizedString

$description

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

setGeoLocation()

Commercetools\Api\Models\Channel\ChannelDraft::setGeoLocation

(

?GeoJson

$geoLocation

)

Parameters

?GeoJson

$geoLocation

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

setKey()

Commercetools\Api\Models\Channel\ChannelDraft::setKey

(

?string

$key

)

Parameters

?string

$key

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

setName()

Commercetools\Api\Models\Channel\ChannelDraft::setName

(

?LocalizedString

$name

)

Parameters

?LocalizedString

$name

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

setRoles()

Commercetools\Api\Models\Channel\ChannelDraft::setRoles

(

?array

$roles

)

Parameters

?array

$roles

Implemented in Commercetools\Api\Models\Channel\ChannelDraftModel.

Member Data Documentation

FIELD_ADDRESS

const Commercetools\Api\Models\Channel\ChannelDraft::FIELD_ADDRESS = 'address'

Definition at line 24 of file ChannelDraft.php.

FIELD_CUSTOM

const Commercetools\Api\Models\Channel\ChannelDraft::FIELD_CUSTOM = 'custom'

Definition at line 25 of file ChannelDraft.php.

FIELD_DESCRIPTION

const Commercetools\Api\Models\Channel\ChannelDraft::FIELD_DESCRIPTION = 'description'

Definition at line 23 of file ChannelDraft.php.

FIELD_GEO_LOCATION

const Commercetools\Api\Models\Channel\ChannelDraft::FIELD_GEO_LOCATION = 'geoLocation'

Definition at line 26 of file ChannelDraft.php.

FIELD_KEY

const Commercetools\Api\Models\Channel\ChannelDraft::FIELD_KEY = 'key'

Definition at line 20 of file ChannelDraft.php.

FIELD_NAME

const Commercetools\Api\Models\Channel\ChannelDraft::FIELD_NAME = 'name'

Definition at line 22 of file ChannelDraft.php.

FIELD_ROLES

const Commercetools\Api\Models\Channel\ChannelDraft::FIELD_ROLES = 'roles'

Definition at line 21 of file ChannelDraft.php.

---

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

• lib/commercetools-api/src/Models/Channel/ChannelDraft.php