Class: XbimComms::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/xbim_comms/models/message.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Message

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
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
228
229
230
231
 
# File 'lib/xbim_comms/models/message.rb', line 141

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XbimComms::Message` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `XbimComms::Message`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'conversation_id')
    self.conversation_id = attributes[:'conversation_id']
  end

  if attributes.key?(:'is_draft')
    self.is_draft = attributes[:'is_draft']
  end

  if attributes.key?(:'content')
    self.content = attributes[:'content']
  end

  if attributes.key?(:'author_name')
    self.author_name = attributes[:'author_name']
  end

  if attributes.key?(:'author_email')
    self.author_email = attributes[:'author_email']
  end

  if attributes.key?(:'date_created')
    self.date_created = attributes[:'date_created']
  end

  if attributes.key?(:'model_id')
    self.model_id = attributes[:'model_id']
  end

  if attributes.key?(:'asset_id')
    self.asset_id = attributes[:'asset_id']
  end

  if attributes.key?(:'trailer')
    self.trailer = attributes[:'trailer']
  end

  if attributes.key?(:'state_changed_time')
    self.state_changed_time = attributes[:'state_changed_time']
  end

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.key?(:'files')
    if (value = attributes[:'files']).is_a?(Array)
      self.files = value
    end
  end

  if attributes.key?(:'default_view')
    self.default_view = attributes[:'default_view']
  end

  if attributes.key?(:'section_box')
    self.section_box = attributes[:'section_box']
  end

  if attributes.key?(:'true_north_angle')
    self.true_north_angle = attributes[:'true_north_angle']
  end

  if attributes.key?(:'html_footer')
    self.html_footer = attributes[:'html_footer']
  end

  if attributes.key?(:'conversation')
    self.conversation = attributes[:'conversation']
  end

  if attributes.key?(:'author')
    self.author = attributes[:'author']
  end
end

Instance Attribute Details

#asset_id ⇒ Object

Returns the value of attribute asset_id.



34
35
36
 
# File 'lib/xbim_comms/models/message.rb', line 34

def asset_id
  @asset_id
end

#author ⇒ Object

Returns the value of attribute author.



54
55
56
 
# File 'lib/xbim_comms/models/message.rb', line 54

def author
  @author
end

#author_email ⇒ Object

Returns the value of attribute author_email.



28
29
30
 
# File 'lib/xbim_comms/models/message.rb', line 28

def author_email
  @author_email
end

#author_name ⇒ Object

Returns the value of attribute author_name.



26
27
28
 
# File 'lib/xbim_comms/models/message.rb', line 26

def author_name
  @author_name
end

#content ⇒ Object

Returns the value of attribute content.



24
25
26
 
# File 'lib/xbim_comms/models/message.rb', line 24

def content
  @content
end

#conversation ⇒ Object

Returns the value of attribute conversation.



52
53
54
 
# File 'lib/xbim_comms/models/message.rb', line 52

def conversation
  @conversation
end

#conversation_id ⇒ Object

Returns the value of attribute conversation_id.



20
21
22
 
# File 'lib/xbim_comms/models/message.rb', line 20

def conversation_id
  @conversation_id
end

#date_created ⇒ Object

Returns the value of attribute date_created.



30
31
32
 
# File 'lib/xbim_comms/models/message.rb', line 30

def date_created
  @date_created
end

#default_view ⇒ Object

Returns the value of attribute default_view.



44
45
46
 
# File 'lib/xbim_comms/models/message.rb', line 44

def default_view
  @default_view
end

#files ⇒ Object

Returns the value of attribute files.



42
43
44
 
# File 'lib/xbim_comms/models/message.rb', line 42

def files
  @files
end

#html_footer ⇒ Object

Returns the value of attribute html_footer.



50
51
52
 
# File 'lib/xbim_comms/models/message.rb', line 50

def html_footer
  @html_footer
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/xbim_comms/models/message.rb', line 18

def id
  @id
end

#is_draft ⇒ Object

Returns the value of attribute is_draft.



22
23
24
 
# File 'lib/xbim_comms/models/message.rb', line 22

def is_draft
  @is_draft
end

#model_id ⇒ Object

Returns the value of attribute model_id.



32
33
34
 
# File 'lib/xbim_comms/models/message.rb', line 32

def model_id
  @model_id
end

#section_box ⇒ Object

Returns the value of attribute section_box.



46
47
48
 
# File 'lib/xbim_comms/models/message.rb', line 46

def section_box
  @section_box
end

#state ⇒ Object

Returns the value of attribute state.



40
41
42
 
# File 'lib/xbim_comms/models/message.rb', line 40

def state
  @state
end

#state_changed_time ⇒ Object

Returns the value of attribute state_changed_time.



38
39
40
 
# File 'lib/xbim_comms/models/message.rb', line 38

def state_changed_time
  @state_changed_time
end

#trailer ⇒ Object

Returns the value of attribute trailer.



36
37
38
 
# File 'lib/xbim_comms/models/message.rb', line 36

def trailer
  @trailer
end

#true_north_angle ⇒ Object

Returns the value of attribute true_north_angle.



48
49
50
 
# File 'lib/xbim_comms/models/message.rb', line 48

def true_north_angle
  @true_north_angle
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



104
105
106
 
# File 'lib/xbim_comms/models/message.rb', line 104

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/xbim_comms/models/message.rb', line 79

def self.attribute_map
  {
    :'id' => :'id',
    :'conversation_id' => :'conversationID',
    :'is_draft' => :'isDraft',
    :'content' => :'content',
    :'author_name' => :'authorName',
    :'author_email' => :'authorEmail',
    :'date_created' => :'dateCreated',
    :'model_id' => :'modelId',
    :'asset_id' => :'assetId',
    :'trailer' => :'trailer',
    :'state_changed_time' => :'stateChangedTime',
    :'state' => :'state',
    :'files' => :'files',
    :'default_view' => :'defaultView',
    :'section_box' => :'sectionBox',
    :'true_north_angle' => :'trueNorthAngle',
    :'html_footer' => :'htmlFooter',
    :'conversation' => :'conversation',
    :'author' => :'author'
  }
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



299
300
301
 
# File 'lib/xbim_comms/models/message.rb', line 299

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



134
135
136
137
 
# File 'lib/xbim_comms/models/message.rb', line 134

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/xbim_comms/models/message.rb', line 109

def self.openapi_types
  {
    :'id' => :'Integer',
    :'conversation_id' => :'Integer',
    :'is_draft' => :'Boolean',
    :'content' => :'MessageContent',
    :'author_name' => :'String',
    :'author_email' => :'String',
    :'date_created' => :'Time',
    :'model_id' => :'Integer',
    :'asset_id' => :'Integer',
    :'trailer' => :'String',
    :'state_changed_time' => :'Time',
    :'state' => :'String',
    :'files' => :'Array<Blob>',
    :'default_view' => :'Viewpoint',
    :'section_box' => :'SectionBox',
    :'true_north_angle' => :'Float',
    :'html_footer' => :'String',
    :'conversation' => :'Conversation',
    :'author' => :'Participant'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/xbim_comms/models/message.rb', line 260

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      conversation_id == o.conversation_id &&
      is_draft == o.is_draft &&
      content == o.content &&
      author_name == o.author_name &&
      author_email == o.author_email &&
      date_created == o.date_created &&
      model_id == o.model_id &&
      asset_id == o.asset_id &&
      trailer == o.trailer &&
      state_changed_time == o.state_changed_time &&
      state == o.state &&
      files == o.files &&
      default_view == o.default_view &&
      section_box == o.section_box &&
      true_north_angle == o.true_north_angle &&
      html_footer == o.html_footer &&
      conversation == o.conversation &&
      author == o.author
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/xbim_comms/models/message.rb', line 329

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = XbimComms.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/xbim_comms/models/message.rb', line 400

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/xbim_comms/models/message.rb', line 306

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


286
287
288
 
# File 'lib/xbim_comms/models/message.rb', line 286

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



292
293
294
 
# File 'lib/xbim_comms/models/message.rb', line 292

def hash
  [id, conversation_id, is_draft, content, author_name, author_email, date_created, model_id, asset_id, trailer, state_changed_time, state, files, default_view, section_box, true_north_angle, html_footer, conversation, author].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



235
236
237
238
 
# File 'lib/xbim_comms/models/message.rb', line 235

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



376
377
378
 
# File 'lib/xbim_comms/models/message.rb', line 376

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/xbim_comms/models/message.rb', line 382

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



370
371
372
 
# File 'lib/xbim_comms/models/message.rb', line 370

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



242
243
244
245
246
 
# File 'lib/xbim_comms/models/message.rb', line 242

def valid?
  state_validator = EnumAttributeValidator.new('String', ["NotRead", "Read", "Dismissed"])
  return false unless state_validator.valid?(@state)
  true
end