Class: MParticle::PushMessageEvent
- Inherits:
-
Object
- Object
- MParticle::PushMessageEvent
- Defined in:
- lib/mparticle/models/push_message_event.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#action_identifier ⇒ Object
Returns the value of attribute action_identifier.
-
#application_state ⇒ Object
Returns the value of attribute application_state.
-
#custom_attributes ⇒ Object
Returns the value of attribute custom_attributes.
-
#device_current_state ⇒ Object
Returns the value of attribute device_current_state.
-
#event_id ⇒ Object
Returns the value of attribute event_id.
-
#location ⇒ Object
Returns the value of attribute location.
-
#message ⇒ Object
Returns the value of attribute message.
-
#network ⇒ Object
Returns the value of attribute network.
-
#push_message_token ⇒ Object
Returns the value of attribute push_message_token.
-
#push_message_type ⇒ Object
Returns the value of attribute push_message_type.
-
#push_notification_payload ⇒ Object
Returns the value of attribute push_notification_payload.
-
#session_id ⇒ Object
Returns the value of attribute session_id.
-
#session_uuid ⇒ Object
Returns the value of attribute session_uuid.
-
#source_message_id ⇒ Object
Returns the value of attribute source_message_id.
-
#timestamp_unixtime_ms ⇒ Object
Returns the value of attribute timestamp_unixtime_ms.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PushMessageEvent
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ PushMessageEvent
Initializes the object
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/mparticle/models/push_message_event.rb', line 102 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'timestamp_unixtime_ms') self. = attributes[:'timestamp_unixtime_ms'] end if attributes.has_key?(:'event_id') self.event_id = attributes[:'event_id'] end if attributes.has_key?(:'source_message_id') self. = attributes[:'source_message_id'] end if attributes.has_key?(:'session_id') self.session_id = attributes[:'session_id'] end if attributes.has_key?(:'session_uuid') self.session_uuid = attributes[:'session_uuid'] end if attributes.has_key?(:'custom_attributes') if (value = attributes[:'custom_attributes']).is_a?(Hash) self.custom_attributes = value end end if attributes.has_key?(:'location') self.location = attributes[:'location'] end if attributes.has_key?(:'device_current_state') self.device_current_state = attributes[:'device_current_state'] end if attributes.has_key?(:'push_message_token') self. = attributes[:'push_message_token'] end if attributes.has_key?(:'push_message_type') self. = attributes[:'push_message_type'] end if attributes.has_key?(:'message') self. = attributes[:'message'] end if attributes.has_key?(:'network') self.network = attributes[:'network'] end if attributes.has_key?(:'push_notification_payload') self.push_notification_payload = attributes[:'push_notification_payload'] end if attributes.has_key?(:'application_state') self.application_state = attributes[:'application_state'] end if attributes.has_key?(:'action_identifier') self.action_identifier = attributes[:'action_identifier'] end end |
Instance Attribute Details
#action_identifier ⇒ Object
Returns the value of attribute action_identifier.
34 35 36 |
# File 'lib/mparticle/models/push_message_event.rb', line 34 def action_identifier @action_identifier end |
#application_state ⇒ Object
Returns the value of attribute application_state.
32 33 34 |
# File 'lib/mparticle/models/push_message_event.rb', line 32 def application_state @application_state end |
#custom_attributes ⇒ Object
Returns the value of attribute custom_attributes.
16 17 18 |
# File 'lib/mparticle/models/push_message_event.rb', line 16 def custom_attributes @custom_attributes end |
#device_current_state ⇒ Object
Returns the value of attribute device_current_state.
20 21 22 |
# File 'lib/mparticle/models/push_message_event.rb', line 20 def device_current_state @device_current_state end |
#event_id ⇒ Object
Returns the value of attribute event_id.
8 9 10 |
# File 'lib/mparticle/models/push_message_event.rb', line 8 def event_id @event_id end |
#location ⇒ Object
Returns the value of attribute location.
18 19 20 |
# File 'lib/mparticle/models/push_message_event.rb', line 18 def location @location end |
#message ⇒ Object
Returns the value of attribute message.
26 27 28 |
# File 'lib/mparticle/models/push_message_event.rb', line 26 def @message end |
#network ⇒ Object
Returns the value of attribute network.
28 29 30 |
# File 'lib/mparticle/models/push_message_event.rb', line 28 def network @network end |
#push_message_token ⇒ Object
Returns the value of attribute push_message_token.
22 23 24 |
# File 'lib/mparticle/models/push_message_event.rb', line 22 def @push_message_token end |
#push_message_type ⇒ Object
Returns the value of attribute push_message_type.
24 25 26 |
# File 'lib/mparticle/models/push_message_event.rb', line 24 def @push_message_type end |
#push_notification_payload ⇒ Object
Returns the value of attribute push_notification_payload.
30 31 32 |
# File 'lib/mparticle/models/push_message_event.rb', line 30 def push_notification_payload @push_notification_payload end |
#session_id ⇒ Object
Returns the value of attribute session_id.
12 13 14 |
# File 'lib/mparticle/models/push_message_event.rb', line 12 def session_id @session_id end |
#session_uuid ⇒ Object
Returns the value of attribute session_uuid.
14 15 16 |
# File 'lib/mparticle/models/push_message_event.rb', line 14 def session_uuid @session_uuid end |
#source_message_id ⇒ Object
Returns the value of attribute source_message_id.
10 11 12 |
# File 'lib/mparticle/models/push_message_event.rb', line 10 def @source_message_id end |
#timestamp_unixtime_ms ⇒ Object
Returns the value of attribute timestamp_unixtime_ms.
6 7 8 |
# File 'lib/mparticle/models/push_message_event.rb', line 6 def @timestamp_unixtime_ms end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/mparticle/models/push_message_event.rb', line 59 def self.attribute_map { :'timestamp_unixtime_ms' => :'timestamp_unixtime_ms', :'event_id' => :'event_id', :'source_message_id' => :'source_message_id', :'session_id' => :'session_id', :'session_uuid' => :'session_uuid', :'custom_attributes' => :'custom_attributes', :'location' => :'location', :'device_current_state' => :'device_current_state', :'push_message_token' => :'push_message_token', :'push_message_type' => :'push_message_type', :'message' => :'message', :'network' => :'network', :'push_notification_payload' => :'push_notification_payload', :'application_state' => :'application_state', :'action_identifier' => :'action_identifier' } end |
.swagger_types ⇒ Object
Attribute type mapping.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/mparticle/models/push_message_event.rb', line 80 def self.swagger_types { :'timestamp_unixtime_ms' => :'Integer', :'event_id' => :'Integer', :'source_message_id' => :'String', :'session_id' => :'Integer', :'session_uuid' => :'String', :'custom_attributes' => :'Hash<String, String>', :'location' => :'GeoLocation', :'device_current_state' => :'DeviceCurrentState', :'push_message_token' => :'String', :'push_message_type' => :'String', :'message' => :'String', :'network' => :'String', :'push_notification_payload' => :'String', :'application_state' => :'String', :'action_identifier' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/mparticle/models/push_message_event.rb', line 231 def ==(o) return true if self.equal?(o) self.class == o.class && == o. && event_id == o.event_id && == o. && session_id == o.session_id && session_uuid == o.session_uuid && custom_attributes == o.custom_attributes && location == o.location && device_current_state == o.device_current_state && == o. && == o. && == o. && network == o.network && push_notification_payload == o.push_notification_payload && application_state == o.application_state && action_identifier == o.action_identifier end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/mparticle/models/push_message_event.rb', line 287 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = MParticle.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
353 354 355 356 357 358 359 360 361 362 363 364 365 |
# File 'lib/mparticle/models/push_message_event.rb', line 353 def _to_hash(value) if value.is_a?(Array) value.compact.map{ |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/mparticle/models/push_message_event.rb', line 266 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
253 254 255 |
# File 'lib/mparticle/models/push_message_event.rb', line 253 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
259 260 261 |
# File 'lib/mparticle/models/push_message_event.rb', line 259 def hash [, event_id, , session_id, session_uuid, custom_attributes, location, device_current_state, , , , network, push_notification_payload, application_state, action_identifier].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/mparticle/models/push_message_event.rb', line 174 def list_invalid_properties invalid_properties = Array.new if @push_message_token.nil? invalid_properties.push("invalid value for 'push_message_token', push_message_token cannot be nil.") end if @push_message_type.nil? invalid_properties.push("invalid value for 'push_message_type', push_message_type cannot be nil.") end if @push_notification_payload.nil? invalid_properties.push("invalid value for 'push_notification_payload', push_notification_payload cannot be nil.") end if @application_state.nil? invalid_properties.push("invalid value for 'application_state', application_state cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
333 334 335 |
# File 'lib/mparticle/models/push_message_event.rb', line 333 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
339 340 341 342 343 344 345 346 347 |
# File 'lib/mparticle/models/push_message_event.rb', line 339 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
327 328 329 |
# File 'lib/mparticle/models/push_message_event.rb', line 327 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/mparticle/models/push_message_event.rb', line 197 def valid? return false if @push_message_token.nil? return false if @push_message_type.nil? = EnumAttributeValidator.new('String', ["unknown", "sent", "received", "action"]) return false unless .valid?(@push_message_type) return false if @push_notification_payload.nil? return false if @application_state.nil? application_state_validator = EnumAttributeValidator.new('String', ["unknown", "not_running", "background", "foreground"]) return false unless application_state_validator.valid?(@application_state) return true end |