PreviewApiKey
class PreviewApiKey extends ApiKey
PreviewApiKey class.
This class represents a resource with type "PreviewApiKey" in Contentful.
Properties
| protected SystemProperties | $sys | from BaseResource | |
| protected Client|null | $client | from BaseResource | |
| protected string | $name | from ApiKey | |
| protected string|null | $description | from ApiKey | |
| protected string|null | $accessToken | from ApiKey |
Methods
Returns the resource in the form of request body.
Returns an array to be used by "json_encode" to serialize objects of this class.
Returns an associate array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.
Details
in BaseResource at line 39
protected
initialize(string $type, array $sys = [])
Initialize system properties.
in BaseResource at line 48
getSystemProperties()
{@inheritdoc}
in BaseResource at line 56
getId()
{@inheritdoc}
in BaseResource at line 64
getType()
{@inheritdoc}
in BaseResource at line 72
asLink()
{@inheritdoc}
at line 32
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 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.
in ApiKey at line 36
string
getName()
in ApiKey at line 56
string|null
getDescription()
in ApiKey at line 76
string|null
getAccessToken()
in ApiKey at line 86
array
jsonSerialize()
Returns an array to be used by "json_encode" to serialize objects of this class.
at line 43
string[]
asUriParameters()
Returns an associate array where keys are the name of the fragments in a URI, and the values are the corresponding IDs.