Class: MParticle::ScreenViewEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/mparticle/models/screen_view_event.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScreenViewEvent

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/mparticle/models/screen_view_event.rb', line 65

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.timestamp_unixtime_ms = 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.source_message_id = 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?(:'screen_name')
    self.screen_name = attributes[:'screen_name']
  end

  if attributes.has_key?(:'activity_type')
    self.activity_type = attributes[:'activity_type']
  end

  if attributes.has_key?(:'custom_flags')
    self.custom_flags = attributes[:'custom_flags']
  end

end

Instance Attribute Details

#activity_typeObject

Returns the value of attribute activity_type.



24
25
26
# File 'lib/mparticle/models/screen_view_event.rb', line 24

def activity_type
  @activity_type
end

#custom_attributesObject

Returns the value of attribute custom_attributes.



16
17
18
# File 'lib/mparticle/models/screen_view_event.rb', line 16

def custom_attributes
  @custom_attributes
end

#custom_flagsObject

Returns the value of attribute custom_flags.



26
27
28
# File 'lib/mparticle/models/screen_view_event.rb', line 26

def custom_flags
  @custom_flags
end

#device_current_stateObject

Returns the value of attribute device_current_state.



20
21
22
# File 'lib/mparticle/models/screen_view_event.rb', line 20

def device_current_state
  @device_current_state
end

#event_idObject

Returns the value of attribute event_id.



8
9
10
# File 'lib/mparticle/models/screen_view_event.rb', line 8

def event_id
  @event_id
end

#locationObject

Returns the value of attribute location.



18
19
20
# File 'lib/mparticle/models/screen_view_event.rb', line 18

def location
  @location
end

#screen_nameObject

Returns the value of attribute screen_name.



22
23
24
# File 'lib/mparticle/models/screen_view_event.rb', line 22

def screen_name
  @screen_name
end

#session_idObject

Returns the value of attribute session_id.



12
13
14
# File 'lib/mparticle/models/screen_view_event.rb', line 12

def session_id
  @session_id
end

#session_uuidObject

Returns the value of attribute session_uuid.



14
15
16
# File 'lib/mparticle/models/screen_view_event.rb', line 14

def session_uuid
  @session_uuid
end

#source_message_idObject

Returns the value of attribute source_message_id.



10
11
12
# File 'lib/mparticle/models/screen_view_event.rb', line 10

def source_message_id
  @source_message_id
end

#timestamp_unixtime_msObject

Returns the value of attribute timestamp_unixtime_ms.



6
7
8
# File 'lib/mparticle/models/screen_view_event.rb', line 6

def timestamp_unixtime_ms
  @timestamp_unixtime_ms
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/mparticle/models/screen_view_event.rb', line 30

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',
    :'screen_name' => :'screen_name',
    :'activity_type' => :'activity_type',
    :'custom_flags' => :'custom_flags',
  }
end

.swagger_typesObject

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/mparticle/models/screen_view_event.rb', line 47

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',
    :'screen_name' => :'String',
    :'activity_type' => :'String',
    :'custom_flags' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# File 'lib/mparticle/models/screen_view_event.rb', line 139

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      timestamp_unixtime_ms == o.timestamp_unixtime_ms &&
      event_id == o.event_id &&
      source_message_id == o.source_message_id &&
      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 &&
      screen_name == o.screen_name &&
      activity_type == o.activity_type &&
      custom_flags == o.custom_flags
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
# File 'lib/mparticle/models/screen_view_event.rb', line 191

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

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/mparticle/models/screen_view_event.rb', line 257

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

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/mparticle/models/screen_view_event.rb', line 170

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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


157
158
159
# File 'lib/mparticle/models/screen_view_event.rb', line 157

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



163
164
165
# File 'lib/mparticle/models/screen_view_event.rb', line 163

def hash
  [timestamp_unixtime_ms, event_id, source_message_id, session_id, session_uuid, custom_attributes, location, device_current_state, screen_name, activity_type, custom_flags].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



121
122
123
124
125
126
127
128
# File 'lib/mparticle/models/screen_view_event.rb', line 121

def list_invalid_properties
  invalid_properties = Array.new
  if @screen_name.nil?
    invalid_properties.push("invalid value for 'screen_name', screen_name cannot be nil.")
  end

  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



237
238
239
# File 'lib/mparticle/models/screen_view_event.rb', line 237

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



243
244
245
246
247
248
249
250
251
# File 'lib/mparticle/models/screen_view_event.rb', line 243

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



231
232
233
# File 'lib/mparticle/models/screen_view_event.rb', line 231

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



132
133
134
135
# File 'lib/mparticle/models/screen_view_event.rb', line 132

def valid?
  return false if @screen_name.nil?
  return true
end