PreviewApiKey
class PreviewApiKey extends ApiKey
PreviewApiKey class.
This class represents a resource with type "PreviewApiKey" in Contentful.
Properties
| protected SystemProperties | $sys | from BaseResource | |
| protected BaseProxy | $proxy | from BaseResource | |
| protected string | $name | from ApiKey | |
| protected string|null | $description | from ApiKey | |
| protected string|null | $accessToken | from ApiKey |
Methods
PreviewApiKey constructor.
Returns the resource's system properties, defined in the object "sys" in Contentful's responses.
Shortcut for accessing the resource ID through its system properties.
{@inheritdoc}
Shortcut for forwarding methods to the current proxy, using the current object as argument.
Returns an array to be used by "json_encode" to serialize objects of this class.
Details
at line 24
final
__construct()
PreviewApiKey constructor.
in BaseResource at line 47
SystemProperties
getSystemProperties()
Returns the resource's system properties, defined in the object "sys" in Contentful's responses.
in BaseResource at line 57
string|null
getId()
Shortcut for accessing the resource ID through its system properties.
in BaseResource at line 65
Link
asLink()
Creates a Link representation of the current resource.
in BaseResource at line 79
BaseResource
setProxy(BaseProxy $proxy)
Sets the current BaseProxy object instance.
This is done automatically when performing API calls, so it shouldn't be used manually.
at line 35
asRequestBody()
{@inheritdoc}
in BaseResource at line 111
__call(string $name, array $arguments)
Shortcut for forwarding methods to the current proxy, using the current object as argument.
// Instead of
$client->asset->publish($asset);
// You can use
$asset->publish();
in ApiKey at line 35
string
getName()
in ApiKey at line 55
string|null
getDescription()
in ApiKey at line 75
string|null
getAccessToken()
in ApiKey at line 85
array
jsonSerialize()
Returns an array to be used by "json_encode" to serialize objects of this class.