PreviewApiKey
class PreviewApiKey extends ApiKey
PreviewApiKey class.
This class represents a resource with type "PreviewApiKey" in Contentful.
Properties
| protected ApiKey | $sys | from ApiKey | |
| protected Client|null | $client | from BaseResource | |
| protected string | $name | from ApiKey | |
| protected string|null | $description | from ApiKey | |
| protected string|null | $accessToken | from ApiKey | |
| protected Link[] | $environments | from ApiKey |
Methods
Returns the resource in the form of request body.
Returns an associative array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.
Details
in BaseResource at line 37
getId()
{@inheritdoc}
in BaseResource at line 45
getType()
{@inheritdoc}
in BaseResource at line 53
asLink()
{@inheritdoc}
at line 33
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 ApiKey at line 50
getSystemProperties()
{@inheritdoc}
in ApiKey at line 55
getName()
in ApiKey at line 73
string|null
getDescription()
in ApiKey at line 91
string|null
getAccessToken()
in ApiKey at line 99
jsonSerialize()
{@inheritdoc}
in ApiKey at line 125
Link[]
getEnvironments()
at line 41
string[]
asUriParameters()
Returns an associative array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.