struct PlaceOS::Client::API::Models::Zone

Included Modules

Defined in:

placeos/api/models/zone.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 capacity : Int32 #

Could be used as people capacity


[View source]
def code : String | Nil #

Could be used as floor code or building code etc


[View source]
def count : Int32 #

Could be used as desk count for a level


[View source]
def description : String | Nil #

Markdown formatted text that describes the zone.


[View source]
def display_name : String | Nil #

A human readable identifier for displaying on interfaces


[View source]
def id : String #

A universally unique identifier for the zone.


[View source]
def location : String | Nil #

Geo-location string (lat,long) or any other location


[View source]
def map_id : String | Nil #

Map identifier, could be a URL or id


[View source]
def name : String #

A human readable identifier.


[View source]
def parent_id : String | Nil #

Parent id


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

Space seperated list of tags for categorizing the zone.


[View source]
def timezone : Time::Location | Nil #

Timezone location of the zone


[View source]
def trigger_data : Array(Trigger) | Nil #

Trigger data returned when param complete is true


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

List of trigger ID's to be applied to all systems that associate with this zone.


[View source]
def type : String | Nil #

Could be used as floor type or building type etc


[View source]