Class: FlatApi::ScoreComment

Inherits:
Object
  • Object
show all
Defined in:
lib/flat_api/models/score_comment.rb

Overview

Comment added on a sheet music

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScoreComment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/flat_api/models/score_comment.rb', line 144

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ScoreComment` 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 `FlatApi::ScoreComment`. 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?(:'type')
    self.type = attributes[:'type']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#comment ⇒ Object

The comment text that can includes mentions using the following format: ‘@[id:username]`.



44
45
46
 
# File 'lib/flat_api/models/score_comment.rb', line 44

def comment
  @comment
end

#context ⇒ Object

Returns the value of attribute context.



49
50
51
 
# File 'lib/flat_api/models/score_comment.rb', line 49

def context
  @context
end

#date ⇒ Object

The date when the comment was posted



38
39
40
 
# File 'lib/flat_api/models/score_comment.rb', line 38

def date
  @date
end

#id ⇒ Object

The comment unique identifier



20
21
22
 
# File 'lib/flat_api/models/score_comment.rb', line 20

def id
  @id
end

#mentions ⇒ Object

The list of user identifier mentioned on the score



52
53
54
 
# File 'lib/flat_api/models/score_comment.rb', line 52

def mentions
  @mentions
end

#moderation ⇒ Object

Returns the value of attribute moderation.



60
61
62
 
# File 'lib/flat_api/models/score_comment.rb', line 60

def moderation
  @moderation
end

#modification_date ⇒ Object

The date of the last comment modification



41
42
43
 
# File 'lib/flat_api/models/score_comment.rb', line 41

def modification_date
  @modification_date
end

#raw_comment ⇒ Object

A raw version of the comment, that can be displayed without parsing the mentions.



47
48
49
 
# File 'lib/flat_api/models/score_comment.rb', line 47

def raw_comment
  @raw_comment
end

#reply_to ⇒ Object

When the comment is a reply to another comment, the unique identifier of the parent comment



35
36
37
 
# File 'lib/flat_api/models/score_comment.rb', line 35

def reply_to
  @reply_to
end

#resolved ⇒ Object

For inline comments, the comment can be marked as resolved and will be hidden in the future responses



55
56
57
 
# File 'lib/flat_api/models/score_comment.rb', line 55

def resolved
  @resolved
end

#resolved_by ⇒ Object

If the user is marked as resolved, this will contain the unique identifier of the User who marked this comment as resolved



58
59
60
 
# File 'lib/flat_api/models/score_comment.rb', line 58

def resolved_by
  @resolved_by
end

#revision ⇒ Object

The unique identifier of revision the comment was posted



32
33
34
 
# File 'lib/flat_api/models/score_comment.rb', line 32

def revision
  @revision
end

#score ⇒ Object

The unique identifier of the score where the comment was posted



29
30
31
 
# File 'lib/flat_api/models/score_comment.rb', line 29

def score
  @score
end

#spam ⇒ Object

‘true if the message has been detected as spam and hidden from other users



63
64
65
 
# File 'lib/flat_api/models/score_comment.rb', line 63

def spam
  @spam
end

#type ⇒ Object

The type of the comment



23
24
25
 
# File 'lib/flat_api/models/score_comment.rb', line 23

def type
  @type
end

#user ⇒ Object

The author unique identifier



26
27
28
 
# File 'lib/flat_api/models/score_comment.rb', line 26

def user
  @user
end

Class Method Details

._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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/flat_api/models/score_comment.rb', line 313

def self._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 = FlatApi.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



110
111
112
 
# File 'lib/flat_api/models/score_comment.rb', line 110

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/flat_api/models/score_comment.rb', line 88

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'user' => :'user',
    :'score' => :'score',
    :'revision' => :'revision',
    :'reply_to' => :'replyTo',
    :'date' => :'date',
    :'modification_date' => :'modificationDate',
    :'comment' => :'comment',
    :'raw_comment' => :'rawComment',
    :'context' => :'context',
    :'mentions' => :'mentions',
    :'resolved' => :'resolved',
    :'resolved_by' => :'resolvedBy',
    :'moderation' => :'moderation',
    :'spam' => :'spam'
  }
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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/flat_api/models/score_comment.rb', line 289

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



137
138
139
140
 
# File 'lib/flat_api/models/score_comment.rb', line 137

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

.openapi_types ⇒ Object

Attribute type mapping.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/flat_api/models/score_comment.rb', line 115

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'user' => :'String',
    :'score' => :'String',
    :'revision' => :'String',
    :'reply_to' => :'String',
    :'date' => :'Time',
    :'modification_date' => :'Time',
    :'comment' => :'String',
    :'raw_comment' => :'String',
    :'context' => :'ScoreCommentContext',
    :'mentions' => :'Array<String>',
    :'resolved' => :'Boolean',
    :'resolved_by' => :'String',
    :'moderation' => :'ScoreCommentModeration',
    :'spam' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/flat_api/models/score_comment.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      user == o.user &&
      score == o.score &&
      revision == o.revision &&
      reply_to == o.reply_to &&
      date == o.date &&
      modification_date == o.modification_date &&
      comment == o.comment &&
      raw_comment == o.raw_comment &&
      context == o.context &&
      mentions == o.mentions &&
      resolved == o.resolved &&
      resolved_by == o.resolved_by &&
      moderation == o.moderation &&
      spam == o.spam
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



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/flat_api/models/score_comment.rb', line 384

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


276
277
278
 
# File 'lib/flat_api/models/score_comment.rb', line 276

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



282
283
284
 
# File 'lib/flat_api/models/score_comment.rb', line 282

def hash
  [id, type, user, score, revision, reply_to, date, modification_date, comment, raw_comment, context, mentions, resolved, resolved_by, moderation, spam].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



226
227
228
229
230
 
# File 'lib/flat_api/models/score_comment.rb', line 226

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



360
361
362
 
# File 'lib/flat_api/models/score_comment.rb', line 360

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/flat_api/models/score_comment.rb', line 366

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



354
355
356
 
# File 'lib/flat_api/models/score_comment.rb', line 354

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



234
235
236
237
238
239
 
# File 'lib/flat_api/models/score_comment.rb', line 234

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["document", "inline"])
  return false unless type_validator.valid?(@type)
  true
end