class PureCloud::Call
Attributes
True if this call is held and the person on this side hears hold music.
The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The direction of the call
List of reasons that this call was disconnected. This will be set once the call disconnects.
System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
If call is an outbound fax of a document from content management, then this is the id in content management.
Extra information on fax transmission.
True if this call is held and the person on this side hears silence.
A globally unique identifier for this communication.
True if this call is muted so that remote participants can't hear any audio from this end.
The source provider for the call.
True if this call is being recorded.
A globally unique identifier for the recording associated with this call.
State of recording on this call.
The time line of the participant's call, divided into activity segments.
The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The connection state of this communication.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/call.rb, line 78 def self.attribute_map { :'state' => :'state', :'id' => :'id', :'direction' => :'direction', :'recording' => :'recording', :'recording_state' => :'recordingState', :'muted' => :'muted', :'confined' => :'confined', :'held' => :'held', :'recording_id' => :'recordingId', :'segments' => :'segments', :'error_info' => :'errorInfo', :'disconnect_type' => :'disconnectType', :'start_hold_time' => :'startHoldTime', :'document_id' => :'documentId', :'connected_time' => :'connectedTime', :'disconnected_time' => :'disconnectedTime', :'disconnect_reasons' => :'disconnectReasons', :'fax_status' => :'faxStatus', :'provider' => :'provider' } end
# File lib/purecloud/models/call.rb, line 148 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[:'state'] self.state = attributes[:'state'] end if attributes[:'id'] self.id = attributes[:'id'] end if attributes[:'direction'] self.direction = attributes[:'direction'] end if attributes[:'recording'] self.recording = attributes[:'recording'] end if attributes[:'recordingState'] self.recording_state = attributes[:'recordingState'] end if attributes[:'muted'] self.muted = attributes[:'muted'] end if attributes[:'confined'] self.confined = attributes[:'confined'] end if attributes[:'held'] self.held = attributes[:'held'] end if attributes[:'recordingId'] self.recording_id = attributes[:'recordingId'] end if attributes[:'segments'] if (value = attributes[:'segments']).is_a?(Array) self.segments = value end end if attributes[:'errorInfo'] self.error_info = attributes[:'errorInfo'] end if attributes[:'disconnectType'] self.disconnect_type = attributes[:'disconnectType'] end if attributes[:'startHoldTime'] self.start_hold_time = attributes[:'startHoldTime'] end if attributes[:'documentId'] self.document_id = attributes[:'documentId'] end if attributes[:'connectedTime'] self.connected_time = attributes[:'connectedTime'] end if attributes[:'disconnectedTime'] self.disconnected_time = attributes[:'disconnectedTime'] end if attributes[:'disconnectReasons'] if (value = attributes[:'disconnectReasons']).is_a?(Array) self.disconnect_reasons = value end end if attributes[:'faxStatus'] self.fax_status = attributes[:'faxStatus'] end if attributes[:'provider'] self.provider = attributes[:'provider'] end end
Attribute
type mapping.
# File lib/purecloud/models/call.rb, line 123 def self.swagger_types { :'state' => :'String', :'id' => :'String', :'direction' => :'String', :'recording' => :'BOOLEAN', :'recording_state' => :'String', :'muted' => :'BOOLEAN', :'confined' => :'BOOLEAN', :'held' => :'BOOLEAN', :'recording_id' => :'String', :'segments' => :'Array<Segment>', :'error_info' => :'ErrorBody', :'disconnect_type' => :'String', :'start_hold_time' => :'DateTime', :'document_id' => :'String', :'connected_time' => :'DateTime', :'disconnected_time' => :'DateTime', :'disconnect_reasons' => :'Array<DisconnectReason>', :'fax_status' => :'FaxStatus', :'provider' => :'String' } end
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/call.rb, line 274 def ==(o) return true if self.equal?(o) self.class == o.class && state == o.state && id == o.id && direction == o.direction && recording == o.recording && recording_state == o.recording_state && muted == o.muted && confined == o.confined && held == o.held && recording_id == o.recording_id && segments == o.segments && error_info == o.error_info && disconnect_type == o.disconnect_type && start_hold_time == o.start_hold_time && document_id == o.document_id && connected_time == o.connected_time && disconnected_time == o.disconnected_time && disconnect_reasons == o.disconnect_reasons && fax_status == o.fax_status && provider == o.provider end
# File lib/purecloud/models/call.rb, line 328 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/call.rb, line 388 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/call.rb, line 309 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
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/call.rb, line 247 def direction=(direction) allowed_values = ["inbound", "outbound"] if direction && !allowed_values.include?(direction) fail "invalid value for 'direction', must be one of #{allowed_values}" end @direction = direction end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/call.rb, line 265 def disconnect_type=(disconnect_type) allowed_values = ["endpoint", "client", "system", "timeout", "transfer", "transfer.conference", "transfer.consult", "transfer.forward", "transfer.noanswer", "transfer.notavailable", "transport.failure", "error", "peer", "other", "spam", "uncallable"] if disconnect_type && !allowed_values.include?(disconnect_type) fail "invalid value for 'disconnect_type', must be one of #{allowed_values}" end @disconnect_type = disconnect_type end
@see the `==` method
# File lib/purecloud/models/call.rb, line 299 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/call.rb, line 304 def hash [state, id, direction, recording, recording_state, muted, confined, held, recording_id, segments, error_info, disconnect_type, start_hold_time, document_id, connected_time, disconnected_time, disconnect_reasons, fax_status, provider].hash end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/call.rb, line 256 def recording_state=(recording_state) allowed_values = ["none", "active", "paused"] 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/call.rb, line 238 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/call.rb, line 376 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/call.rb, line 366 def to_s to_hash.to_s end