class PlaceOS::Api::SystemTriggers::IndexParams

Defined in:

placeos-rest-api/controllers/system-triggers.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class PlaceOS::Api::Params

apply_defaults apply_defaults, assign_attributes(params : HTTP::Params | Hash(String, String) | Tuple(String, String))
assign_attributes
assign_attributes
, attributes attributes, attributes_tuple attributes_tuple, persistent_attributes persistent_attributes, validate! validate!

Constructor methods inherited from class PlaceOS::Api::Params

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

Class methods inherited from class PlaceOS::Api::Params

attributes : Array(Symbol) attributes

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) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(complete : Bool | ActiveModel::Model::None = ::ActiveModel::Model::None.new, important : Bool | ActiveModel::Model::None = ::ActiveModel::Model::None.new, triggered : Bool | ActiveModel::Model::None = ::ActiveModel::Model::None.new, trigger_id : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, as_of : Int32 | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new) #

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

Initialize PlaceOS::Api::SystemTriggers::IndexParams from HTTP::Params.


Class Method Detail

def self.attributes : Array(Symbol) #

Returns all attribute keys.


Instance Method Detail

def after_initialize(trusted : Bool) #

def apply_defaults #

Generate code to apply default values


def as_of : Int32 | Nil #

#as_of getter


def as_of=(value : Int32 | Nil) #

#as_of setter


def as_of_change : Tuple(Int32 | Nil | Nil, Int32 | Nil | Nil) | Nil #

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


def as_of_changed? : Bool #

def as_of_default : Int32 | Nil #

#as_of's default value


[View source]
def as_of_present? : Bool #

def as_of_was : Int32 | Nil | Nil #

def as_of_will_change! : Nil #

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


def assign_attributes(complete : Bool | Missing = Missing, important : Bool | Missing = Missing, triggered : Bool | Missing = Missing, trigger_id : String | Nil | Missing = Missing, as_of : Int32 | 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_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 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_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 complete : Bool #

#complete getter


def complete=(value : Bool) #

Setters #complete setter


def complete? : Bool | Nil #

def complete_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 complete_changed? : Bool #

def complete_default : Bool #

#complete's default value


[View source]
def complete_present? : Bool #

def complete_was : Bool | Nil #

def complete_will_change! : Nil #

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


def important : Bool #

#important getter


def important=(value : Bool) #

#important setter


def important? : Bool | Nil #

def important_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 important_changed? : Bool #

def important_default : Bool #

#important's default value


[View source]
def important_present? : Bool #

def important_was : Bool | Nil #

def important_will_change! : Nil #

Include #important 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 restore_attributes #

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


def trigger_id : String | Nil #

#trigger_id getter


def trigger_id=(value : String | Nil) #

#trigger_id setter


def trigger_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 trigger_id_changed? : Bool #

def trigger_id_default : String | Nil #

#trigger_id's default value


[View source]
def trigger_id_present? : Bool #

def trigger_id_was : String | Nil | Nil #

def trigger_id_will_change! : Nil #

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


def triggered : Bool #

#triggered getter


def triggered=(value : Bool) #

#triggered setter


def triggered? : Bool | Nil #

def triggered_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 triggered_changed? : Bool #

def triggered_default : Bool #

#triggered's default value


[View source]
def triggered_present? : Bool #

def triggered_was : Bool | Nil #

def triggered_will_change! : Nil #

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


def validate_nilability #

Validate that all non-nillable fields have values.