class

PlaceOS::Model::Survey::Invitation

Inherits PlaceOS::Model::Timestamps < PlaceOS::Model::Scope < PlaceOS::Model::Associations < PlaceOS::Model::ModelWithAutoKey < 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: [:generate_token, 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 => (Int64 | 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)

new(pull : JSON::PullParser)

new(rs : DB::ResultSet)

new(token : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, email : String | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, sent : Bool | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, survey_id : Int64 | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, id : Int64 | Nil | ActiveModel::Model::None = ::ActiveModel::Model::None.new, created_at : Time | ActiveModel::Model::None = ::ActiveModel::Model::None.new, updated_at : Time | ActiveModel::Model::None = ::ActiveModel::Model::None.new)

new(params : HTTP::Params | Hash(String, String) | Tuple(String, String))

Initialize PlaceOS::Model::Survey::Invitation from HTTP::Params.

Class methods

attributes

Returns all attribute keys.

by_survey_id(id)

Look up instances of this model dependent on the foreign key

changes(id : Int64 | 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_2536 : DB::ResultSet)

list(survey_id : Int64 | Nil = nil, sent : Bool | Nil = nil)

on_error(err : Exception | IO::Error)

primary_key

Base class for all models which have auto-generated bigint as pk and doesn't require string based auto generated pk

table_name

Instance methods

__survey

__survey=(__survey : Survey | Nil)

after_create

Base class for all models which have auto-generated bigint as pk and doesn't require string based auto generated pk

after_destroy

Base class for all models which have auto-generated bigint as pk and doesn't require string based auto generated pk

after_initialize(trusted : Bool)

after_save

Base class for all models which have auto-generated bigint as pk and doesn't require string based auto generated pk

after_update

Base class for all models which have auto-generated bigint as pk and doesn't require string based auto generated pk

apply_defaults

Generate code to apply default values

assign_attributes(token : String | Nil | Missing = Missing, email : String | Nil | Missing = Missing, sent : Bool | Nil | Missing = Missing, survey_id : Int64 | Nil | Missing = Missing, id : Int64 | Nil | Missing = Missing, created_at : Time | Missing = Missing, updated_at : Time | 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::Survey::Invitation)

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 models which have auto-generated bigint as pk and doesn't require string based auto generated pk

before_destroy

Base class for all models which have auto-generated bigint as pk and doesn't require string based auto generated pk

before_save

Base class for all models which have auto-generated bigint as pk and doesn't require string based auto generated pk

before_update

Base class for all models which have auto-generated bigint as pk and doesn't require string based auto generated pk

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)

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.

email

email getter

email=(value : String | Nil)

email setter

email_assigned?

email_change

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

email_changed?

email_default

email's default value

email_present?

email_removed?

email_was

email_will_change!

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

generate_token

id

id getter

id=(value : Int64 | 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 models which have auto-generated bigint as pk and doesn't require string based auto generated pk

patch(changes : self)

persistent_attributes

Returns a Hash of all attributes that can be persisted.

primary_key

Base class for all models which have auto-generated bigint as pk and doesn't require string based auto generated pk

primary_key_hash

reset_associations

restore_attributes

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

sent

sent getter

sent=(value : Bool | Nil)

sent setter

sent_assigned?

sent_change

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

sent_changed?

sent_default

sent's default value

sent_present?

sent_removed?

sent_was

sent_will_change!

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

survey

Retrieves the parent relationship

survey!

survey=(parent : Survey)

Sets the parent relationship

survey_id

survey_id getter

survey_id=(value : Int64 | Nil)

survey_id setter

survey_id_assigned?

survey_id_change

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

survey_id_changed?

survey_id_default

survey_id's default value

survey_id_present?

survey_id_removed?

survey_id_was

survey_id_will_change!

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

table_name

token

token getter

token=(value : String | Nil)

Setters token setter

token_assigned?

token_change

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

token_changed?

token_default

token's default value

token_present?

token_removed?

token_was

token_will_change!

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

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.

validate_nilability

Validate that all non-nillable fields have values.

Macros

scope(name, &block)

Nested types