class FlatApi::MediaAttachment

Media attachment. The API will automatically resolve the details, oEmbed, and media available if possible and return them in this object

Attributes

author_name[RW]

The resolved author name of the attachment

author_url[RW]

The resolved author url of the attachment

correct[RW]

If the attachment is an exercise question, this state will describe if it is correct or not.For exercise assignments only.

description[RW]

The resolved description of the attachment

html[RW]

If the attachment type is `rich` or `video`, the HTML code of the media to display

html_height[RW]

If the `html` is available, the height of the widget

html_width[RW]

If the `html` is available, the width of the widget

revision[RW]

An unique revision identifier of a score

score[RW]

An unique Flat score identifier

sharing_mode[RW]
thumbnail_height[RW]

If the `thumbnailUrl` is available, the width of the thumbnail

thumbnail_url[RW]

If the attachment type is `rich`, `video`, `photo` or `link`, a displayable thumbnail for this attachment

thumbnail_width[RW]

If the `thumbnailUrl` is available, the width of the thumbnail

title[RW]

The resolved title of the attachment

type[RW]

The type of the assignment resolved: * `rich`, `photo`, `video` are attachment types that are automatically resolved from a `link` attachment. * A `flat` attachment is a score document where the unique identifier will be specified in the `score` property. Its sharing mode will be provided in the `sharingMode` property.

url[RW]

The url of the attachment

Public Class Methods

attribute_map() click to toggle source

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

# File lib/flat_api/models/media_attachment.rb, line 88
def self.attribute_map
  {
    :'type' => :'type',
    :'score' => :'score',
    :'revision' => :'revision',
    :'correct' => :'correct',
    :'sharing_mode' => :'sharingMode',
    :'title' => :'title',
    :'description' => :'description',
    :'html' => :'html',
    :'html_width' => :'htmlWidth',
    :'html_height' => :'htmlHeight',
    :'url' => :'url',
    :'thumbnail_url' => :'thumbnailUrl',
    :'thumbnail_width' => :'thumbnailWidth',
    :'thumbnail_height' => :'thumbnailHeight',
    :'author_name' => :'authorName',
    :'author_url' => :'authorUrl'
  }
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/media_attachment.rb, line 133
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?(:'type')
    self.type = attributes[:'type']
  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?(:'correct')
    self.correct = attributes[:'correct']
  end

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

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

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/flat_api/models/media_attachment.rb, line 110
def self.swagger_types
  {
    :'type' => :'String',
    :'score' => :'String',
    :'revision' => :'String',
    :'correct' => :'BOOLEAN',
    :'sharing_mode' => :'MediaScoreSharingMode',
    :'title' => :'String',
    :'description' => :'String',
    :'html' => :'String',
    :'html_width' => :'String',
    :'html_height' => :'String',
    :'url' => :'String',
    :'thumbnail_url' => :'String',
    :'thumbnail_width' => :'String',
    :'thumbnail_height' => :'String',
    :'author_name' => :'String',
    :'author_url' => :'String'
  }
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/media_attachment.rb, line 232
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      score == o.score &&
      revision == o.revision &&
      correct == o.correct &&
      sharing_mode == o.sharing_mode &&
      title == o.title &&
      description == o.description &&
      html == o.html &&
      html_width == o.html_width &&
      html_height == o.html_height &&
      url == o.url &&
      thumbnail_url == o.thumbnail_url &&
      thumbnail_width == o.thumbnail_width &&
      thumbnail_height == o.thumbnail_height &&
      author_name == o.author_name &&
      author_url == o.author_url
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/media_attachment.rb, line 289
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/media_attachment.rb, line 355
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/media_attachment.rb, line 268
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/media_attachment.rb, line 255
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/media_attachment.rb, line 261
def hash
  [type, score, revision, correct, sharing_mode, title, description, html, html_width, html_height, url, thumbnail_url, thumbnail_width, thumbnail_height, author_name, author_url].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/media_attachment.rb, line 207
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/media_attachment.rb, line 335
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/media_attachment.rb, line 341
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/media_attachment.rb, line 329
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/media_attachment.rb, line 222
def type=(type)
  validator = EnumAttributeValidator.new('String', ["rich", "photo", "video", "link", "flat", "exercise"])
  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/media_attachment.rb, line 214
def valid?
  type_validator = EnumAttributeValidator.new('String', ["rich", "photo", "video", "link", "flat", "exercise"])
  return false unless type_validator.valid?(@type)
  return true
end