class PureCloud::CobrowseMediaParticipant
Attributes
The participant address.
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).
The participant's direction. Values can be: 'inbound' or 'outbound'
The reason the participant was disconnected from the conversation.
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.
Value is true when the participant is on hold.
The unique participant ID.
The display friendly name of the participant.
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 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
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/purecloud/models/cobrowse_media_participant.rb, line 112 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', :'attributes' => :'attributes', :'error_info' => :'errorInfo', :'script' => :'script', :'wrapup_timeout_ms' => :'wrapupTimeoutMs', :'wrapup_skipped' => :'wrapupSkipped', :'provider' => :'provider', :'external_contact' => :'externalContact', :'external_organization' => :'externalOrganization', :'wrapup' => :'wrapup', :'cobrowse_session_id' => :'cobrowseSessionId', :'cobrowse_role' => :'cobrowseRole', :'controlling' => :'controlling', :'viewer_url' => :'viewerUrl', :'provider_event_time' => :'providerEventTime' } end
# File lib/purecloud/models/cobrowse_media_participant.rb, line 215 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[:'address'] self.address = attributes[:'address'] end if attributes[:'startTime'] self.start_time = attributes[:'startTime'] end if attributes[:'connectedTime'] self.connected_time = attributes[:'connectedTime'] end if attributes[:'endTime'] self.end_time = attributes[:'endTime'] end if attributes[:'startHoldTime'] self.start_hold_time = attributes[:'startHoldTime'] end if attributes[:'purpose'] self.purpose = attributes[:'purpose'] end if attributes[:'state'] self.state = attributes[:'state'] end if attributes[:'direction'] self.direction = attributes[:'direction'] end if attributes[:'disconnectType'] self.disconnect_type = attributes[:'disconnectType'] end if attributes[:'held'] self.held = attributes[:'held'] end if attributes[:'wrapupRequired'] self.wrapup_required = attributes[:'wrapupRequired'] end if attributes[:'wrapupPrompt'] self.wrapup_prompt = attributes[:'wrapupPrompt'] end if attributes[:'user'] self.user = attributes[:'user'] end if attributes[:'queue'] self.queue = attributes[:'queue'] end if attributes[:'attributes'] if (value = attributes[:'attributes']).is_a?(Array) self.attributes = value end end if attributes[:'errorInfo'] self.error_info = attributes[:'errorInfo'] end if attributes[:'script'] self.script = attributes[:'script'] end if attributes[:'wrapupTimeoutMs'] self.wrapup_timeout_ms = attributes[:'wrapupTimeoutMs'] end if attributes[:'wrapupSkipped'] self.wrapup_skipped = attributes[:'wrapupSkipped'] end if attributes[:'provider'] self.provider = attributes[:'provider'] end if attributes[:'externalContact'] self.external_contact = attributes[:'externalContact'] end if attributes[:'externalOrganization'] self.external_organization = attributes[:'externalOrganization'] end if attributes[:'wrapup'] self.wrapup = attributes[:'wrapup'] end if attributes[:'cobrowseSessionId'] self.cobrowse_session_id = attributes[:'cobrowseSessionId'] end if attributes[:'cobrowseRole'] self.cobrowse_role = attributes[:'cobrowseRole'] end if attributes[:'controlling'] if (value = attributes[:'controlling']).is_a?(Array) self.controlling = value end end if attributes[:'viewerUrl'] self.viewer_url = attributes[:'viewerUrl'] end if attributes[:'providerEventTime'] self.provider_event_time = attributes[:'providerEventTime'] end end
Attribute
type mapping.
# File lib/purecloud/models/cobrowse_media_participant.rb, line 179 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' => :'UriReference', :'queue' => :'UriReference', :'attributes' => :'Hash<String, String>', :'error_info' => :'ErrorBody', :'script' => :'UriReference', :'wrapup_timeout_ms' => :'Integer', :'wrapup_skipped' => :'BOOLEAN', :'provider' => :'String', :'external_contact' => :'UriReference', :'external_organization' => :'UriReference', :'wrapup' => :'Wrapup', :'cobrowse_session_id' => :'String', :'cobrowse_role' => :'String', :'controlling' => :'Array<String>', :'viewer_url' => :'String', :'provider_event_time' => :'DateTime' } end
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/cobrowse_media_participant.rb, line 376 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 && attributes == o.attributes && error_info == o.error_info && script == o.script && wrapup_timeout_ms == o.wrapup_timeout_ms && wrapup_skipped == o.wrapup_skipped && provider == o.provider && external_contact == o.external_contact && external_organization == o.external_organization && wrapup == o.wrapup && 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/purecloud/models/cobrowse_media_participant.rb, line 441 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/cobrowse_media_participant.rb, line 501 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/cobrowse_media_participant.rb, line 422 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/cobrowse_media_participant.rb, line 358 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/cobrowse_media_participant.rb, line 367 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 "invalid value for 'disconnect_type', must be one of #{allowed_values}" end @disconnect_type = disconnect_type end
@see the `==` method
# File lib/purecloud/models/cobrowse_media_participant.rb, line 412 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/cobrowse_media_participant.rb, line 417 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, attributes, error_info, script, wrapup_timeout_ms, wrapup_skipped, provider, external_contact, external_organization, wrapup, cobrowse_session_id, cobrowse_role, controlling, viewer_url, provider_event_time].hash end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/cobrowse_media_participant.rb, line 349 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/cobrowse_media_participant.rb, line 489 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/cobrowse_media_participant.rb, line 479 def to_s to_hash.to_s end