ApiKey
class ApiKey extends BaseResource
ApiKey class.
Properties
| protected SystemProperties | $sys | from BaseResource | |
| protected Client|null | $client | from BaseResource | |
| protected string | $name | ||
| protected string|null | $description | ||
| protected string|null | $accessToken |
Methods
string
getName()
No description
string|null
getDescription()
No description
setDescription(string $description)
No description
string|null
getAccessToken()
No description
array
jsonSerialize()
Returns an array to be used by "json_encode" to serialize objects of this class.
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}
in BaseResource at line 80
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.
at line 36
string
getName()
at line 46
ApiKey
setName(string $name)
at line 56
string|null
getDescription()
at line 66
ApiKey
setDescription(string $description)
at line 76
string|null
getAccessToken()
at line 86
array
jsonSerialize()
Returns an array to be used by "json_encode" to serialize objects of this class.