class PureCloud::MessageDetails

Attributes

media[RW]

The media (images, files, etc) associated with this message, if any

message_id[RW]

UUID identifying the message media.

message_segment_count[RW]

The message segment count, greater than 1 if the message content was split into multiple parts for this message type, e.g. SMS character limits.

message_status[RW]

Indicates the delivery status of the message.

message_time[RW]

The time when the message was sent or received. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

message_uri[RW]

A URI for this message entity.

stickers[RW]

One or more stickers associated with this message, if any

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/message_details.rb, line 43
def self.attribute_map
  {
    
    :'message_id' => :'messageId',
    
    :'message_uri' => :'messageURI',
    
    :'message_status' => :'messageStatus',
    
    :'message_segment_count' => :'messageSegmentCount',
    
    :'message_time' => :'messageTime',
    
    :'media' => :'media',
    
    :'stickers' => :'stickers'
    
  }
end
new(attributes = {}) click to toggle source

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

# File lib/purecloudplatformclientv2/models/message_details.rb, line 86
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?(:'messageId')
    
    
    self.message_id = attributes[:'messageId']
    
  
  end

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/message_details.rb, line 64
def self.swagger_types
  {
    
    :'message_id' => :'String',
    
    :'message_uri' => :'String',
    
    :'message_status' => :'String',
    
    :'message_segment_count' => :'Integer',
    
    :'message_time' => :'DateTime',
    
    :'media' => :'Array<MessageMedia>',
    
    :'stickers' => :'Array<MessageSticker>'
    
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/message_details.rb, line 257
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      message_id == o.message_id &&
      message_uri == o.message_uri &&
      message_status == o.message_status &&
      message_segment_count == o.message_segment_count &&
      message_time == o.message_time &&
      media == o.media &&
      stickers == o.stickers
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/message_details.rb, line 301
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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloudplatformclientv2/models/message_details.rb, line 361
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

build the object from hash

# File lib/purecloudplatformclientv2/models/message_details.rb, line 282
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end
eql?(o) click to toggle source

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

# File lib/purecloudplatformclientv2/models/message_details.rb, line 271
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/purecloudplatformclientv2/models/message_details.rb, line 277
def hash
  [message_id, message_uri, message_status, message_segment_count, message_time, media, stickers].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/purecloudplatformclientv2/models/message_details.rb, line 164
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
message_status=(message_status) click to toggle source

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

# File lib/purecloudplatformclientv2/models/message_details.rb, line 224
def message_status=(message_status)
  allowed_values = ["queued", "sent", "failed", "received", "delivery-success", "delivery-failed", "read"]
  if message_status && !allowed_values.include?(message_status)
    fail ArgumentError, "invalid value for 'message_status', must be one of #{allowed_values}."
  end
  @message_status = message_status
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/message_details.rb, line 344
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/message_details.rb, line 349
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
# File lib/purecloudplatformclientv2/models/message_details.rb, line 339
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/purecloudplatformclientv2/models/message_details.rb, line 173
def valid?
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["queued", "sent", "failed", "received", "delivery-success", "delivery-failed", "read"]
  if @message_status && !allowed_values.include?(@message_status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end