struct PlaceOS::API::Models::System

Included Modules

Defined in:

placeos/api/models/system.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def bookable : Bool #

Flag for signifying the space as reservable.


[View source]
def capacity : Int32 #

Number of people that can be accommodated in this space.


[View source]
def created_at : Time #

[View source]
def description : String | Nil #

Markdown formatted text that describes the system.


[View source]
def edge_id : String #

The engine node that this system operates from.


[View source]
def email : String | Nil #

Calendar URI that is associated with this system.


[View source]
def features : String #

List of features in the room for searching and filtering spaces.


[View source]
def id : String #

A universally unique identifier for the system.


[View source]
def installed_ui_devices : Int32 #

Expected number of fixed installation touch panels.


[View source]
def modules : Array(String) #

Module ID's that this system contains.


[View source]
def name : String #

A human readable identifier.


[View source]
def settings : Hash(String, JSON::Any) #

JSON object representing the system's configuration.


[View source]
def support_url : URI | Nil #

A URL linking to the primary interface for controlling this system.


[View source]
def version : Int32 #

Incrementing counter for handling stale updates.


[View source]
def zones : Array(String) #

Zone IDs that this system is a member of.


[View source]