class PlaceOS::Model::Zone

• PlaceOS::Model::Zone
• PlaceOS::Model::ModelBase
• PgORM::Base
• ActiveModel::Model
• Reference
• Object

Included Modules

• PlaceOS::Model::Playlist::Checker
• PlaceOS::Model::Timestamps
• PlaceOS::Model::Utilities::MetadataHelper
• PlaceOS::Model::Utilities::SettingsHelper

Defined in:

Constant Summary

CALLBACKS = {before_save: [:check_playlists, :check_triggers] of Nil, after_save: [:update_triggers] of Nil, before_create: [do self.created_at = self.updated_at = Time.utc end] of Nil, after_create: [] of Nil, before_update: [do self.updated_at = Time.utc end] of Nil, after_update: [] of Nil, before_destroy: [:destroy_children, :destroy_trigger_instances, :destroy_metadata_and_versions, :destroy_settings_and_versions, :remove_zone] of Nil, after_destroy: [] of Nil}

Log = ::Log.for(self)

Constructors

• .from_json(string_or_io : String | IO, trusted : Bool = false) : self
• .from_json(string_or_io : String | IO, root : String, trusted : Bool = false) : self

  Deserializes the given JSON in string_or_io into an instance of self, assuming the JSON consists of an JSON object with key root, and whose value is the value to deserialize.

• .from_trusted_json(string_or_io : String | IO, root : String) : self
• .from_trusted_json(string_or_io : String | IO) : self

  Serialize from a trusted JSON source

• .from_trusted_yaml(string_or_io : String | IO) : self

  Serialize from a trusted YAML source

• .from_yaml(string_or_io : String | IO, trusted : Bool = false) : self
• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(pull : JSON::PullParser)
• .new(rs : DB::ResultSet)
• .new(created_at : Time | ActiveModel::Model::None = ::ActiveModel::Model::None.new, updated_at : Time | ActiveModel::Model::None = ::ActiveModel::Model::None.new, name : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new, description : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new, tags : Set(String) | ActiveModel::Model::None = ::ActiveModel::Model::None.new, location : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, display_name : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, code : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, type : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, count : Int32 | ActiveModel::Model::None = ::ActiveModel::Model::None.new, capacity : Int32 | ActiveModel::Model::None = ::ActiveModel::Model::None.new, map_id : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, timezone : Time::Location | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, triggers : Array(String) | ActiveModel::Model::None = ::ActiveModel::Model::None.new, images : Array(String) | ActiveModel::Model::None = ::ActiveModel::Model::None.new, playlists : Array(String) | ActiveModel::Model::None = ::ActiveModel::Model::None.new, place_id : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, parent_id : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, id : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new)
• .new(params : HTTP::Params | Hash(String, String) | Tuple(String, String))

  Initialize PlaceOS::Model::Zone from HTTP::Params.

Class Method Summary

• .attributes : Array(Symbol)

  Returns all attribute keys.

• .auto_generate_id : Bool
• .by_parent_id(id)

  Look up instances of this model dependent on the foreign key

• .changes(id : PrimaryKeyType = nil) : ChangeFeed

  Changefeed at row (if #id passed) or whole table level.

• .elastic
• .from_rs(__temp_706 : DB::ResultSet)
• .on_error(err : Exception | IO::Error)
• .primary_key : Symbol
• .table_name
• .with_playlists(ids : Enumerable(String))
• .with_tag(tag : String)

Instance Method Summary

• #__parent : Zone | Nil

  Association ##############################################################################################

• #__parent=(__parent : Zone | Nil)

  Association ##############################################################################################

• #after_create

  Base class for all Engine models

• #after_destroy

  Base class for all Engine models

• #after_initialize(trusted : Bool)
• #after_save

  Base class for all Engine models

• #after_update

  Base class for all Engine models

• #apply_defaults

  Generate code to apply default values

• #assign_attributes(created_at : Time | Missing = Missing, updated_at : Time | Missing = Missing, name : String | Missing = Missing, description : String | Missing = Missing, tags : Set(String) | Missing = Missing, location : String | Nil | Missing = Missing, display_name : String | Nil | Missing = Missing, code : String | Nil | Missing = Missing, type : String | Nil | Missing = Missing, count : Int32 | Missing = Missing, capacity : Int32 | Missing = Missing, map_id : String | Nil | Missing = Missing, timezone : Time::Location | Nil | Missing = Missing, triggers : Array(String) | Missing = Missing, images : Array(String) | Missing = Missing, playlists : Array(String) | Missing = Missing, place_id : String | Nil | Missing = Missing, parent_id : String | Nil | Missing = Missing, id : String | Nil | Missing = Missing)

  Assign to multiple attributes.

• #assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String))

  Assign to mulitple attributes via HTTP::Params.

• #assign_attributes(model : PlaceOS::Model::Zone)

  Assign to multiple attributes from a model object

• #assign_attributes_from_json(json, root : String)
• #assign_attributes_from_json(json)
• #assign_attributes_from_trusted_json(json, root : String)
• #assign_attributes_from_trusted_json(json)

  Assign each field from JSON if field exists in JSON and has changed in model

• #assign_attributes_from_trusted_yaml(yaml)
• #assign_attributes_from_yaml(yaml)

  Uses the YAML parser as JSON is valid YAML

• #attributes

  Returns a Hash of all attribute values

• #attributes_tuple

  Returns a NamedTuple of all attribute values.

• #before_create

  Base class for all Engine models

• #before_destroy

  Base class for all Engine models

• #before_save

  Base class for all Engine models

• #before_update

  Base class for all Engine models

• #capacity : Int32

  #capacity getter

• #capacity=(value : Int32)

  #capacity setter

• #capacity? : Int32 | Nil

  Could be used as a people capacity

• #capacity_assigned? : Bool
• #capacity_change : Tuple(Int32 | Nil, Int32 | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #capacity_changed? : Bool
• #capacity_default : Int32

  #capacity's default value

• #capacity_present? : Bool

  Could be used as a people capacity

• #capacity_was : Int32 | Nil
• #capacity_will_change! : Nil

  Include #capacity in the set of changed attributes, whether it has changed or not.

• #changed?

  Check if any attributes have changed.

• #changed_attributes

  Returns a Hash with all changed attributes.

• #changed_json(io : IO) : Nil

  Serialize the set of changed attributes to JSON.

• #changed_json : String

  Serialize the set of changed attributes to JSON.

• #changed_persist_attributes
• #changed_yaml(io : IO) : Nil

  Serialize the set of changed attributes to YAML.

• #changed_yaml : String

  Serialize the set of changed attributes to YAML.

• #children
• #clear_changes_information

  Reset changes for all attributes.

• #code : String | Nil

  #code getter

• #code=(value : String | Nil)

  #code setter

• #code_assigned? : Bool
• #code_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #code_changed? : Bool
• #code_default : String | Nil

  #code's default value

• #code_present? : Bool

  Could be used as floor code

• #code_was : String | Nil | Nil
• #code_will_change! : Nil

  Include #code in the set of changed attributes, whether it has changed or not.

• #count : Int32

  #count getter

• #count=(value : Int32)

  #count setter

• #count? : Int32 | Nil

  Could be used as a desk count

• #count_assigned? : Bool
• #count_change : Tuple(Int32 | Nil, Int32 | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #count_changed? : Bool
• #count_default : Int32

  #count's default value

• #count_present? : Bool

  Could be used as a desk count

• #count_was : Int32 | Nil
• #count_will_change! : Nil

  Include #count in the set of changed attributes, whether it has changed or not.

• #created_at : Time

  #created_at getter

• #created_at=(value : Time)

  Setters #created_at setter

• #created_at? : Time | Nil

  Assign instance variable to correct type

• #created_at_assigned? : Bool
• #created_at_change : Tuple(Time | Nil, Time | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #created_at_changed? : Bool
• #created_at_default : Time

  #created_at's default value

• #created_at_present? : Bool
• #created_at_was : Time | Nil
• #created_at_will_change! : Nil

  Include #created_at in the set of changed attributes, whether it has changed or not.

• #description : String

  #description getter

• #description=(value : String)

  #description setter

• #description? : String | Nil

  Assign instance variable to correct type

• #description_assigned? : Bool
• #description_change : Tuple(String | Nil, String | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #description_changed? : Bool
• #description_default : String

  #description's default value

• #description_present? : Bool
• #description_was : String | Nil
• #description_will_change! : Nil

  Include #description in the set of changed attributes, whether it has changed or not.

• #destroy_children
• #destroy_metadata_and_versions

  Metadata belonging to this zone

• #destroy_settings_and_versions

  Encrypted yaml settings

• #destroy_trigger_instances
• #display_name : String | Nil

  #display_name getter

• #display_name=(value : String | Nil)

  #display_name setter

• #display_name_assigned? : Bool
• #display_name_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #display_name_changed? : Bool
• #display_name_default : String | Nil

  #display_name's default value

• #display_name_present? : Bool

  For display on staff app

• #display_name_was : String | Nil | Nil
• #display_name_will_change! : Nil

  Include #display_name in the set of changed attributes, whether it has changed or not.

• #id : String | Nil

  #id getter

• #id=(value : String | Nil)

  #id setter

• #id? : String | Nil | Nil

  Same as #id but may return nil when the record hasn't been saved instead of raising.

• #id_assigned? : Bool
• #id_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #id_changed? : Bool
• #id_default : String | Nil

  #id's default value

• #id_present? : Bool
• #id_was : String | Nil | Nil
• #id_will_change! : Nil

  Include #id in the set of changed attributes, whether it has changed or not.

• #images : Array(String)

  #images getter

• #images=(value : Array(String))

  #images setter

• #images? : Array(String) | Nil

  Assign instance variable to correct type

• #images_assigned? : Bool
• #images_change : Tuple(Array(String) | Nil, Array(String) | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #images_changed? : Bool
• #images_default : Array(String)

  #images's default value

• #images_present? : Bool
• #images_was : Array(String) | Nil
• #images_will_change! : Nil

  Include #images in the set of changed attributes, whether it has changed or not.

• #invoke_props

  Base class for all Engine models

• #location : String | Nil

  #location getter

• #location=(value : String | Nil)

  #location setter

• #location_assigned? : Bool
• #location_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #location_changed? : Bool
• #location_default : String | Nil

  #location's default value

• #location_present? : Bool

  ============================= Additional top level metadata that is fairly common ============================= Geo-location string (lat,long) or any other location

• #location_was : String | Nil | Nil
• #location_will_change! : Nil

  Include #location in the set of changed attributes, whether it has changed or not.

• #map_id : String | Nil

  #map_id getter

• #map_id=(value : String | Nil)

  #map_id setter

• #map_id_assigned? : Bool
• #map_id_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #map_id_changed? : Bool
• #map_id_default : String | Nil

  #map_id's default value

• #map_id_present? : Bool

  Map identifier, could be a URL or id

• #map_id_was : String | Nil | Nil
• #map_id_will_change! : Nil

  Include #map_id in the set of changed attributes, whether it has changed or not.

• #metadata_and_versions

  Metadata belonging to this zone

• #name : String

  #name getter

• #name=(value : String)

  #name setter

• #name? : String | Nil

  Assign instance variable to correct type

• #name_assigned? : Bool
• #name_change : Tuple(String | Nil, String | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #name_changed? : Bool
• #name_default : String

  #name's default value

• #name_present? : Bool
• #name_was : String | Nil
• #name_will_change! : Nil

  Include #name in the set of changed attributes, whether it has changed or not.

• #parent : Zone | Nil

  Retrieves the parent relationship

• #parent! : Zone

  Association ##############################################################################################

• #parent=(parent : Zone)

  Sets the parent relationship

• #parent_id : String | Nil

  #parent_id getter

• #parent_id=(value : String | Nil)

  #parent_id setter

• #parent_id_assigned? : Bool
• #parent_id_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #parent_id_changed? : Bool
• #parent_id_default : String | Nil

  #parent_id's default value

• #parent_id_present? : Bool

  Association ##############################################################################################

• #parent_id_was : String | Nil | Nil
• #parent_id_will_change! : Nil

  Include #parent_id in the set of changed attributes, whether it has changed or not.

• #persistent_attributes

  Returns a Hash of all attributes that can be persisted.

• #place_id : String | Nil

  #place_id getter

• #place_id=(value : String | Nil)

  #place_id setter

• #place_id_assigned? : Bool
• #place_id_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #place_id_changed? : Bool
• #place_id_default : String | Nil

  #place_id's default value

• #place_id_present? : Bool
• #place_id_was : String | Nil | Nil
• #place_id_will_change! : Nil

  Include #place_id in the set of changed attributes, whether it has changed or not.

• #playlists : Array(String)

  #playlists getter

• #playlists=(value : Array(String))

  #playlists setter

• #playlists? : Array(String) | Nil

  Assign instance variable to correct type

• #playlists_assigned? : Bool
• #playlists_change : Tuple(Array(String) | Nil, Array(String) | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #playlists_changed? : Bool
• #playlists_default : Array(String)

  #playlists's default value

• #playlists_present? : Bool
• #playlists_was : Array(String) | Nil
• #playlists_will_change! : Nil

  Include #playlists in the set of changed attributes, whether it has changed or not.

• #reset_associations

  Association ##############################################################################################

• #restore_attributes

  Reset each attribute to their previous values and clears all changes.

• #root_zone
• #root_zone_id : String
• #run_create_callbacks(&)

  Wrap a block with callbacks for the appropriate crud operation

• #run_destroy_callbacks(&)

  Base class for all Engine models

• #run_save_callbacks(&)

  Base class for all Engine models

• #run_update_callbacks(&)

  Base class for all Engine models

• #settings_and_versions

  Encrypted yaml settings

• #settings_hierarchy : Array(Settings)
• #systems

  Find systems

• #table_name
• #tags : Set(String)

  #tags getter

• #tags=(value : Set(String))

  #tags setter

• #tags? : Set(String) | Nil

  Assign instance variable to correct type

• #tags_assigned? : Bool
• #tags_change : Tuple(Set(String) | Nil, Set(String) | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #tags_changed? : Bool
• #tags_default : Set(String)

  #tags's default value

• #tags_present? : Bool
• #tags_was : Set(String) | Nil
• #tags_will_change! : Nil

  Include #tags in the set of changed attributes, whether it has changed or not.

• #timezone : Time::Location | Nil

  #timezone getter

• #timezone=(value : Time::Location | Nil)

  #timezone setter

• #timezone_assigned? : Bool
• #timezone_change : Tuple(Time::Location | Nil | Nil, Time::Location | Nil | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #timezone_changed? : Bool
• #timezone_default : Time::Location | Nil

  #timezone's default value

• #timezone_present? : Bool

  Timezone

• #timezone_was : Time::Location | Nil | Nil
• #timezone_will_change! : Nil

  Include #timezone in the set of changed attributes, whether it has changed or not.

• #trigger_data : Array(Trigger)

  Looks up the triggers attached to the zone

• #trigger_instances
• #triggers : Array(String)

  #triggers getter

• #triggers=(value : Array(String))

  #triggers setter

• #triggers? : Array(String) | Nil

  Assign instance variable to correct type

• #triggers_assigned? : Bool
• #triggers_change : Tuple(Array(String) | Nil, Array(String) | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #triggers_changed? : Bool
• #triggers_default : Array(String)

  #triggers's default value

• #triggers_present? : Bool
• #triggers_was : Array(String) | Nil
• #triggers_will_change! : Nil

  Include #triggers in the set of changed attributes, whether it has changed or not.

• #type : String | Nil

  #type getter

• #type=(value : String | Nil)

  #type setter

• #type_assigned? : Bool
• #type_change : Tuple(String | Nil | Nil, String | Nil | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #type_changed? : Bool
• #type_default : String | Nil

  #type's default value

• #type_present? : Bool

  Could be used as floor type

• #type_was : String | Nil | Nil
• #type_will_change! : Nil

  Include #type in the set of changed attributes, whether it has changed or not.

• #updated_at : Time

  #updated_at getter

• #updated_at=(value : Time)

  #updated_at setter

• #updated_at? : Time | Nil

  Assign instance variable to correct type

• #updated_at_assigned? : Bool
• #updated_at_change : Tuple(Time | Nil, Time | Nil) | Nil

  Returns a Tuple of the previous and the current value of an instance variable if it has changed

• #updated_at_changed? : Bool
• #updated_at_default : Time

  #updated_at's default value

• #updated_at_present? : Bool
• #updated_at_was : Time | Nil
• #updated_at_will_change! : Nil

  Include #updated_at in the set of changed attributes, whether it has changed or not.

• #validate_nilability

  Validate that all non-nillable fields have values.

Constructor Detail

class User < ActiveModel::Model
  attribute name : String
  attribute google_id : UUID, mass_assign: false
end

User.from_json(%({"main": {"name": "Jason", "google_id": "f6f70bfb-c882-446d-8758-7ce47db39620"}}), root: "main") # => #<User:0x103131b20 @name="Jason">

Class Method Detail

Instance Method Detail