class PureCloud::Conversation
Attributes
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.
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.
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
The globally unique identifier for the object.
If this is a conference conversation, then this field indicates the maximum number of participants allowed to participant in the conference.
The list of all participants in the conversation.
On update, 'paused' initiates a secure pause, 'active' resumes any paused recordings; otherwise indicates state of conversation recording.
The URI for this object
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
The conversation's state. Values can be: 'disconnected'
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/conversation.rb, line 54 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', :'self_uri' => :'selfUri' } end
# File lib/purecloud/models/conversation.rb, line 100 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo} if attributes[:'id'] self.id = attributes[:'id'] end if attributes[:'name'] self.name = attributes[:'name'] end if attributes[:'startTime'] self.start_time = attributes[:'startTime'] end if attributes[:'endTime'] self.end_time = attributes[:'endTime'] end if attributes[:'address'] self.address = attributes[:'address'] end if attributes[:'participants'] if (value = attributes[:'participants']).is_a?(Array) self.participants = value end end if attributes[:'conversationIds'] if (value = attributes[:'conversationIds']).is_a?(Array) self.conversation_ids = value end end if attributes[:'maxParticipants'] self.max_participants = attributes[:'maxParticipants'] end if attributes[:'recordingState'] self.recording_state = attributes[:'recordingState'] end if attributes[:'state'] self.state = attributes[:'state'] end if attributes[:'selfUri'] self.self_uri = attributes[:'selfUri'] end end
Attribute
type mapping.
# File lib/purecloud/models/conversation.rb, line 83 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', :'self_uri' => :'String' } end
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/conversation.rb, line 176 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 && self_uri == o.self_uri end
# File lib/purecloud/models/conversation.rb, line 222 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/purecloud/models/conversation.rb, line 282 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 the object from hash
# File lib/purecloud/models/conversation.rb, line 203 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
# File lib/purecloud/models/conversation.rb, line 193 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/conversation.rb, line 198 def hash [id, name, start_time, end_time, address, participants, conversation_ids, max_participants, recording_state, state, self_uri].hash end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/conversation.rb, line 158 def recording_state=(recording_state) allowed_values = ["ACTIVE", "PAUSED", "NONE"] if recording_state && !allowed_values.include?(recording_state) fail "invalid value for 'recording_state', must be one of #{allowed_values}" end @recording_state = recording_state end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/conversation.rb, line 167 def state=(state) allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "none"] if state && !allowed_values.include?(state) fail "invalid value for 'state', must be one of #{allowed_values}" end @state = state end
return the object in the form of hash
# File lib/purecloud/models/conversation.rb, line 270 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/purecloud/models/conversation.rb, line 260 def to_s to_hash.to_s end