primary_key
Base class for all Engine models
PlaceOS::Model::SignagePlugin
Inherits PlaceOS::Model::Timestamps < PlaceOS::Model::ModelBase < PlaceOS::Model::Associations < Neuroplastic < PgORM::Base < PgORM::Validators < PgORM::Table < PgORM::Persistence < PgORM::Associations < ActiveModel::Callbacks < ActiveModel::Validation < ActiveModel::Model < DB::Mappable < DB::Serializable < YAML::Serializable < JSON::Serializable < Reference < Object
Constants
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)
PRIMARY_KEY_TYPES = {:id => (String | Nil)} of Nil => Nil
macro level key => type
PRIMARY_KEYS = [{:id}]
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. 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">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)
Sourcenew(pull : JSON::PullParser)
Sourcenew(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, uri : String | ActiveModel::Model::None = ::ActiveModel::Model::None.new, playback_type : PlaceOS::Model::SignagePlugin::PlaybackType | ActiveModel::Model::None = ::ActiveModel::Model::None.new, plugin_type : PlaceOS::Model::SignagePlugin::PluginType | ActiveModel::Model::None = ::ActiveModel::Model::None.new, authority_id : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, enabled : Bool | ActiveModel::Model::None = ::ActiveModel::Model::None.new, params : Hash(String, JSON::Any) | ActiveModel::Model::None = ::ActiveModel::Model::None.new, defaults : Hash(String, JSON::Any) | 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::SignagePlugin from HTTP::Params.
Class methods
attributes
Returns all attribute keys.
changes(id : String | Nil | Nil = 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.
elastic
from_rs(__temp_2407 : DB::ResultSet)
on_error(err : Exception | IO::Error)
table_name
Instance methods
__authority
__authority=(__authority : Authority | Nil)
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, uri : String | Missing = Missing, playback_type : PlaceOS::Model::SignagePlugin::PlaybackType | Missing = Missing, plugin_type : PlaceOS::Model::SignagePlugin::PluginType | Missing = Missing, authority_id : String | Nil | Missing = Missing, enabled : Bool | Missing = Missing, params : Hash(String, JSON::Any) | Missing = Missing, defaults : Hash(String, JSON::Any) | Missing = Missing, id : String | Nil | Missing = Missing)
Assign to multiple attributes.
assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String))
Assign to multiple attributes via HTTP::Params.
assign_attributes(model : PlaceOS::Model::SignagePlugin)
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.
authority!
Sourceauthority_id
authority_id getter
authority_id=(value : String | Nil)
authority_id setter
authority_id_assigned?
authority_id_change
Returns a Tuple of the previous and the current value of an instance variable if it has changed
authority_id_changed?
authority_id_default
authority_id's default value
authority_id_present?
authority_id_removed?
authority_id_was
authority_id_will_change!
Include authority_id in the set of changed attributes, whether it has changed or not.
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
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
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
Serialize the set of changed attributes to YAML.
clear_changes_information
Reset changes for all attributes.
created_at
created_at getter
created_at=(value : Time)
Setters
created_at setter
created_at?
NOTE: use getter / getter! (not property / property!) so that the
setter defined later in __create_initializer__ is the only setter on
the field. Crystal's overload resolution silently fails to replace a
property-defined setter with one of identical signature for generic
types (e.g. Set(String)?, Array(String)?, String | Array(String)),
although it does work for non-generic ones like String?. Defining the
setter only once via __create_initializer__ ensures change tracking,
sanitization, and custom setter blocks run uniformly across all types.
created_at_assigned?
created_at_change
Returns a Tuple of the previous and the current value of an instance variable if it has changed
created_at_changed?
created_at_default
created_at's default value
created_at_present?
created_at_removed?
created_at_was
created_at_will_change!
Include created_at in the set of changed attributes, whether it has changed or not.
defaults
defaults getter
defaults=(value : Hash(String, JSON::Any))
defaults setter
defaults?
NOTE: use getter / getter! (not property / property!) so that the
setter defined later in __create_initializer__ is the only setter on
the field. Crystal's overload resolution silently fails to replace a
property-defined setter with one of identical signature for generic
types (e.g. Set(String)?, Array(String)?, String | Array(String)),
although it does work for non-generic ones like String?. Defining the
setter only once via __create_initializer__ ensures change tracking,
sanitization, and custom setter blocks run uniformly across all types.
defaults_assigned?
defaults_change
Returns a Tuple of the previous and the current value of an instance variable if it has changed
defaults_changed?
defaults_present?
defaults_removed?
defaults_was
defaults_will_change!
Include defaults in the set of changed attributes, whether it has changed or not.
description
description getter
description=(value : String)
description setter
description?
NOTE: use getter / getter! (not property / property!) so that the
setter defined later in __create_initializer__ is the only setter on
the field. Crystal's overload resolution silently fails to replace a
property-defined setter with one of identical signature for generic
types (e.g. Set(String)?, Array(String)?, String | Array(String)),
although it does work for non-generic ones like String?. Defining the
setter only once via __create_initializer__ ensures change tracking,
sanitization, and custom setter blocks run uniformly across all types.
description_assigned?
description_change
Returns a Tuple of the previous and the current value of an instance variable if it has changed
description_changed?
description_present?
description_removed?
description_was
description_will_change!
Include description in the set of changed attributes, whether it has changed or not.
enabled
enabled getter
enabled=(value : Bool)
enabled setter
enabled?
NOTE: use getter / getter! (not property / property!) so that the
setter defined later in __create_initializer__ is the only setter on
the field. Crystal's overload resolution silently fails to replace a
property-defined setter with one of identical signature for generic
types (e.g. Set(String)?, Array(String)?, String | Array(String)),
although it does work for non-generic ones like String?. Defining the
setter only once via __create_initializer__ ensures change tracking,
sanitization, and custom setter blocks run uniformly across all types.
enabled_assigned?
enabled_change
Returns a Tuple of the previous and the current value of an instance variable if it has changed
enabled_changed?
enabled_present?
enabled_removed?
enabled_was
enabled_will_change!
Include enabled in the set of changed attributes, whether it has changed or not.
id
id getter
id=(value : String | Nil)
id setter
id?
id_assigned?
id_change
Returns a Tuple of the previous and the current value of an instance variable if it has changed
id_changed?
id_default
id's default value
id_present?
id_removed?
id_was
id_will_change!
Include id in the set of changed attributes, whether it has changed or not.
invoke_props
Base class for all Engine models
name
name getter
name=(value : String)
name setter
name?
NOTE: use getter / getter! (not property / property!) so that the
setter defined later in __create_initializer__ is the only setter on
the field. Crystal's overload resolution silently fails to replace a
property-defined setter with one of identical signature for generic
types (e.g. Set(String)?, Array(String)?, String | Array(String)),
although it does work for non-generic ones like String?. Defining the
setter only once via __create_initializer__ ensures change tracking,
sanitization, and custom setter blocks run uniformly across all types.
name_assigned?
name_change
Returns a Tuple of the previous and the current value of an instance variable if it has changed
name_changed?
name_present?
name_removed?
name_was
name_will_change!
Include name in the set of changed attributes, whether it has changed or not.
params
params getter
params=(value : Hash(String, JSON::Any))
params setter
params?
NOTE: use getter / getter! (not property / property!) so that the
setter defined later in __create_initializer__ is the only setter on
the field. Crystal's overload resolution silently fails to replace a
property-defined setter with one of identical signature for generic
types (e.g. Set(String)?, Array(String)?, String | Array(String)),
although it does work for non-generic ones like String?. Defining the
setter only once via __create_initializer__ ensures change tracking,
sanitization, and custom setter blocks run uniformly across all types.
params_assigned?
params_change
Returns a Tuple of the previous and the current value of an instance variable if it has changed
params_changed?
params_present?
params_removed?
params_was
params_will_change!
Include params in the set of changed attributes, whether it has changed or not.
persistent_attributes
Returns a Hash of all attributes that can be persisted.
playback_type
playback_type getter
playback_type=(value : PlaceOS::Model::SignagePlugin::PlaybackType)
playback_type setter
playback_type?
NOTE: use getter / getter! (not property / property!) so that the
setter defined later in __create_initializer__ is the only setter on
the field. Crystal's overload resolution silently fails to replace a
property-defined setter with one of identical signature for generic
types (e.g. Set(String)?, Array(String)?, String | Array(String)),
although it does work for non-generic ones like String?. Defining the
setter only once via __create_initializer__ ensures change tracking,
sanitization, and custom setter blocks run uniformly across all types.
playback_type_assigned?
playback_type_change
Returns a Tuple of the previous and the current value of an instance variable if it has changed
playback_type_changed?
playback_type_present?
playback_type_removed?
playback_type_was
playback_type_will_change!
Include playback_type in the set of changed attributes, whether it has changed or not.
plugin_type
plugin_type getter
plugin_type=(value : PlaceOS::Model::SignagePlugin::PluginType)
plugin_type setter
plugin_type?
NOTE: use getter / getter! (not property / property!) so that the
setter defined later in __create_initializer__ is the only setter on
the field. Crystal's overload resolution silently fails to replace a
property-defined setter with one of identical signature for generic
types (e.g. Set(String)?, Array(String)?, String | Array(String)),
although it does work for non-generic ones like String?. Defining the
setter only once via __create_initializer__ ensures change tracking,
sanitization, and custom setter blocks run uniformly across all types.
plugin_type_assigned?
plugin_type_change
Returns a Tuple of the previous and the current value of an instance variable if it has changed
plugin_type_changed?
plugin_type_present?
widgets are embeddable in signage templates; plugins play in playlists
plugin_type_removed?
plugin_type_was
plugin_type_will_change!
Include plugin_type in the set of changed attributes, whether it has changed or not.
primary_key_hash
reset_associations
Sourcerestore_attributes
Reset each attribute to their previous values and clears all changes.
table_name
updated_at
updated_at getter
updated_at=(value : Time)
updated_at setter
updated_at?
NOTE: use getter / getter! (not property / property!) so that the
setter defined later in __create_initializer__ is the only setter on
the field. Crystal's overload resolution silently fails to replace a
property-defined setter with one of identical signature for generic
types (e.g. Set(String)?, Array(String)?, String | Array(String)),
although it does work for non-generic ones like String?. Defining the
setter only once via __create_initializer__ ensures change tracking,
sanitization, and custom setter blocks run uniformly across all types.
updated_at_assigned?
updated_at_change
Returns a Tuple of the previous and the current value of an instance variable if it has changed
updated_at_changed?
updated_at_default
updated_at's default value
updated_at_present?
updated_at_removed?
updated_at_was
updated_at_will_change!
Include updated_at in the set of changed attributes, whether it has changed or not.
uri
uri getter
uri=(value : String)
uri setter
uri?
NOTE: use getter / getter! (not property / property!) so that the
setter defined later in __create_initializer__ is the only setter on
the field. Crystal's overload resolution silently fails to replace a
property-defined setter with one of identical signature for generic
types (e.g. Set(String)?, Array(String)?, String | Array(String)),
although it does work for non-generic ones like String?. Defining the
setter only once via __create_initializer__ ensures change tracking,
sanitization, and custom setter blocks run uniformly across all types.
uri_assigned?
uri_change
Returns a Tuple of the previous and the current value of an instance variable if it has changed
uri_changed?
uri_present?
uri_removed?
uri_was
uri_will_change!
Include uri in the set of changed attributes, whether it has changed or not.
validate_nilability
Validate that all non-nillable fields have values.