class PlaceOS::Model::Playlist

Included Modules

Defined in:

placeos-models/playlist.cr

Constant Summary

CALLBACKS = {before_save: [] of Nil, after_save: [] 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: [] of Nil, after_destroy: [] of Nil}
Log = ::Log.for(self)

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class PlaceOS::Model::ModelBase

after_create after_create, after_destroy after_destroy, after_save after_save, after_update after_update, apply_defaults apply_defaults, assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String))
assign_attributes(model : PlaceOS::Model::ModelBase)
assign_attributes assign_attributes, attributes attributes, attributes_tuple attributes_tuple, before_create before_create, before_destroy before_destroy, before_save before_save, before_update before_update, invoke_props invoke_props, persistent_attributes persistent_attributes, run_create_callbacks(&) run_create_callbacks, run_destroy_callbacks(&) run_destroy_callbacks, run_save_callbacks(&) run_save_callbacks, run_update_callbacks(&) run_update_callbacks

Constructor methods inherited from class PlaceOS::Model::ModelBase

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
new(pull : JSON::PullParser)
new(rs : DB::ResultSet) new

Class methods inherited from class PlaceOS::Model::ModelBase

attributes : Array(Symbol) attributes, auto_generate_id : Bool auto_generate_id, from_rs(rs : DB::ResultSet) from_rs, primary_key : Symbol primary_key

Instance methods inherited from module PlaceOS::Model::Associations

format_list_for_postgres(list : Enumerable(String)) : String format_list_for_postgres, reset_associations reset_associations

Class methods inherited from module PlaceOS::Model::Associations

format_list_for_postgres(list : Enumerable(String)) : String format_list_for_postgres

Macros inherited from module PlaceOS::Model::Associations

belongs_to(parent_class, dependent = :none, association_name = nil, foreign_key = nil, presence = false, pk_type = nil, serialize = true) belongs_to, has_many(child_class, collection_name = nil, dependent = :none, foreign_key = nil, serialize = false) has_many, has_one(child_class, dependent = :none, association_name = nil, presence = false) has_one

Constructor Detail

def self.from_json(string_or_io : String | IO, trusted : Bool = false) : self #

def 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. Will not deserialise from fields with mass_assign: false

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">

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

def self.from_trusted_json(string_or_io : String | IO) : self #

Serialize from a trusted JSON source


def self.from_trusted_yaml(string_or_io : String | IO) : self #

Serialize from a trusted YAML source


def self.from_yaml(string_or_io : String | IO, trusted : Bool = false) : self #

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

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

def self.new(rs : DB::ResultSet) #

def self.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, authority_id : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, orientation : PlaceOS::Model::Playlist::Orientation | ActiveModel::Model::None = ::ActiveModel::Model::None.new, play_count : Int64 | ActiveModel::Model::None = ::ActiveModel::Model::None.new, play_through_count : Int64 | ActiveModel::Model::None = ::ActiveModel::Model::None.new, default_animation : PlaceOS::Model::Playlist::Animation | ActiveModel::Model::None = ::ActiveModel::Model::None.new, random : Bool | ActiveModel::Model::None = ::ActiveModel::Model::None.new, enabled : Bool | ActiveModel::Model::None = ::ActiveModel::Model::None.new, default_duration : Int32 | ActiveModel::Model::None = ::ActiveModel::Model::None.new, valid_from : Int64 | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, valid_until : Int64 | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, play_hours : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, play_at : Int64 | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, play_cron : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, id : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new) #

def self.new(params : HTTP::Params | Hash(String, String) | Tuple(String, String)) #

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


Class Method Detail

def self.attributes : Array(Symbol) #

Returns all attribute keys.


def self.auto_generate_id : Bool #

def self.by_authority_id(id) #

Look up instances of this model dependent on the foreign key


def self.changes(id : PrimaryKeyType = nil) : ChangeFeed #

Changefeed at row (if #id passed) or whole table level. Returns a ChangeFeed instance which can be used to invoke async callbacks via on or use blocking Iterator via each method.


def self.elastic #

def self.from_rs(__temp_689 : DB::ResultSet) #

def self.on_error(err : Exception | IO::Error) #

def self.primary_key : Symbol #

def self.table_name #

def self.update_counts(metrics : Hash(String, Int32)) #

def self.update_through_counts(metrics : Hash(String, Int32)) #

Instance Method Detail

def __authority : Authority | Nil #

def __authority=(__authority : Authority | Nil) #

def after_create #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def after_destroy #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def after_initialize(trusted : Bool) #

def after_save #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def after_update #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def apply_defaults #

Generate code to apply default values


def assign_attributes(created_at : Time | Missing = Missing, updated_at : Time | Missing = Missing, name : String | Missing = Missing, description : String | Missing = Missing, authority_id : String | Nil | Missing = Missing, orientation : PlaceOS::Model::Playlist::Orientation | Missing = Missing, play_count : Int64 | Missing = Missing, play_through_count : Int64 | Missing = Missing, default_animation : PlaceOS::Model::Playlist::Animation | Missing = Missing, random : Bool | Missing = Missing, enabled : Bool | Missing = Missing, default_duration : Int32 | Missing = Missing, valid_from : Int64 | Nil | Missing = Missing, valid_until : Int64 | Nil | Missing = Missing, play_hours : String | Nil | Missing = Missing, play_at : Int64 | Nil | Missing = Missing, play_cron : String | Nil | Missing = Missing, id : String | Nil | Missing = Missing) #

Assign to multiple attributes.


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

Assign to mulitple attributes via HTTP::Params.


def assign_attributes(model : PlaceOS::Model::Playlist) #

Assign to multiple attributes from a model object


def assign_attributes_from_json(json, root : String) #

def assign_attributes_from_json(json) #

def assign_attributes_from_trusted_json(json, root : String) #

def assign_attributes_from_trusted_json(json) #

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


def assign_attributes_from_trusted_yaml(yaml) #

def assign_attributes_from_yaml(yaml) #

Uses the YAML parser as JSON is valid YAML


def attributes #

Returns a Hash of all attribute values


def attributes_tuple #

Returns a NamedTuple of all attribute values.


def authority : Authority | Nil #

Retrieves the parent relationship


def authority! : Authority #

def authority=(parent : Authority) #

Sets the parent relationship


def authority_id : String | Nil #

#authority_id getter


def authority_id=(value : String | Nil) #

#authority_id setter


def authority_id_assigned? : Bool #

def authority_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


def authority_id_changed? : Bool #

def authority_id_default : String | Nil #

#authority_id's default value


def authority_id_present? : Bool #

def authority_id_was : String | Nil | Nil #

def authority_id_will_change! : Nil #

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


def before_create #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def before_destroy #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def before_save #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def before_update #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def changed? #

Check if any attributes have changed.


def changed_attributes #

Returns a Hash with all changed attributes.


def changed_json(io : IO) : Nil #

Serialize the set of changed attributes to JSON.


def changed_json : String #

Serialize the set of changed attributes to JSON.


def changed_persist_attributes #

def changed_yaml(io : IO) : Nil #

Serialize the set of changed attributes to YAML.


def changed_yaml : String #

Serialize the set of changed attributes to YAML.


def clear_changes_information #

Reset changes for all attributes.


def created_at : Time #

#created_at getter


def created_at=(value : Time) #

Setters #created_at setter


def created_at? : Time | Nil #

def created_at_assigned? : Bool #

def 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


def created_at_changed? : Bool #

def created_at_default : Time #

#created_at's default value


def created_at_present? : Bool #

def created_at_was : Time | Nil #

def created_at_will_change! : Nil #

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


def default_animation : PlaceOS::Model::Playlist::Animation #

#default_animation getter


def default_animation=(value : PlaceOS::Model::Playlist::Animation) #

#default_animation setter


def default_animation? : PlaceOS::Model::Playlist::Animation | Nil #

def default_animation_assigned? : Bool #

def default_animation_change : Tuple(PlaceOS::Model::Playlist::Animation | Nil, PlaceOS::Model::Playlist::Animation | Nil) | Nil #

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


def default_animation_changed? : Bool #

def default_animation_default : Animation #

#default_animation's default value


def default_animation_present? : Bool #

def default_animation_was : PlaceOS::Model::Playlist::Animation | Nil #

def default_animation_will_change! : Nil #

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


def default_duration : Int32 #

#default_duration getter


def default_duration=(value : Int32) #

#default_duration setter


def default_duration? : Int32 | Nil #

time in milliseconds


def default_duration_assigned? : Bool #

def default_duration_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


def default_duration_changed? : Bool #

def default_duration_default : Int32 #

#default_duration's default value


def default_duration_present? : Bool #

time in milliseconds


def default_duration_was : Int32 | Nil #

def default_duration_will_change! : Nil #

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


def description : String #

#description getter


def description=(value : String) #

#description setter


def description? : String | Nil #

def description_assigned? : Bool #

def 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


def description_changed? : Bool #

def description_default : String #

#description's default value


def description_present? : Bool #

def description_was : String | Nil #

def description_will_change! : Nil #

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


def enabled : Bool #

#enabled getter


def enabled=(value : Bool) #

#enabled setter


def enabled? : Bool | Nil #

def enabled_assigned? : Bool #

def enabled_change : Tuple(Bool | Nil, Bool | Nil) | Nil #

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


def enabled_changed? : Bool #

def enabled_default : Bool #

#enabled's default value


def enabled_present? : Bool #

def enabled_was : Bool | Nil #

def enabled_will_change! : Nil #

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


def id : String | Nil #

#id getter


def id=(value : String | Nil) #

#id setter


def id? : String | Nil | Nil #
Description copied from class PgORM::Base

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


def id_assigned? : Bool #

def 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


def id_changed? : Bool #

def id_default : String | Nil #

#id's default value


def id_present? : Bool #

def id_was : String | Nil | Nil #

def id_will_change! : Nil #

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


def invoke_props #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def name : String #

#name getter


def name=(value : String) #

#name setter


def name? : String | Nil #

def name_assigned? : Bool #

def 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


def name_changed? : Bool #

def name_default : String #

#name's default value


def name_present? : Bool #

def name_was : String | Nil #

def name_will_change! : Nil #

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


def orientation : PlaceOS::Model::Playlist::Orientation #

#orientation getter


def orientation=(value : PlaceOS::Model::Playlist::Orientation) #

#orientation setter


def orientation? : PlaceOS::Model::Playlist::Orientation | Nil #

def orientation_assigned? : Bool #

def orientation_change : Tuple(PlaceOS::Model::Playlist::Orientation | Nil, PlaceOS::Model::Playlist::Orientation | Nil) | Nil #

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


def orientation_changed? : Bool #

def orientation_default : Orientation #

#orientation's default value


def orientation_present? : Bool #

def orientation_was : PlaceOS::Model::Playlist::Orientation | Nil #

def orientation_will_change! : Nil #

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


def persistent_attributes #

Returns a Hash of all attributes that can be persisted.


def play_at : Int64 | Nil #

#play_at getter


def play_at=(value : Int64 | Nil) #

#play_at setter


def play_at_assigned? : Bool #

def play_at_change : Tuple(Int64 | Nil | Nil, Int64 | Nil | Nil) | Nil #

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


def play_at_changed? : Bool #

def play_at_default : Int64 | Nil #

#play_at's default value


def play_at_present? : Bool #

start playing the playlist at exactly this time or on CRON schedule play_at will ignore timezones


def play_at_was : Int64 | Nil | Nil #

def play_at_will_change! : Nil #

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


def play_count : Int64 #

#play_count getter


def play_count=(value : Int64) #

#play_count setter


def play_count? : Int64 | Nil #

def play_count_assigned? : Bool #

def play_count_change : Tuple(Int64 | Nil, Int64 | Nil) | Nil #

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


def play_count_changed? : Bool #

def play_count_default : Int64 #

#play_count's default value


def play_count_present? : Bool #

def play_count_was : Int64 | Nil #

def play_count_will_change! : Nil #

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


def play_cron : String | Nil #

#play_cron getter


def play_cron=(value : String | Nil) #

#play_cron setter


def play_cron_assigned? : Bool #

def play_cron_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


def play_cron_changed? : Bool #

def play_cron_default : String | Nil #

#play_cron's default value


def play_cron_present? : Bool #

def play_cron_was : String | Nil | Nil #

def play_cron_will_change! : Nil #

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


def play_hours : String | Nil #

#play_hours getter


def play_hours=(value : String | Nil) #

#play_hours setter


def play_hours_assigned? : Bool #

def play_hours_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


def play_hours_changed? : Bool #

def play_hours_default : String | Nil #

#play_hours's default value


def play_hours_present? : Bool #

hours in the timezone that the playlist should play


def play_hours_was : String | Nil | Nil #

def play_hours_will_change! : Nil #

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


def play_through_count : Int64 #

#play_through_count getter


def play_through_count=(value : Int64) #

#play_through_count setter


def play_through_count? : Int64 | Nil #

def play_through_count_assigned? : Bool #

def play_through_count_change : Tuple(Int64 | Nil, Int64 | Nil) | Nil #

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


def play_through_count_changed? : Bool #

def play_through_count_default : Int64 #

#play_through_count's default value


def play_through_count_present? : Bool #

def play_through_count_was : Int64 | Nil #

def play_through_count_will_change! : Nil #

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


def random : Bool #

#random getter


def random=(value : Bool) #

#random setter


def random? : Bool | Nil #

def random_assigned? : Bool #

def random_change : Tuple(Bool | Nil, Bool | Nil) | Nil #

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


def random_changed? : Bool #

def random_default : Bool #

#random's default value


def random_present? : Bool #

def random_was : Bool | Nil #

def random_will_change! : Nil #

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


def reset_associations #

def restore_attributes #

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


def revision #

def revisions #

def run_create_callbacks(&) #

Wrap a block with callbacks for the appropriate crud operation


def run_destroy_callbacks(&) #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def run_save_callbacks(&) #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def run_update_callbacks(&) #
Description copied from class PlaceOS::Model::ModelBase

Base class for all Engine models


def systems #

def table_name #

def to_items_json(json : JSON::Builder) #

Serialize attributes with :items in its serialization_group option


def to_items_json(io : IO) : Nil #

Serialize attributes with :items in its serialization_group option


def to_items_json : String #

Serialize attributes with :items in its serialization_group option


def to_items_struct #

def updated_at : Time #

#updated_at getter


def updated_at=(value : Time) #

#updated_at setter


def updated_at? : Time | Nil #

def updated_at_assigned? : Bool #

def 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


def updated_at_changed? : Bool #

def updated_at_default : Time #

#updated_at's default value


def updated_at_present? : Bool #

def updated_at_was : Time | Nil #

def updated_at_will_change! : Nil #

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


def valid_from : Int64 | Nil #

#valid_from getter


def valid_from=(value : Int64 | Nil) #

#valid_from setter


def valid_from_assigned? : Bool #

def valid_from_change : Tuple(Int64 | Nil | Nil, Int64 | Nil | Nil) | Nil #

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


def valid_from_changed? : Bool #

def valid_from_default : Int64 | Nil #

#valid_from's default value


def valid_from_present? : Bool #

conditions that can determine when a playlist is valid


def valid_from_was : Int64 | Nil | Nil #

def valid_from_will_change! : Nil #

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


def valid_until : Int64 | Nil #

#valid_until getter


def valid_until=(value : Int64 | Nil) #

#valid_until setter


def valid_until_assigned? : Bool #

def valid_until_change : Tuple(Int64 | Nil | Nil, Int64 | Nil | Nil) | Nil #

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


def valid_until_changed? : Bool #

def valid_until_default : Int64 | Nil #

#valid_until's default value


def valid_until_present? : Bool #

def valid_until_was : Int64 | Nil | Nil #

def valid_until_will_change! : Nil #

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


def validate_nilability #

Validate that all non-nillable fields have values.


def zones #