class PureCloud::CobrowseMediaParticipant
Attributes
The participant address.
Specifies how long the agent has to answer an interaction before being marked as not responding.
A list of ad-hoc attributes for the participant.
This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer).
The co-browse session ID.
The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).
Information on how a communication should be routed to an agent.
The participant's direction. Values can be: 'inbound' or 'outbound'
The reason the participant was disconnected from the conversation.
The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
If the conversation ends in error, contains additional error details.
If this participant represents an external contact, then this will be the reference for the external contact.
If this participant represents an external org, then this will be the reference for the external org.
The reason specifying why participant flagged the conversation.
Value is true when the participant is on hold.
The unique participant ID.
Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context.
The display friendly name of the participant.
The peer communication corresponding to a matching leg for this communication.
The source provider for the communication.
The time when the provider event which triggered this conversation update happened in the corrected provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr
The PureCloud
queue for this participant.
The Engage script that should be used by this participant.
The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting
The PureCloud
team for this participant.
The PureCloud
user for this participant.
The URL that can be used to open co-browse session in web browser.
Wrapup
for this participant, if it has been applied.
The wrap-up prompt indicating the type of wrap-up to be performed.
Value is true when the participant requires wrap-up.
Value is true when the participant has skipped wrap-up.
The amount of time the participant has to complete wrap-up.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 136 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'address' => :'address', :'start_time' => :'startTime', :'connected_time' => :'connectedTime', :'end_time' => :'endTime', :'start_hold_time' => :'startHoldTime', :'purpose' => :'purpose', :'state' => :'state', :'direction' => :'direction', :'disconnect_type' => :'disconnectType', :'held' => :'held', :'wrapup_required' => :'wrapupRequired', :'wrapup_prompt' => :'wrapupPrompt', :'user' => :'user', :'queue' => :'queue', :'team' => :'team', :'attributes' => :'attributes', :'error_info' => :'errorInfo', :'script' => :'script', :'wrapup_timeout_ms' => :'wrapupTimeoutMs', :'wrapup_skipped' => :'wrapupSkipped', :'alerting_timeout_ms' => :'alertingTimeoutMs', :'provider' => :'provider', :'external_contact' => :'externalContact', :'external_organization' => :'externalOrganization', :'wrapup' => :'wrapup', :'peer' => :'peer', :'flagged_reason' => :'flaggedReason', :'journey_context' => :'journeyContext', :'conversation_routing_data' => :'conversationRoutingData', :'start_acw_time' => :'startAcwTime', :'end_acw_time' => :'endAcwTime', :'cobrowse_session_id' => :'cobrowseSessionId', :'cobrowse_role' => :'cobrowseRole', :'controlling' => :'controlling', :'viewer_url' => :'viewerUrl', :'provider_event_time' => :'providerEventTime' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 303 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?(:'address') self.address = attributes[:'address'] end if attributes.has_key?(:'startTime') self.start_time = attributes[:'startTime'] end if attributes.has_key?(:'connectedTime') self.connected_time = attributes[:'connectedTime'] end if attributes.has_key?(:'endTime') self.end_time = attributes[:'endTime'] end if attributes.has_key?(:'startHoldTime') self.start_hold_time = attributes[:'startHoldTime'] end if attributes.has_key?(:'purpose') self.purpose = attributes[:'purpose'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'direction') self.direction = attributes[:'direction'] end if attributes.has_key?(:'disconnectType') self.disconnect_type = attributes[:'disconnectType'] end if attributes.has_key?(:'held') self.held = attributes[:'held'] end if attributes.has_key?(:'wrapupRequired') self.wrapup_required = attributes[:'wrapupRequired'] end if attributes.has_key?(:'wrapupPrompt') self.wrapup_prompt = attributes[:'wrapupPrompt'] end if attributes.has_key?(:'user') self.user = attributes[:'user'] end if attributes.has_key?(:'queue') self.queue = attributes[:'queue'] end if attributes.has_key?(:'team') self.team = attributes[:'team'] end if attributes.has_key?(:'attributes') if (value = attributes[:'attributes']).is_a?(Array) self.attributes = value end end if attributes.has_key?(:'errorInfo') self.error_info = attributes[:'errorInfo'] end if attributes.has_key?(:'script') self.script = attributes[:'script'] end if attributes.has_key?(:'wrapupTimeoutMs') self.wrapup_timeout_ms = attributes[:'wrapupTimeoutMs'] end if attributes.has_key?(:'wrapupSkipped') self.wrapup_skipped = attributes[:'wrapupSkipped'] end if attributes.has_key?(:'alertingTimeoutMs') self.alerting_timeout_ms = attributes[:'alertingTimeoutMs'] end if attributes.has_key?(:'provider') self.provider = attributes[:'provider'] end if attributes.has_key?(:'externalContact') self.external_contact = attributes[:'externalContact'] end if attributes.has_key?(:'externalOrganization') self.external_organization = attributes[:'externalOrganization'] end if attributes.has_key?(:'wrapup') self.wrapup = attributes[:'wrapup'] end if attributes.has_key?(:'peer') self.peer = attributes[:'peer'] end if attributes.has_key?(:'flaggedReason') self.flagged_reason = attributes[:'flaggedReason'] end if attributes.has_key?(:'journeyContext') self.journey_context = attributes[:'journeyContext'] end if attributes.has_key?(:'conversationRoutingData') self.conversation_routing_data = attributes[:'conversationRoutingData'] end if attributes.has_key?(:'startAcwTime') self.start_acw_time = attributes[:'startAcwTime'] end if attributes.has_key?(:'endAcwTime') self.end_acw_time = attributes[:'endAcwTime'] end if attributes.has_key?(:'cobrowseSessionId') self.cobrowse_session_id = attributes[:'cobrowseSessionId'] end if attributes.has_key?(:'cobrowseRole') self.cobrowse_role = attributes[:'cobrowseRole'] end if attributes.has_key?(:'controlling') if (value = attributes[:'controlling']).is_a?(Array) self.controlling = value end end if attributes.has_key?(:'viewerUrl') self.viewer_url = attributes[:'viewerUrl'] end if attributes.has_key?(:'providerEventTime') self.provider_event_time = attributes[:'providerEventTime'] end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 219 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'address' => :'String', :'start_time' => :'DateTime', :'connected_time' => :'DateTime', :'end_time' => :'DateTime', :'start_hold_time' => :'DateTime', :'purpose' => :'String', :'state' => :'String', :'direction' => :'String', :'disconnect_type' => :'String', :'held' => :'BOOLEAN', :'wrapup_required' => :'BOOLEAN', :'wrapup_prompt' => :'String', :'user' => :'DomainEntityRef', :'queue' => :'DomainEntityRef', :'team' => :'DomainEntityRef', :'attributes' => :'Hash<String, String>', :'error_info' => :'ErrorInfo', :'script' => :'DomainEntityRef', :'wrapup_timeout_ms' => :'Integer', :'wrapup_skipped' => :'BOOLEAN', :'alerting_timeout_ms' => :'Integer', :'provider' => :'String', :'external_contact' => :'DomainEntityRef', :'external_organization' => :'DomainEntityRef', :'wrapup' => :'Wrapup', :'peer' => :'String', :'flagged_reason' => :'String', :'journey_context' => :'JourneyContext', :'conversation_routing_data' => :'ConversationRoutingData', :'start_acw_time' => :'DateTime', :'end_acw_time' => :'DateTime', :'cobrowse_session_id' => :'String', :'cobrowse_role' => :'String', :'controlling' => :'Array<String>', :'viewer_url' => :'String', :'provider_event_time' => :'DateTime' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 1074 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && address == o.address && start_time == o.start_time && connected_time == o.connected_time && end_time == o.end_time && start_hold_time == o.start_hold_time && purpose == o.purpose && state == o.state && direction == o.direction && disconnect_type == o.disconnect_type && held == o.held && wrapup_required == o.wrapup_required && wrapup_prompt == o.wrapup_prompt && user == o.user && queue == o.queue && team == o.team && attributes == o.attributes && error_info == o.error_info && script == o.script && wrapup_timeout_ms == o.wrapup_timeout_ms && wrapup_skipped == o.wrapup_skipped && alerting_timeout_ms == o.alerting_timeout_ms && provider == o.provider && external_contact == o.external_contact && external_organization == o.external_organization && wrapup == o.wrapup && peer == o.peer && flagged_reason == o.flagged_reason && journey_context == o.journey_context && conversation_routing_data == o.conversation_routing_data && start_acw_time == o.start_acw_time && end_acw_time == o.end_acw_time && cobrowse_session_id == o.cobrowse_session_id && cobrowse_role == o.cobrowse_role && controlling == o.controlling && viewer_url == o.viewer_url && provider_event_time == o.provider_event_time end
# File lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 1149 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/cobrowse_media_participant.rb, line 1209 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/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 1130 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). @param [Object] direction Object to be assigned
# File lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 903 def direction=(direction) allowed_values = ["inbound", "outbound"] if direction && !allowed_values.include?(direction) fail ArgumentError, "invalid value for 'direction', must be one of #{allowed_values}." end @direction = direction end
Custom attribute writer method checking allowed values (enum). @param [Object] disconnect_type
Object to be assigned
# File lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 917 def disconnect_type=(disconnect_type) allowed_values = ["endpoint", "client", "system", "transfer", "transfer.conference", "transfer.consult", "transfer.forward", "transfer.noanswer", "transfer.notavailable", "transport.failure", "error", "peer", "other", "spam"] if disconnect_type && !allowed_values.include?(disconnect_type) fail ArgumentError, "invalid value for 'disconnect_type', must be one of #{allowed_values}." end @disconnect_type = disconnect_type end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 1119 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] flagged_reason
Object to be assigned
# File lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 1016 def flagged_reason=(flagged_reason) allowed_values = ["general"] if flagged_reason && !allowed_values.include?(flagged_reason) fail ArgumentError, "invalid value for 'flagged_reason', must be one of #{allowed_values}." end @flagged_reason = flagged_reason end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 1125 def hash [id, name, address, start_time, connected_time, end_time, start_hold_time, purpose, state, direction, disconnect_type, held, wrapup_required, wrapup_prompt, user, queue, team, attributes, error_info, script, wrapup_timeout_ms, wrapup_skipped, alerting_timeout_ms, provider, external_contact, external_organization, wrapup, peer, flagged_reason, journey_context, conversation_routing_data, start_acw_time, end_acw_time, cobrowse_session_id, cobrowse_role, controlling, viewer_url, provider_event_time].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/cobrowse_media_participant.rb, line 660 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] state Object to be assigned
# File lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 889 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
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb, line 1197 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/cobrowse_media_participant.rb, line 1187 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/cobrowse_media_participant.rb, line 669 def valid? allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "none"] if @state && !allowed_values.include?(@state) return false end allowed_values = ["inbound", "outbound"] if @direction && !allowed_values.include?(@direction) return false end allowed_values = ["endpoint", "client", "system", "transfer", "transfer.conference", "transfer.consult", "transfer.forward", "transfer.noanswer", "transfer.notavailable", "transport.failure", "error", "peer", "other", "spam"] if @disconnect_type && !allowed_values.include?(@disconnect_type) return false end allowed_values = ["general"] if @flagged_reason && !allowed_values.include?(@flagged_reason) return false end end