class PureCloud::ChatMessage
Attributes
The message body
Type of the message body (v2 chats only)
The interaction id (if available)
The message sender
The message id
Participant
purpose of sender (v2 chats only)
Communication of sender (v2 chats only)
The message recipient
The user information for the sender (if available)
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 55 def self.attribute_map { :'body' => :'body', :'id' => :'id', :'to' => :'to', :'from' => :'from', :'utc' => :'utc', :'chat' => :'chat', :'message' => :'message', :'type' => :'type', :'body_type' => :'bodyType', :'sender_communication_id' => :'senderCommunicationId', :'participant_purpose' => :'participantPurpose', :'user' => :'user' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 118 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?(:'body') self.body = attributes[:'body'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'to') self.to = attributes[:'to'] end if attributes.has_key?(:'from') self.from = attributes[:'from'] end if attributes.has_key?(:'utc') self.utc = attributes[:'utc'] end if attributes.has_key?(:'chat') self.chat = attributes[:'chat'] end if attributes.has_key?(:'message') self.message = attributes[:'message'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'bodyType') self.body_type = attributes[:'bodyType'] end if attributes.has_key?(:'senderCommunicationId') self.sender_communication_id = attributes[:'senderCommunicationId'] end if attributes.has_key?(:'participantPurpose') self.participant_purpose = attributes[:'participantPurpose'] end if attributes.has_key?(:'user') self.user = attributes[:'user'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 86 def self.swagger_types { :'body' => :'String', :'id' => :'String', :'to' => :'String', :'from' => :'String', :'utc' => :'String', :'chat' => :'String', :'message' => :'String', :'type' => :'String', :'body_type' => :'String', :'sender_communication_id' => :'String', :'participant_purpose' => :'String', :'user' => :'ChatMessageUser' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 375 def ==(o) return true if self.equal?(o) self.class == o.class && body == o.body && id == o.id && to == o.to && from == o.from && utc == o.utc && chat == o.chat && message == o.message && type == o.type && body_type == o.body_type && sender_communication_id == o.sender_communication_id && participant_purpose == o.participant_purpose && user == o.user end
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 424 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
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/chat_message.rb, line 484 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
Custom attribute writer method checking allowed values (enum). @param [Object] body_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 347 def body_type=(body_type) allowed_values = ["STANDARD", "ACTIVITY", "TYPING", "NOTICE", "MEMBERJOIN", "MEMBERLEAVE", "MEDIAREQUEST"] if body_type && !allowed_values.include?(body_type) fail ArgumentError, "invalid value for 'body_type', must be one of #{allowed_values}." end @body_type = body_type end
build the object from hash
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 405 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
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 394 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 400 def hash [body, id, to, from, utc, chat, message, type, body_type, sender_communication_id, participant_purpose, user].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 237 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 472 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
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 462 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/chat_message.rb, line 246 def valid? allowed_values = ["STANDARD", "ACTIVITY", "TYPING", "NOTICE", "MEMBERJOIN", "MEMBERLEAVE", "MEDIAREQUEST"] if @body_type && !allowed_values.include?(@body_type) return false end end