UpdateDeviceCameraQualityAndRetention implements ModelInterface, ArrayAccess
UpdateDeviceCameraQualityAndRetention Class Doc Comment
Tags
Interfaces, Classes and Traits
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
Table of Contents
- DISCRIMINATOR = null
- QUALITY_ENHANCED = 'Enhanced'
- QUALITY_HIGH = 'High'
- QUALITY_STANDARD = 'Standard'
- RESOLUTION__1080X1080 = '1080x1080'
- RESOLUTION__1280X720 = '1280x720'
- RESOLUTION__1920X1080 = '1920x1080'
- RESOLUTION__2058X2058 = '2058x2058'
- $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)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __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
- getAudioRecordingEnabled() : bool
- Gets audio_recording_enabled
- getModelName() : string
- The original name of the model.
- getMotionBasedRetentionEnabled() : bool
- Gets motion_based_retention_enabled
- getMotionDetectorVersion() : int
- Gets motion_detector_version
- getProfileId() : string
- Gets profile_id
- getQuality() : string
- Gets quality
- getQualityAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getResolution() : string
- Gets resolution
- getResolutionAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getRestrictedBandwidthModeEnabled() : bool
- Gets restricted_bandwidth_mode_enabled
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setAudioRecordingEnabled() : $this
- Sets audio_recording_enabled
- setMotionBasedRetentionEnabled() : $this
- Sets motion_based_retention_enabled
- setMotionDetectorVersion() : $this
- Sets motion_detector_version
- setProfileId() : $this
- Sets profile_id
- setQuality() : $this
- Sets quality
- setResolution() : $this
- Sets resolution
- setRestrictedBandwidthModeEnabled() : $this
- Sets restricted_bandwidth_mode_enabled
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
QUALITY_ENHANCED
public
mixed
QUALITY_ENHANCED
= 'Enhanced'
QUALITY_HIGH
public
mixed
QUALITY_HIGH
= 'High'
QUALITY_STANDARD
public
mixed
QUALITY_STANDARD
= 'Standard'
RESOLUTION__1080X1080
public
mixed
RESOLUTION__1080X1080
= '1080x1080'
RESOLUTION__1280X720
public
mixed
RESOLUTION__1280X720
= '1280x720'
RESOLUTION__1920X1080
public
mixed
RESOLUTION__1920X1080
= '1920x1080'
RESOLUTION__2058X2058
public
mixed
RESOLUTION__2058X2058
= '2058x2058'
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
= ['profile_id' => 'profileId', 'motion_based_retention_enabled' => 'motionBasedRetentionEnabled', 'audio_recording_enabled' => 'audioRecordingEnabled', 'restricted_bandwidth_mode_enabled' => 'restrictedBandwidthModeEnabled', 'quality' => 'quality', 'resolution' => 'resolution', 'motion_detector_version' => 'motionDetectorVersion']
$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
= ['profile_id' => 'getProfileId', 'motion_based_retention_enabled' => 'getMotionBasedRetentionEnabled', 'audio_recording_enabled' => 'getAudioRecordingEnabled', 'restricted_bandwidth_mode_enabled' => 'getRestrictedBandwidthModeEnabled', 'quality' => 'getQuality', 'resolution' => 'getResolution', 'motion_detector_version' => 'getMotionDetectorVersion']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['profile_id' => 'setProfileId', 'motion_based_retention_enabled' => 'setMotionBasedRetentionEnabled', 'audio_recording_enabled' => 'setAudioRecordingEnabled', 'restricted_bandwidth_mode_enabled' => 'setRestrictedBandwidthModeEnabled', 'quality' => 'setQuality', 'resolution' => 'setResolution', 'motion_detector_version' => 'setMotionDetectorVersion']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['profile_id' => null, 'motion_based_retention_enabled' => null, 'audio_recording_enabled' => null, 'restricted_bandwidth_mode_enabled' => null, 'quality' => null, 'resolution' => null, 'motion_detector_version' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'updateDeviceCameraQualityAndRetention'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['profile_id' => 'string', 'motion_based_retention_enabled' => 'bool', 'audio_recording_enabled' => 'bool', 'restricted_bandwidth_mode_enabled' => 'bool', 'quality' => 'string', 'resolution' => 'string', 'motion_detector_version' => 'int']
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> —getAudioRecordingEnabled()
Gets audio_recording_enabled
public
getAudioRecordingEnabled() : bool
Return values
bool —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getMotionBasedRetentionEnabled()
Gets motion_based_retention_enabled
public
getMotionBasedRetentionEnabled() : bool
Return values
bool —getMotionDetectorVersion()
Gets motion_detector_version
public
getMotionDetectorVersion() : int
Return values
int —getProfileId()
Gets profile_id
public
getProfileId() : string
Return values
string —getQuality()
Gets quality
public
getQuality() : string
Return values
string —getQualityAllowableValues()
Gets allowable values of the enum
public
getQualityAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getResolution()
Gets resolution
public
getResolution() : string
Return values
string —getResolutionAllowableValues()
Gets allowable values of the enum
public
getResolutionAllowableValues() : array<string|int, string>
Return values
array<string|int, string> —getRestrictedBandwidthModeEnabled()
Gets restricted_bandwidth_mode_enabled
public
getRestrictedBandwidthModeEnabled() : bool
Return values
bool —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —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
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
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 —setAudioRecordingEnabled()
Sets audio_recording_enabled
public
setAudioRecordingEnabled(bool $audio_recording_enabled) : $this
Parameters
- $audio_recording_enabled : bool
-
Boolean indicating if audio recording is enabled(true) or disabled(false) on the camera
Return values
$this —setMotionBasedRetentionEnabled()
Sets motion_based_retention_enabled
public
setMotionBasedRetentionEnabled(bool $motion_based_retention_enabled) : $this
Parameters
- $motion_based_retention_enabled : bool
-
Boolean indicating if motion-based retention is enabled(true) or disabled(false) on the camera.
Return values
$this —setMotionDetectorVersion()
Sets motion_detector_version
public
setMotionDetectorVersion(int $motion_detector_version) : $this
Parameters
- $motion_detector_version : int
-
The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2.
Return values
$this —setProfileId()
Sets profile_id
public
setProfileId(string $profile_id) : $this
Parameters
- $profile_id : string
-
The ID of a quality and retention profile to assign to the camera. The profile's settings will override all of the per-camera quality and retention settings. If the value of this parameter is null, any existing profile will be unassigned from the camera.
Return values
$this —setQuality()
Sets quality
public
setQuality(string $quality) : $this
Parameters
- $quality : string
-
Quality of the camera. Can be one of 'Standard', 'High' or 'Enhanced'. Not all qualities are supported by every camera model.
Return values
$this —setResolution()
Sets resolution
public
setResolution(string $resolution) : $this
Parameters
- $resolution : string
-
Resolution of the camera. Can be one of '1280x720', '1920x1080', '1080x1080' or '2058x2058'. Not all resolutions are supported by every camera model.
Return values
$this —setRestrictedBandwidthModeEnabled()
Sets restricted_bandwidth_mode_enabled
public
setRestrictedBandwidthModeEnabled(bool $restricted_bandwidth_mode_enabled) : $this
Parameters
- $restricted_bandwidth_mode_enabled : bool
-
Boolean indicating if restricted bandwidth is enabled(true) or disabled(false) on the camera
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : 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