Documentation

CreateDevicePreviewFeedbackOptions
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CreateDevicePreviewFeedbackOptions 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

CATEGORY_BUG_REPORT  = 'BUG_REPORT'
CATEGORY_FEATURE_REQUEST  = 'FEATURE_REQUEST'
CATEGORY_GENERAL  = 'GENERAL'
CATEGORY_NOTE  = 'NOTE'
CATEGORY_PROVIDER_ISSUE  = 'PROVIDER_ISSUE'
CATEGORY_RUN_QUALITY  = 'RUN_QUALITY'
CATEGORY_SCREENSHOT_QUALITY  = 'SCREENSHOT_QUALITY'
DISCRIMINATOR  = null
PROVIDER_GMAIL  = 'GMAIL'
PROVIDER_OUTLOOK  = 'OUTLOOK'
PROVIDER_YAHOO  = 'YAHOO'
SOURCE_API_SERVICE  = 'API_SERVICE'
SOURCE_END_USER  = 'END_USER'
SOURCE_LAB_USER  = 'LAB_USER'
SOURCE_SYSTEM  = 'SYSTEM'
STATUS_ACKNOWLEDGED  = 'ACKNOWLEDGED'
STATUS_DISMISSED  = 'DISMISSED'
STATUS_OPEN  = 'OPEN'
STATUS_RESOLVED  = 'RESOLVED'
$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
getCategory()  : string
Gets category
getCategoryAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getComment()  : string|null
Gets comment
getInternalNote()  : string|null
Gets internal_note
getLiveViewUrl()  : string|null
Gets live_view_url
getMetadata()  : array<string, string>|null
Gets metadata
getModelName()  : string
The original name of the model.
getProvider()  : string|null
Gets provider
getProviderAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getRating()  : int|null
Gets rating
getRunId()  : string|null
Gets run_id
getScreenshotId()  : string|null
Gets screenshot_id
getSessionId()  : string|null
Gets session_id
getSource()  : string
Gets source
getSourceAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getStatus()  : string|null
Gets status
getStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
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
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
setCategory()  : self
Sets category
setComment()  : self
Sets comment
setInternalNote()  : self
Sets internal_note
setLiveViewUrl()  : self
Sets live_view_url
setMetadata()  : self
Sets metadata
setProvider()  : self
Sets provider
setRating()  : self
Sets rating
setRunId()  : self
Sets run_id
setScreenshotId()  : self
Sets screenshot_id
setSessionId()  : self
Sets session_id
setSource()  : self
Sets source
setStatus()  : self
Sets status
setTargetId()  : self
Sets target_id
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTitle()  : self
Sets title
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 = ['source' => 'source', 'category' => 'category', 'status' => 'status', 'rating' => 'rating', 'run_id' => 'runId', 'target_id' => 'targetId', 'screenshot_id' => 'screenshotId', 'provider' => 'provider', 'title' => 'title', 'comment' => 'comment', 'internal_note' => 'internalNote', 'session_id' => 'sessionId', 'live_view_url' => 'liveViewUrl', 'metadata' => 'metadata']

$getters

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

protected static array<string|int, string> $getters = ['source' => 'getSource', 'category' => 'getCategory', 'status' => 'getStatus', 'rating' => 'getRating', 'run_id' => 'getRunId', 'target_id' => 'getTargetId', 'screenshot_id' => 'getScreenshotId', 'provider' => 'getProvider', 'title' => 'getTitle', 'comment' => 'getComment', 'internal_note' => 'getInternalNote', 'session_id' => 'getSessionId', 'live_view_url' => 'getLiveViewUrl', 'metadata' => 'getMetadata']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['source' => null, 'category' => null, 'status' => null, 'rating' => 'int32', 'run_id' => 'uuid', 'target_id' => 'uuid', 'screenshot_id' => 'uuid', 'provider' => null, 'title' => null, 'comment' => null, 'internal_note' => null, 'session_id' => null, 'live_view_url' => null, 'metadata' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['source' => false, 'category' => false, 'status' => true, 'rating' => true, 'run_id' => true, 'target_id' => true, 'screenshot_id' => true, 'provider' => true, 'title' => true, 'comment' => true, 'internal_note' => true, 'session_id' => true, 'live_view_url' => true, 'metadata' => true]

$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 = ['source' => 'string', 'category' => 'string', 'status' => 'string', 'rating' => 'int', 'run_id' => 'string', 'target_id' => 'string', 'screenshot_id' => 'string', 'provider' => 'string', 'title' => 'string', 'comment' => 'string', 'internal_note' => 'string', 'session_id' => 'string', 'live_view_url' => 'string', 'metadata' => 'array<string,string>']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['source' => 'setSource', 'category' => 'setCategory', 'status' => 'setStatus', 'rating' => 'setRating', 'run_id' => 'setRunId', 'target_id' => 'setTargetId', 'screenshot_id' => 'setScreenshotId', 'provider' => 'setProvider', 'title' => 'setTitle', 'comment' => 'setComment', 'internal_note' => 'setInternalNote', 'session_id' => 'setSessionId', 'live_view_url' => 'setLiveViewUrl', 'metadata' => 'setMetadata']

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

getCategoryAllowableValues()

Gets allowable values of the enum

public getCategoryAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getProviderAllowableValues()

Gets allowable values of the enum

public getProviderAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

getSourceAllowableValues()

Gets allowable values of the enum

public getSourceAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —

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

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 —

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 —

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

setInternalNote()

Sets internal_note

public setInternalNote(string|null $internal_note) : self
Parameters
$internal_note : string|null

internal_note

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 —

setMetadata()

Sets metadata

public setMetadata(array<string, string>|null $metadata) : self
Parameters
$metadata : array<string, string>|null

metadata

Return values
self —

setProvider()

Sets provider

public setProvider(string|null $provider) : self
Parameters
$provider : string|null

provider

Return values
self —

setScreenshotId()

Sets screenshot_id

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

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 —

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

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