DeliveryApiKey
class DeliveryApiKey extends ApiKey implements CreatableInterface
DeliveryApiKey class.
This class represents a resource with type "ApiKey" in Contentful.
Traits
Properties
| protected ApiKey | $sys | from ApiKey | |
| Client | $client | from UpdatableTrait | |
| protected string | $name | from ApiKey | |
| protected string|null | $description | from ApiKey | |
| protected string|null | $accessToken | from ApiKey | |
| protected Link[] | $environments | from ApiKey | |
| protected Link | $previewApiKey |
Methods
Returns the resource in the form of request body.
{@inheritdoc}
ApiKey constructor.
Returns an associative array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.
Returns an array of headers that the current resource needs to sent for being created.
No description
Details
in BaseResource at line 37 getId()
{@inheritdoc}
in BaseResource at line 45 getType()
{@inheritdoc}
in BaseResource at line 53 asLink()
{@inheritdoc}
at line 59 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.
in BaseResource at line 77 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.
in UpdatableTrait at line 26 VersionableSystemPropertiesInterface getSystemProperties()
in ApiKey at line 55 getName()
in ApiKey at line 73 string|null getDescription()
in ApiKey at line 91 string|null getAccessToken()
at line 48 jsonSerialize()
{@inheritdoc}
in ApiKey at line 125 Link[] getEnvironments()
in DeletableTrait at line 28 delete()
Deletes the current resource.
in UpdatableTrait at line 40 update()
Updates the current resource.
at line 40 __construct(string $name = '')
ApiKey constructor.
at line 77 string[] asUriParameters()
Returns an associative array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.
at line 88 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.