class PureCloud::Conversation

Attributes

address[RW]

The address of the conversation as seen from an external participant. For phone calls this will be the DNIS for inbound calls and the ANI for outbound calls. For other media types this will be the address of the destination participant for inbound and the address of the initiating participant for outbound.

conversation_ids[RW]

A list of conversations to merge into this conversation to create a conference. This field is null except when being used to create a conference.

divisions[RW]

Identifiers of divisions associated with this conversation

end_time[RW]

The time when the conversation ended. This will be the time when the last participant left the conversation, or null when the conversation is still active. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

id[RW]

The globally unique identifier for the object.

max_participants[RW]

If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference.

name[RW]
participants[RW]

The list of all participants in the conversation.

recording_state[RW]

On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.

self_uri[RW]

The URI for this object

start_time[RW]

The time when the conversation started. This will be the time when the first participant joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

state[RW]

The conversation's state

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/conversation.rb, line 57
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'start_time' => :'startTime',
    
    :'end_time' => :'endTime',
    
    :'address' => :'address',
    
    :'participants' => :'participants',
    
    :'conversation_ids' => :'conversationIds',
    
    :'max_participants' => :'maxParticipants',
    
    :'recording_state' => :'recordingState',
    
    :'state' => :'state',
    
    :'divisions' => :'divisions',
    
    :'self_uri' => :'selfUri'
    
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/conversation.rb, line 88
def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'start_time' => :'DateTime',
    
    :'end_time' => :'DateTime',
    
    :'address' => :'String',
    
    :'participants' => :'Array<Participant>',
    
    :'conversation_ids' => :'Array<String>',
    
    :'max_participants' => :'Integer',
    
    :'recording_state' => :'String',
    
    :'state' => :'String',
    
    :'divisions' => :'Array<ConversationDivisionMembership>',
    
    :'self_uri' => :'String'
    
  }
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/conversation.rb, line 407
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      address == o.address &&
      participants == o.participants &&
      conversation_ids == o.conversation_ids &&
      max_participants == o.max_participants &&
      recording_state == o.recording_state &&
      state == o.state &&
      divisions == o.divisions &&
      self_uri == o.self_uri
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/conversation.rb, line 456
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/conversation.rb, line 516
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/conversation.rb, line 437
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/conversation.rb, line 426
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/conversation.rb, line 432
def hash
  [id, name, start_time, end_time, address, participants, conversation_ids, max_participants, recording_state, state, divisions, self_uri].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/conversation.rb, line 245
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
recording_state=(recording_state) click to toggle source

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

# File lib/purecloudplatformclientv2/models/conversation.rb, line 370
def recording_state=(recording_state)
  allowed_values = ["ACTIVE", "PAUSED", "NONE"]
  if recording_state && !allowed_values.include?(recording_state)
    fail ArgumentError, "invalid value for 'recording_state', must be one of #{allowed_values}."
  end
  @recording_state = recording_state
end
state=(state) click to toggle source

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

# File lib/purecloudplatformclientv2/models/conversation.rb, line 384
def state=(state)
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "none"]
  if state && !allowed_values.include?(state)
    fail ArgumentError, "invalid value for 'state', must be one of #{allowed_values}."
  end
  @state = state
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

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

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/conversation.rb, line 504
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/conversation.rb, line 494
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/conversation.rb, line 254
def valid?
  
  
  
  
  
  
  
  
  
  
  if @start_time.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  if @participants.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["ACTIVE", "PAUSED", "NONE"]
  if @recording_state && !allowed_values.include?(@recording_state)
    return false
  end
  
  
  
  
  
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "none"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end