struct PlaceOS::Client::API::Models::System

Included Modules

Defined in:

placeos/api/models/system.cr

Constructors

Instance Method Summary

Instance methods inherited from module PlaceOS::Client::API::Models::Timestamps

created_at : Time created_at, updated_at : Time updated_at

Constructor methods inherited from struct PlaceOS::Client::API::Models::Response

new(pull : JSON::PullParser) new

Macros inherited from module PlaceOS::Client::API::Models::Response::Init

__add_initialize__ __add_initialize__

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 code : String | Nil #

the room identification code, like 3-04 etc.


[View source]
def description : String | Nil #

Markdown formatted text that describes the system.


[View source]
def display_name : String | Nil #

an alternative to the full name that is easier to read.


[View source]
def email : String | Nil #

Calendar URI that is associated with this system.


[View source]
def features : Set(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 images : Array(String) | Nil #

images of this room


[View source]
def installed_ui_devices : Int32 #

Expected number of fixed installation touch panels.


[View source]
def map_id : String | Nil #

a map identifier that can be used to locate this system.


[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 public : Bool | Nil #

is the system intended for public access?


[View source]
def support_url : String | Nil #

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


[View source]
def timezone : String | Nil #

timezone the system is located


[View source]
def type : String | Nil #

the system type, like a small meeting room etc.


[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]