1. class
  2. Contentful
  3. \
  4. Management
  5. \
  6. Resource
  7. \
  8. DeliveryApiKey

DeliveryApiKey

class DeliveryApiKey extends ApiKey implements CreatableInterface

DeliveryApiKey class.

This class represents a resource with type "ApiKey" in Contentful.

Traits

DeletableTrait
DeletableTrait.
UpdatableTrait
UpdatableTrait.

Properties

SystemProperties $sys from UpdatableTrait
Client $client from UpdatableTrait
protected string $name from ApiKey
protected string|null $description from ApiKey
protected string|null $accessToken from ApiKey
protected Link|null $previewApiKey

Methods

initialize(string $type, array $sys = [])

Initialize system properties.

from BaseResource
getSystemProperties()

{@inheritdoc}

from BaseResource
getId()

{@inheritdoc}

from BaseResource
getType()

{@inheritdoc}

from BaseResource
asLink()

{@inheritdoc}

from BaseResource
mixed
asRequestBody()

Returns the resource in the form of request body.

BaseResource
setClient(Client $client)

Sets the current Client object instance.

from BaseResource
string
getName()

No description

from ApiKey
ApiKey
setName(string $name)

No description

from ApiKey
string|null
getDescription()

No description

from ApiKey
ApiKey
setDescription(string $description)

No description

from ApiKey
string|null
getAccessToken()

No description

from ApiKey
array
jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

delete()

Deletes the current resource.

from DeletableTrait
update()

Deletes the current resource.

from UpdatableTrait
__construct(string $name = '')

ApiKey constructor.

string[]
asUriParameters()

Returns an associate array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

string[]
getHeadersForCreation()

Returns an array of headers that the current resource needs to sent for being created.

Link|null
getPreviewApiKey()

No description

Details

in BaseResource at line 39
protected initialize(string $type, array $sys = [])

Initialize system properties.

Parameters

string $type The system type
array $sys

in BaseResource at line 48
getSystemProperties()

{@inheritdoc}

in BaseResource at line 56
getId()

{@inheritdoc}

in BaseResource at line 64
getType()

{@inheritdoc}

{@inheritdoc}

at line 61
mixed asRequestBody()

Returns the resource in the form of request body.

This can differ from regular serialization, as some fields may not be present in the request payload.

Return Value

mixed

in BaseResource at line 98
BaseResource setClient(Client $client)

Sets the current Client object instance.

This is done automatically when performing API calls, so it shouldn't be used manually.

Parameters

Client $client

Return Value

BaseResource

in ApiKey at line 36
string getName()

Return Value

string

in ApiKey at line 46
ApiKey setName(string $name)

Parameters

string $name

Return Value

ApiKey

in ApiKey at line 56
string|null getDescription()

Return Value

string|null

in ApiKey at line 66
ApiKey setDescription(string $description)

Parameters

string $description

Return Value

ApiKey

in ApiKey at line 76
string|null getAccessToken()

Return Value

string|null

at line 50
array jsonSerialize()

Returns an array to be used by "json_encode" to serialize objects of this class.

Return Value

array

in DeletableTrait at line 29
delete()

Deletes the current resource.

in UpdatableTrait at line 38
update()

Deletes the current resource.

at line 41
__construct(string $name = '')

ApiKey constructor.

Parameters

string $name

at line 75
string[] asUriParameters()

Returns an associate array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.

Return Value

string[]

at line 86
string[] getHeadersForCreation()

Returns an array of headers that the current resource needs to sent for being created.

This method is supposed to be overridden if necessary.

Return Value

string[]

at line 94
Link|null getPreviewApiKey()

Return Value

Link|null