UpdateDevice implements ModelInterface, ArrayAccess
UpdateDevice Class Doc Comment
Tags
Interfaces, Classes and Traits
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
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)
- $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
- getAddress() : string
- Gets address
- getFloorPlanId() : string
- Gets floor_plan_id
- getLat() : float
- Gets lat
- getLng() : float
- Gets lng
- getModelName() : string
- The original name of the model.
- getMoveMapMarker() : bool
- Gets move_map_marker
- getName() : string
- Gets name
- getNotes() : string
- Gets notes
- getSwitchProfileId() : string
- Gets switch_profile_id
- getTags() : array<string|int, string>
- Gets tags
- 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.
- setAddress() : $this
- Sets address
- setFloorPlanId() : $this
- Sets floor_plan_id
- setLat() : $this
- Sets lat
- setLng() : $this
- Sets lng
- setMoveMapMarker() : $this
- Sets move_map_marker
- setName() : $this
- Sets name
- setNotes() : $this
- Sets notes
- setSwitchProfileId() : $this
- Sets switch_profile_id
- setTags() : $this
- Sets tags
- 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
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
= ['name' => 'name', 'tags' => 'tags', 'lat' => 'lat', 'lng' => 'lng', 'address' => 'address', 'notes' => 'notes', 'move_map_marker' => 'moveMapMarker', 'switch_profile_id' => 'switchProfileId', 'floor_plan_id' => 'floorPlanId']
$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
= ['name' => 'getName', 'tags' => 'getTags', 'lat' => 'getLat', 'lng' => 'getLng', 'address' => 'getAddress', 'notes' => 'getNotes', 'move_map_marker' => 'getMoveMapMarker', 'switch_profile_id' => 'getSwitchProfileId', 'floor_plan_id' => 'getFloorPlanId']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['name' => 'setName', 'tags' => 'setTags', 'lat' => 'setLat', 'lng' => 'setLng', 'address' => 'setAddress', 'notes' => 'setNotes', 'move_map_marker' => 'setMoveMapMarker', 'switch_profile_id' => 'setSwitchProfileId', 'floor_plan_id' => 'setFloorPlanId']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['name' => null, 'tags' => null, 'lat' => 'float', 'lng' => 'float', 'address' => null, 'notes' => null, 'move_map_marker' => null, 'switch_profile_id' => null, 'floor_plan_id' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'updateDevice'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['name' => 'string', 'tags' => 'string[]', 'lat' => 'float', 'lng' => 'float', 'address' => 'string', 'notes' => 'string', 'move_map_marker' => 'bool', 'switch_profile_id' => 'string', 'floor_plan_id' => 'string']
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> —getAddress()
Gets address
public
getAddress() : string
Return values
string —getFloorPlanId()
Gets floor_plan_id
public
getFloorPlanId() : string
Return values
string —getLat()
Gets lat
public
getLat() : float
Return values
float —getLng()
Gets lng
public
getLng() : float
Return values
float —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getMoveMapMarker()
Gets move_map_marker
public
getMoveMapMarker() : bool
Return values
bool —getName()
Gets name
public
getName() : string
Return values
string —getNotes()
Gets notes
public
getNotes() : string
Return values
string —getSwitchProfileId()
Gets switch_profile_id
public
getSwitchProfileId() : string
Return values
string —getTags()
Gets tags
public
getTags() : 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> —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 —setAddress()
Sets address
public
setAddress(string $address) : $this
Parameters
- $address : string
-
The address of a device
Return values
$this —setFloorPlanId()
Sets floor_plan_id
public
setFloorPlanId(string $floor_plan_id) : $this
Parameters
- $floor_plan_id : string
-
The floor plan to associate to this device. null disassociates the device from the floorplan.
Return values
$this —setLat()
Sets lat
public
setLat(float $lat) : $this
Parameters
- $lat : float
-
The latitude of a device
Return values
$this —setLng()
Sets lng
public
setLng(float $lng) : $this
Parameters
- $lng : float
-
The longitude of a device
Return values
$this —setMoveMapMarker()
Sets move_map_marker
public
setMoveMapMarker(bool $move_map_marker) : $this
Parameters
- $move_map_marker : bool
-
Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.
Return values
$this —setName()
Sets name
public
setName(string $name) : $this
Parameters
- $name : string
-
The name of a device
Return values
$this —setNotes()
Sets notes
public
setNotes(string $notes) : $this
Parameters
- $notes : string
-
The notes for the device. String. Limited to 255 characters.
Return values
$this —setSwitchProfileId()
Sets switch_profile_id
public
setSwitchProfileId(string $switch_profile_id) : $this
Parameters
- $switch_profile_id : string
-
The ID of a switch profile to bind to the device (for available switch profiles, see the 'Switch Profiles' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch profile, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.
Return values
$this —setTags()
Sets tags
public
setTags(array<string|int, string> $tags) : $this
Parameters
- $tags : array<string|int, string>
-
The list of tags of a device
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