Documentation

DevicePreviewScreenshotDto
in package
implements ModelInterface, ArrayAccess, JsonSerializable

DevicePreviewScreenshotDto Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

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
getAccessUrl()  : string|null
Gets access_url
getBrowserContextId()  : string|null
Gets browser_context_id
getCreatedAt()  : DateTime
Gets created_at
getDeepLinkUrl()  : string|null
Gets deep_link_url
getDescription()  : string|null
Gets description
getDisplayOrder()  : int
Gets display_order
getHeight()  : int|null
Gets height
getIsPrimary()  : bool
Gets is_primary
getLiveViewUrl()  : string|null
Gets live_view_url
getModelName()  : string
The original name of the model.
getRunId()  : string
Gets run_id
getScreenshotId()  : string
Gets screenshot_id
getSessionId()  : string|null
Gets session_id
getStorageBucket()  : string|null
Gets storage_bucket
getStorageEndpoint()  : string|null
Gets storage_endpoint
getStorageKey()  : string|null
Gets storage_key
getStorageObjectKey()  : string|null
Gets storage_object_key
getStorageProvider()  : string|null
Gets storage_provider
getStoragePublicBaseUrl()  : string|null
Gets storage_public_base_url
getStorageRegion()  : string|null
Gets storage_region
getTargetId()  : string|null
Gets target_id
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTitle()  : string|null
Gets title
getUpdatedAt()  : DateTime
Gets updated_at
getVariant()  : string|null
Gets variant
getWidth()  : int|null
Gets width
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
setAccessUrl()  : self
Sets access_url
setBrowserContextId()  : self
Sets browser_context_id
setCreatedAt()  : self
Sets created_at
setDeepLinkUrl()  : self
Sets deep_link_url
setDescription()  : self
Sets description
setDisplayOrder()  : self
Sets display_order
setHeight()  : self
Sets height
setIsPrimary()  : self
Sets is_primary
setLiveViewUrl()  : self
Sets live_view_url
setRunId()  : self
Sets run_id
setScreenshotId()  : self
Sets screenshot_id
setSessionId()  : self
Sets session_id
setStorageBucket()  : self
Sets storage_bucket
setStorageEndpoint()  : self
Sets storage_endpoint
setStorageKey()  : self
Sets storage_key
setStorageObjectKey()  : self
Sets storage_object_key
setStorageProvider()  : self
Sets storage_provider
setStoragePublicBaseUrl()  : self
Sets storage_public_base_url
setStorageRegion()  : self
Sets storage_region
setTargetId()  : self
Sets target_id
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTitle()  : self
Sets title
setUpdatedAt()  : self
Sets updated_at
setVariant()  : self
Sets variant
setWidth()  : self
Sets width
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

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 = ['screenshot_id' => 'screenshotId', 'run_id' => 'runId', 'target_id' => 'targetId', 'variant' => 'variant', 'title' => 'title', 'description' => 'description', 'is_primary' => 'isPrimary', 'display_order' => 'displayOrder', 'storage_key' => 'storageKey', 'storage_provider' => 'storageProvider', 'storage_bucket' => 'storageBucket', 'storage_object_key' => 'storageObjectKey', 'storage_region' => 'storageRegion', 'storage_endpoint' => 'storageEndpoint', 'storage_public_base_url' => 'storagePublicBaseUrl', 'access_url' => 'accessUrl', 'live_view_url' => 'liveViewUrl', 'session_id' => 'sessionId', 'browser_context_id' => 'browserContextId', 'deep_link_url' => 'deepLinkUrl', 'width' => 'width', 'height' => 'height', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['screenshot_id' => 'getScreenshotId', 'run_id' => 'getRunId', 'target_id' => 'getTargetId', 'variant' => 'getVariant', 'title' => 'getTitle', 'description' => 'getDescription', 'is_primary' => 'getIsPrimary', 'display_order' => 'getDisplayOrder', 'storage_key' => 'getStorageKey', 'storage_provider' => 'getStorageProvider', 'storage_bucket' => 'getStorageBucket', 'storage_object_key' => 'getStorageObjectKey', 'storage_region' => 'getStorageRegion', 'storage_endpoint' => 'getStorageEndpoint', 'storage_public_base_url' => 'getStoragePublicBaseUrl', 'access_url' => 'getAccessUrl', 'live_view_url' => 'getLiveViewUrl', 'session_id' => 'getSessionId', 'browser_context_id' => 'getBrowserContextId', 'deep_link_url' => 'getDeepLinkUrl', 'width' => 'getWidth', 'height' => 'getHeight', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['screenshot_id' => 'uuid', 'run_id' => 'uuid', 'target_id' => 'uuid', 'variant' => null, 'title' => null, 'description' => null, 'is_primary' => null, 'display_order' => 'int32', 'storage_key' => null, 'storage_provider' => null, 'storage_bucket' => null, 'storage_object_key' => null, 'storage_region' => null, 'storage_endpoint' => null, 'storage_public_base_url' => null, 'access_url' => null, 'live_view_url' => null, 'session_id' => null, 'browser_context_id' => null, 'deep_link_url' => null, 'width' => 'int32', 'height' => 'int32', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'DevicePreviewScreenshotDto'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['screenshot_id' => false, 'run_id' => false, 'target_id' => true, 'variant' => true, 'title' => true, 'description' => true, 'is_primary' => false, 'display_order' => false, 'storage_key' => true, 'storage_provider' => true, 'storage_bucket' => true, 'storage_object_key' => true, 'storage_region' => true, 'storage_endpoint' => true, 'storage_public_base_url' => true, 'access_url' => true, 'live_view_url' => true, 'session_id' => true, 'browser_context_id' => true, 'deep_link_url' => true, 'width' => true, 'height' => 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 = ['screenshot_id' => 'string', 'run_id' => 'string', 'target_id' => 'string', 'variant' => 'string', 'title' => 'string', 'description' => 'string', 'is_primary' => 'bool', 'display_order' => 'int', 'storage_key' => 'string', 'storage_provider' => 'string', 'storage_bucket' => 'string', 'storage_object_key' => 'string', 'storage_region' => 'string', 'storage_endpoint' => 'string', 'storage_public_base_url' => 'string', 'access_url' => 'string', 'live_view_url' => 'string', 'session_id' => 'string', 'browser_context_id' => 'string', 'deep_link_url' => 'string', 'width' => 'int', 'height' => '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 = ['screenshot_id' => 'setScreenshotId', 'run_id' => 'setRunId', 'target_id' => 'setTargetId', 'variant' => 'setVariant', 'title' => 'setTitle', 'description' => 'setDescription', 'is_primary' => 'setIsPrimary', 'display_order' => 'setDisplayOrder', 'storage_key' => 'setStorageKey', 'storage_provider' => 'setStorageProvider', 'storage_bucket' => 'setStorageBucket', 'storage_object_key' => 'setStorageObjectKey', 'storage_region' => 'setStorageRegion', 'storage_endpoint' => 'setStorageEndpoint', 'storage_public_base_url' => 'setStoragePublicBaseUrl', 'access_url' => 'setAccessUrl', 'live_view_url' => 'setLiveViewUrl', 'session_id' => 'setSessionId', 'browser_context_id' => 'setBrowserContextId', 'deep_link_url' => 'setDeepLinkUrl', 'width' => 'setWidth', 'height' => 'setHeight', '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 —

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> —

getBrowserContextId()

Gets browser_context_id

public getBrowserContextId() : string|null
Return values
string|null —

getStorageEndpoint()

Gets storage_endpoint

public getStorageEndpoint() : string|null
Return values
string|null —

getStorageObjectKey()

Gets storage_object_key

public getStorageObjectKey() : string|null
Return values
string|null —

getStorageProvider()

Gets storage_provider

public getStorageProvider() : string|null
Return values
string|null —

getStoragePublicBaseUrl()

Gets storage_public_base_url

public getStoragePublicBaseUrl() : 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> —

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 —

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> —

setAccessUrl()

Sets access_url

public setAccessUrl(string|null $access_url) : self
Parameters
$access_url : string|null

access_url

Return values
self —

setBrowserContextId()

Sets browser_context_id

public setBrowserContextId(string|null $browser_context_id) : self
Parameters
$browser_context_id : string|null

browser_context_id

Return values
self —

setCreatedAt()

Sets created_at

public setCreatedAt(DateTime $created_at) : self
Parameters
$created_at : DateTime

created_at

Return values
self —

setDeepLinkUrl()

Sets deep_link_url

public setDeepLinkUrl(string|null $deep_link_url) : self
Parameters
$deep_link_url : string|null

deep_link_url

Return values
self —

setDescription()

Sets description

public setDescription(string|null $description) : self
Parameters
$description : string|null

description

Return values
self —

setDisplayOrder()

Sets display_order

public setDisplayOrder(int $display_order) : self
Parameters
$display_order : int

display_order

Return values
self —

setHeight()

Sets height

public setHeight(int|null $height) : self
Parameters
$height : int|null

height

Return values
self —

setIsPrimary()

Sets is_primary

public setIsPrimary(bool $is_primary) : self
Parameters
$is_primary : bool

is_primary

Return values
self —

setLiveViewUrl()

Sets live_view_url

public setLiveViewUrl(string|null $live_view_url) : self
Parameters
$live_view_url : string|null

live_view_url

Return values
self —

setRunId()

Sets run_id

public setRunId(string $run_id) : self
Parameters
$run_id : string

run_id

Return values
self —

setScreenshotId()

Sets screenshot_id

public setScreenshotId(string $screenshot_id) : self
Parameters
$screenshot_id : string

screenshot_id

Return values
self —

setSessionId()

Sets session_id

public setSessionId(string|null $session_id) : self
Parameters
$session_id : string|null

session_id

Return values
self —

setStorageBucket()

Sets storage_bucket

public setStorageBucket(string|null $storage_bucket) : self
Parameters
$storage_bucket : string|null

storage_bucket

Return values
self —

setStorageEndpoint()

Sets storage_endpoint

public setStorageEndpoint(string|null $storage_endpoint) : self
Parameters
$storage_endpoint : string|null

storage_endpoint

Return values
self —

setStorageKey()

Sets storage_key

public setStorageKey(string|null $storage_key) : self
Parameters
$storage_key : string|null

storage_key

Return values
self —

setStorageObjectKey()

Sets storage_object_key

public setStorageObjectKey(string|null $storage_object_key) : self
Parameters
$storage_object_key : string|null

storage_object_key

Return values
self —

setStorageProvider()

Sets storage_provider

public setStorageProvider(string|null $storage_provider) : self
Parameters
$storage_provider : string|null

storage_provider

Return values
self —

setStoragePublicBaseUrl()

Sets storage_public_base_url

public setStoragePublicBaseUrl(string|null $storage_public_base_url) : self
Parameters
$storage_public_base_url : string|null

storage_public_base_url

Return values
self —

setStorageRegion()

Sets storage_region

public setStorageRegion(string|null $storage_region) : self
Parameters
$storage_region : string|null

storage_region

Return values
self —

setTargetId()

Sets target_id

public setTargetId(string|null $target_id) : self
Parameters
$target_id : string|null

target_id

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> —

setTitle()

Sets title

public setTitle(string|null $title) : self
Parameters
$title : string|null

title

Return values
self —

setUpdatedAt()

Sets updated_at

public setUpdatedAt(DateTime $updated_at) : self
Parameters
$updated_at : DateTime

updated_at

Return values
self —

setVariant()

Sets variant

public setVariant(string|null $variant) : self
Parameters
$variant : string|null

variant

Return values
self —

setWidth()

Sets width

public setWidth(int|null $width) : self
Parameters
$width : int|null

width

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>
Return values
void —

Search results