class PureCloud::RecordingMessagingMessage

Attributes

from[RW]
from_external_contact[RW]
from_user[RW]
id[RW]
message_media_attachments[RW]
message_sticker_attachments[RW]
message_text[RW]
timestamp[RW]

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

to[RW]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/recording_messaging_message.rb, line 41
def self.attribute_map
  {
    
    :'from' => :'from',
    
    :'from_user' => :'fromUser',
    
    :'from_external_contact' => :'fromExternalContact',
    
    :'to' => :'to',
    
    :'timestamp' => :'timestamp',
    
    :'id' => :'id',
    
    :'message_text' => :'messageText',
    
    :'message_media_attachments' => :'messageMediaAttachments',
    
    :'message_sticker_attachments' => :'messageStickerAttachments'
    
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/recording_messaging_message.rb, line 66
def self.swagger_types
  {
    
    :'from' => :'String',
    
    :'from_user' => :'User',
    
    :'from_external_contact' => :'ExternalContact',
    
    :'to' => :'String',
    
    :'timestamp' => :'DateTime',
    
    :'id' => :'String',
    
    :'message_text' => :'String',
    
    :'message_media_attachments' => :'Array<MessageMediaAttachment>',
    
    :'message_sticker_attachments' => :'Array<MessageStickerAttachment>'
    
  }
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/recording_messaging_message.rb, line 285
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      from == o.from &&
      from_user == o.from_user &&
      from_external_contact == o.from_external_contact &&
      to == o.to &&
      timestamp == o.timestamp &&
      id == o.id &&
      message_text == o.message_text &&
      message_media_attachments == o.message_media_attachments &&
      message_sticker_attachments == o.message_sticker_attachments
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/recording_messaging_message.rb, line 331
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/recording_messaging_message.rb, line 391
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/recording_messaging_message.rb, line 312
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/recording_messaging_message.rb, line 301
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/recording_messaging_message.rb, line 307
def hash
  [from, from_user, from_external_contact, to, timestamp, id, message_text, message_media_attachments, message_sticker_attachments].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/recording_messaging_message.rb, line 188
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_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/recording_messaging_message.rb, line 379
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/recording_messaging_message.rb, line 369
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/recording_messaging_message.rb, line 197
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end