class FlatApi::ScoreComment

Comment added on a sheet music

Attributes

comment[RW]

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

context[RW]
date[RW]

The date when the comment was posted

id[RW]

The comment unique identifier

mentions[RW]

The list of user identifier mentioned on the score

modification_date[RW]

The date of the last comment modification

raw_comment[RW]

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

reply_to[RW]

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

resolved[RW]

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

resolved_by[RW]

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

revision[RW]

The unique identifier of revision the comment was posted

score[RW]

The unique identifier of the score where the comment was posted

spam[RW]

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

type[RW]

The type of the comment

user[RW]

The author unique identifier

Public Class Methods

attribute_map() click to toggle source

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

# File lib/flat_api/models/score_comment.rb, line 85
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',
    :'spam' => :'spam'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/flat_api/models/score_comment.rb, line 128
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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/flat_api/models/score_comment.rb, line 106
def self.swagger_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'user' => :'String',
    :'score' => :'String',
    :'revision' => :'String',
    :'reply_to' => :'String',
    :'date' => :'DateTime',
    :'modification_date' => :'DateTime',
    :'comment' => :'String',
    :'raw_comment' => :'String',
    :'context' => :'ScoreCommentContext',
    :'mentions' => :'Array<String>',
    :'resolved' => :'BOOLEAN',
    :'resolved_by' => :'String',
    :'spam' => :'BOOLEAN'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/flat_api/models/score_comment.rb, line 225
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 &&
      spam == o.spam
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/flat_api/models/score_comment.rb, line 281
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 = FlatApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/flat_api/models/score_comment.rb, line 347
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/flat_api/models/score_comment.rb, line 260
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/flat_api/models/score_comment.rb, line 247
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/flat_api/models/score_comment.rb, line 253
def hash
  [id, type, user, score, revision, reply_to, date, modification_date, comment, raw_comment, context, mentions, resolved, resolved_by, spam].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/flat_api/models/score_comment.rb, line 200
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/flat_api/models/score_comment.rb, line 327
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/flat_api/models/score_comment.rb, line 333
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/flat_api/models/score_comment.rb, line 321
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/flat_api/models/score_comment.rb, line 215
def type=(type)
  validator = EnumAttributeValidator.new('String', ["document", "inline"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
  end
  @type = type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/flat_api/models/score_comment.rb, line 207
def valid?
  type_validator = EnumAttributeValidator.new('String', ["document", "inline"])
  return false unless type_validator.valid?(@type)
  return true
end