class PlaceOS::Api::SystemTriggers::UpdateParams

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(enabled : Bool | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, important : Bool | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, exec_enabled : Bool | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new) #

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

Initialize PlaceOS::Api::SystemTriggers::UpdateParams 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 assign_attributes(enabled : Bool | Nil | Missing = Missing, important : Bool | Nil | Missing = Missing, exec_enabled : Bool | 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 enabled : Bool | Nil #

#enabled getter


def enabled=(value : Bool | Nil) #

Setters #enabled setter


def enabled_change : Tuple(Bool | Nil | Nil, Bool | Nil | 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 | Nil #

#enabled's default value


[View source]
def enabled_present? : Bool #

def enabled_was : Bool | Nil | Nil #

def enabled_will_change! : Nil #

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


def exec_enabled : Bool | Nil #

#exec_enabled getter


def exec_enabled=(value : Bool | Nil) #

#exec_enabled setter


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

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


def exec_enabled_changed? : Bool #

def exec_enabled_default : Bool | Nil #

#exec_enabled's default value


[View source]
def exec_enabled_present? : Bool #

def exec_enabled_was : Bool | Nil | Nil #

def exec_enabled_will_change! : Nil #

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


def important : Bool | Nil #

#important getter


def important=(value : Bool | Nil) #

#important setter


def important_change : Tuple(Bool | Nil | Nil, Bool | Nil | 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 | Nil #

#important's default value


[View source]
def important_present? : Bool #

def important_was : Bool | Nil | 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 validate_nilability #

Validate that all non-nillable fields have values.