DevicePreviewShareLinkDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DevicePreviewShareLinkDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $openAPIFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string|int, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getAccessCount() : int
- Gets access_count
- getCreatedAt() : DateTime
- Gets created_at
- getExpiresAt() : DateTime|null
- Gets expires_at
- getId() : string
- Gets id
- getLabel() : string|null
- Gets label
- getLastAccessedAt() : DateTime|null
- Gets last_accessed_at
- getModelName() : string
- The original name of the model.
- getRevokedAt() : DateTime|null
- Gets revoked_at
- getRunId() : string
- Gets run_id
- getShareUrl() : string|null
- Gets share_url
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getToken() : string|null
- Gets token
- getTokenPrefix() : string
- Gets token_prefix
- getUpdatedAt() : DateTime
- Gets updated_at
- isNullable() : bool
- Checks if a property is nullable
- isNullableSetToNull() : bool
- Checks if a nullable property is set to null.
- jsonSerialize() : mixed
- Serializes the object to a value that can be serialized natively by json_encode().
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed|null
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- openAPIFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- setAccessCount() : self
- Sets access_count
- setCreatedAt() : self
- Sets created_at
- setExpiresAt() : self
- Sets expires_at
- setId() : self
- Sets id
- setLabel() : self
- Sets label
- setLastAccessedAt() : self
- Sets last_accessed_at
- setRevokedAt() : self
- Sets revoked_at
- setRunId() : self
- Sets run_id
- setShareUrl() : self
- Sets share_url
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setToken() : self
- Sets token
- setTokenPrefix() : self
- Sets token_prefix
- setUpdatedAt() : self
- Sets updated_at
- toHeaderValue() : string
- Gets a header-safe presentation of the object
- valid() : bool
- Validate all the properties in the model return true if all passed
- openAPINullables() : array<string|int, mixed>
- Array of nullable properties
- getOpenAPINullablesSetToNull() : array<string|int, bool>
- Array of nullable field names deliberately set to null
- setIfExists() : void
- Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['id' => 'id', 'run_id' => 'runId', 'token_prefix' => 'tokenPrefix', 'token' => 'token', 'share_url' => 'shareUrl', 'label' => 'label', 'expires_at' => 'expiresAt', 'revoked_at' => 'revokedAt', 'last_accessed_at' => 'lastAccessedAt', 'access_count' => 'accessCount', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['id' => 'getId', 'run_id' => 'getRunId', 'token_prefix' => 'getTokenPrefix', 'token' => 'getToken', 'share_url' => 'getShareUrl', 'label' => 'getLabel', 'expires_at' => 'getExpiresAt', 'revoked_at' => 'getRevokedAt', 'last_accessed_at' => 'getLastAccessedAt', 'access_count' => 'getAccessCount', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'uuid', 'run_id' => 'uuid', 'token_prefix' => null, 'token' => null, 'share_url' => null, 'label' => null, 'expires_at' => 'date-time', 'revoked_at' => 'date-time', 'last_accessed_at' => 'date-time', 'access_count' => 'int64', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DevicePreviewShareLinkDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'run_id' => false, 'token_prefix' => false, 'token' => true, 'share_url' => true, 'label' => true, 'expires_at' => true, 'revoked_at' => true, 'last_accessed_at' => true, 'access_count' => false, 'created_at' => false, 'updated_at' => false]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['id' => 'string', 'run_id' => 'string', 'token_prefix' => 'string', 'token' => 'string', 'share_url' => 'string', 'label' => 'string', 'expires_at' => '\\DateTime', 'revoked_at' => '\\DateTime', 'last_accessed_at' => '\\DateTime', 'access_count' => 'int', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'run_id' => 'setRunId', 'token_prefix' => 'setTokenPrefix', 'token' => 'setToken', 'share_url' => 'setShareUrl', 'label' => 'setLabel', 'expires_at' => 'setExpiresAt', 'revoked_at' => 'setRevokedAt', 'last_accessed_at' => 'setLastAccessedAt', 'access_count' => 'setAccessCount', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt']
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAccessCount()
Gets access_count
public
getAccessCount() : int
Return values
int —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getExpiresAt()
Gets expires_at
public
getExpiresAt() : DateTime|null
Return values
DateTime|null —getId()
Gets id
public
getId() : string
Return values
string —getLabel()
Gets label
public
getLabel() : string|null
Return values
string|null —getLastAccessedAt()
Gets last_accessed_at
public
getLastAccessedAt() : DateTime|null
Return values
DateTime|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRevokedAt()
Gets revoked_at
public
getRevokedAt() : DateTime|null
Return values
DateTime|null —getRunId()
Gets run_id
public
getRunId() : string
Return values
string —getShareUrl()
Gets share_url
public
getShareUrl() : string|null
Return values
string|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getToken()
Gets token
public
getToken() : string|null
Return values
string|null —getTokenPrefix()
Gets token_prefix
public
getTokenPrefix() : string
Return values
string —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
Offset
- $value : mixed
-
Value to be set
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Return values
void —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setAccessCount()
Sets access_count
public
setAccessCount(int $access_count) : self
Parameters
- $access_count : int
-
access_count
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setExpiresAt()
Sets expires_at
public
setExpiresAt(DateTime|null $expires_at) : self
Parameters
- $expires_at : DateTime|null
-
expires_at
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setLabel()
Sets label
public
setLabel(string|null $label) : self
Parameters
- $label : string|null
-
label
Return values
self —setLastAccessedAt()
Sets last_accessed_at
public
setLastAccessedAt(DateTime|null $last_accessed_at) : self
Parameters
- $last_accessed_at : DateTime|null
-
last_accessed_at
Return values
self —setRevokedAt()
Sets revoked_at
public
setRevokedAt(DateTime|null $revoked_at) : self
Parameters
- $revoked_at : DateTime|null
-
revoked_at
Return values
self —setRunId()
Sets run_id
public
setRunId(string $run_id) : self
Parameters
- $run_id : string
-
run_id
Return values
self —setShareUrl()
Sets share_url
public
setShareUrl(string|null $share_url) : self
Parameters
- $share_url : string|null
-
Public share URL with social preview metadata. Only returned when the raw token is available.
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setToken()
Sets token
public
setToken(string|null $token) : self
Parameters
- $token : string|null
-
Raw share token. Only returned immediately after creation.
Return values
self —setTokenPrefix()
Sets token_prefix
public
setTokenPrefix(string $token_prefix) : self
Parameters
- $token_prefix : string
-
token_prefix
Return values
self —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
updated_at
Return values
self —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Return values
bool —True if all properties are valid
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string|int, bool>
Return values
array<string|int, bool> —setIfExists()
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
private
setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed
Return values
void —setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string|int, bool>