DevicePreviewSharedTargetDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DevicePreviewSharedTargetDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- STATUS_CAPTURING = 'CAPTURING'
- STATUS_FAILED = 'FAILED'
- STATUS_NEEDS_INTERVENTION = 'NEEDS_INTERVENTION'
- STATUS_READY = 'READY'
- STATUS_READY_TO_CAPTURE = 'READY_TO_CAPTURE'
- STATUS_SETUP_REQUIRED = 'SETUP_REQUIRED'
- STATUS_SKIPPED_OFFLINE = 'SKIPPED_OFFLINE'
- STATUS_TIMED_OUT = 'TIMED_OUT'
- STATUS_WAITING = 'WAITING'
- $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
- getBrowserFamily() : string|null
- Gets browser_family
- getClientProfile() : string|null
- Gets client_profile
- getColorScheme() : string|null
- Gets color_scheme
- getCreatedAt() : DateTime
- Gets created_at
- getDeviceType() : string|null
- Gets device_type
- getFailureCode() : string|null
- Gets failure_code
- getId() : string
- Gets id
- getModelName() : string
- The original name of the model.
- getPlatform() : string|null
- Gets platform
- getPrimaryScreenshotId() : string|null
- Gets primary_screenshot_id
- getProvider() : string|null
- Gets provider
- getRunId() : string
- Gets run_id
- getStatus() : string|null
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- 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
- setBrowserFamily() : self
- Sets browser_family
- setClientProfile() : self
- Sets client_profile
- setColorScheme() : self
- Sets color_scheme
- setCreatedAt() : self
- Sets created_at
- setDeviceType() : self
- Sets device_type
- setFailureCode() : self
- Sets failure_code
- setId() : self
- Sets id
- setPlatform() : self
- Sets platform
- setPrimaryScreenshotId() : self
- Sets primary_screenshot_id
- setProvider() : self
- Sets provider
- setRunId() : self
- Sets run_id
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
STATUS_CAPTURING
public
mixed
STATUS_CAPTURING
= 'CAPTURING'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'FAILED'
STATUS_NEEDS_INTERVENTION
public
mixed
STATUS_NEEDS_INTERVENTION
= 'NEEDS_INTERVENTION'
STATUS_READY
public
mixed
STATUS_READY
= 'READY'
STATUS_READY_TO_CAPTURE
public
mixed
STATUS_READY_TO_CAPTURE
= 'READY_TO_CAPTURE'
STATUS_SETUP_REQUIRED
public
mixed
STATUS_SETUP_REQUIRED
= 'SETUP_REQUIRED'
STATUS_SKIPPED_OFFLINE
public
mixed
STATUS_SKIPPED_OFFLINE
= 'SKIPPED_OFFLINE'
STATUS_TIMED_OUT
public
mixed
STATUS_TIMED_OUT
= 'TIMED_OUT'
STATUS_WAITING
public
mixed
STATUS_WAITING
= 'WAITING'
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', 'provider' => 'provider', 'client_profile' => 'clientProfile', 'device_type' => 'deviceType', 'browser_family' => 'browserFamily', 'platform' => 'platform', 'color_scheme' => 'colorScheme', 'status' => 'status', 'failure_code' => 'failureCode', 'primary_screenshot_id' => 'primaryScreenshotId', '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', 'provider' => 'getProvider', 'client_profile' => 'getClientProfile', 'device_type' => 'getDeviceType', 'browser_family' => 'getBrowserFamily', 'platform' => 'getPlatform', 'color_scheme' => 'getColorScheme', 'status' => 'getStatus', 'failure_code' => 'getFailureCode', 'primary_screenshot_id' => 'getPrimaryScreenshotId', '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', 'provider' => null, 'client_profile' => null, 'device_type' => null, 'browser_family' => null, 'platform' => null, 'color_scheme' => null, 'status' => null, 'failure_code' => null, 'primary_screenshot_id' => 'uuid', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DevicePreviewSharedTargetDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['id' => false, 'run_id' => false, 'provider' => true, 'client_profile' => true, 'device_type' => true, 'browser_family' => true, 'platform' => true, 'color_scheme' => true, 'status' => true, 'failure_code' => true, 'primary_screenshot_id' => true, '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', 'provider' => 'string', 'client_profile' => 'string', 'device_type' => 'string', 'browser_family' => 'string', 'platform' => 'string', 'color_scheme' => 'string', 'status' => 'string', 'failure_code' => 'string', 'primary_screenshot_id' => 'string', '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', 'provider' => 'setProvider', 'client_profile' => 'setClientProfile', 'device_type' => 'setDeviceType', 'browser_family' => 'setBrowserFamily', 'platform' => 'setPlatform', 'color_scheme' => 'setColorScheme', 'status' => 'setStatus', 'failure_code' => 'setFailureCode', 'primary_screenshot_id' => 'setPrimaryScreenshotId', '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> —getBrowserFamily()
Gets browser_family
public
getBrowserFamily() : string|null
Return values
string|null —getClientProfile()
Gets client_profile
public
getClientProfile() : string|null
Return values
string|null —getColorScheme()
Gets color_scheme
public
getColorScheme() : string|null
Return values
string|null —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getDeviceType()
Gets device_type
public
getDeviceType() : string|null
Return values
string|null —getFailureCode()
Gets failure_code
public
getFailureCode() : string|null
Return values
string|null —getId()
Gets id
public
getId() : string
Return values
string —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPlatform()
Gets platform
public
getPlatform() : string|null
Return values
string|null —getPrimaryScreenshotId()
Gets primary_screenshot_id
public
getPrimaryScreenshotId() : string|null
Return values
string|null —getProvider()
Gets provider
public
getProvider() : string|null
Return values
string|null —getRunId()
Gets run_id
public
getRunId() : string
Return values
string —getStatus()
Gets status
public
getStatus() : string|null
Return values
string|null —getStatusAllowableValues()
Gets allowable values of the enum
public
getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —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> —setBrowserFamily()
Sets browser_family
public
setBrowserFamily(string|null $browser_family) : self
Parameters
- $browser_family : string|null
-
browser_family
Return values
self —setClientProfile()
Sets client_profile
public
setClientProfile(string|null $client_profile) : self
Parameters
- $client_profile : string|null
-
client_profile
Return values
self —setColorScheme()
Sets color_scheme
public
setColorScheme(string|null $color_scheme) : self
Parameters
- $color_scheme : string|null
-
color_scheme
Return values
self —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setDeviceType()
Sets device_type
public
setDeviceType(string|null $device_type) : self
Parameters
- $device_type : string|null
-
device_type
Return values
self —setFailureCode()
Sets failure_code
public
setFailureCode(string|null $failure_code) : self
Parameters
- $failure_code : string|null
-
failure_code
Return values
self —setId()
Sets id
public
setId(string $id) : self
Parameters
- $id : string
-
id
Return values
self —setPlatform()
Sets platform
public
setPlatform(string|null $platform) : self
Parameters
- $platform : string|null
-
platform
Return values
self —setPrimaryScreenshotId()
Sets primary_screenshot_id
public
setPrimaryScreenshotId(string|null $primary_screenshot_id) : self
Parameters
- $primary_screenshot_id : string|null
-
primary_screenshot_id
Return values
self —setProvider()
Sets provider
public
setProvider(string|null $provider) : self
Parameters
- $provider : string|null
-
provider
Return values
self —setRunId()
Sets run_id
public
setRunId(string $run_id) : self
Parameters
- $run_id : string
-
run_id
Return values
self —setStatus()
Sets status
public
setStatus(string|null $status) : self
Parameters
- $status : string|null
-
status
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> —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>