class MParticle::MediaInfo

Attributes

action[RW]
channel[RW]
format[RW]
metadata[RW]
playback_position[RW]
playback_rate[RW]
quality[RW]
timed_metadata[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/mparticle/models/media_info.rb, line 45
def self.attribute_map
  {
    :'action' => :'action',
    :'channel' => :'channel',
    :'metadata' => :'metadata',
    :'timed_metadata' => :'timed_metadata',
    :'playback_position' => :'playback_position',
    :'format' => :'format',
    :'quality' => :'quality',
    :'playback_rate' => :'playback_rate'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/mparticle/models/media_info.rb, line 74
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?(:'action')
    self.action = attributes[:'action']
  end

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/mparticle/models/media_info.rb, line 59
def self.swagger_types
  {
    :'action' => :'String',
    :'channel' => :'String',
    :'metadata' => :'String',
    :'timed_metadata' => :'String',
    :'playback_position' => :'Float',
    :'format' => :'String',
    :'quality' => :'String',
    :'playback_rate' => :'Float'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/mparticle/models/media_info.rb, line 165
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      action == o.action &&
      channel == o.channel &&
      metadata == o.metadata &&
      timed_metadata == o.timed_metadata &&
      playback_position == o.playback_position &&
      format == o.format &&
      quality == o.quality &&
      playback_rate == o.playback_rate
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/mparticle/models/media_info.rb, line 214
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) 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/mparticle/models/media_info.rb, line 280
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
action=(action) click to toggle source

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

# File lib/mparticle/models/media_info.rb, line 135
def action=(action)
  validator = EnumAttributeValidator.new('String', ["unknown", "play", "stop", "update_playback_position", "skip", "rate"])
  unless validator.valid?(action)
    fail ArgumentError, "invalid value for 'action', must be one of #{validator.allowable_values}."
  end
  @action = action
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/mparticle/models/media_info.rb, line 193
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/mparticle/models/media_info.rb, line 180
def eql?(o)
  self == o
end
format=(format) click to toggle source

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

# File lib/mparticle/models/media_info.rb, line 145
def format=(format)
  validator = EnumAttributeValidator.new('String', ["unknown", "audio", "video"])
  unless validator.valid?(format)
    fail ArgumentError, "invalid value for 'format', must be one of #{validator.allowable_values}."
  end
  @format = format
end
hash() click to toggle source

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

# File lib/mparticle/models/media_info.rb, line 186
def hash
  [action, channel, metadata, timed_metadata, playback_position, format, quality, playback_rate].hash
end
list_invalid_properties() click to toggle source

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

# File lib/mparticle/models/media_info.rb, line 116
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
quality=(quality) click to toggle source

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

# File lib/mparticle/models/media_info.rb, line 155
def quality=(quality)
  validator = EnumAttributeValidator.new('String', ["unknown", "low", "sd", "medium", "hd", "ultra_hd"])
  unless validator.valid?(quality)
    fail ArgumentError, "invalid value for 'quality', must be one of #{validator.allowable_values}."
  end
  @quality = quality
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/mparticle/models/media_info.rb, line 260
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/mparticle/models/media_info.rb, line 266
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/mparticle/models/media_info.rb, line 254
def to_s
  to_hash.to_s
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/mparticle/models/media_info.rb, line 123
def valid?
  action_validator = EnumAttributeValidator.new('String', ["unknown", "play", "stop", "update_playback_position", "skip", "rate"])
  return false unless action_validator.valid?(@action)
  format_validator = EnumAttributeValidator.new('String', ["unknown", "audio", "video"])
  return false unless format_validator.valid?(@format)
  quality_validator = EnumAttributeValidator.new('String', ["unknown", "low", "sd", "medium", "hd", "ultra_hd"])
  return false unless quality_validator.valid?(@quality)
  return true
end