class PureCloud::Cobrowsesession

Attributes

_self[RW]

Address and name data for a call endpoint.

after_call_work[RW]

After-call work for the communication.

after_call_work_required[RW]

Indicates if after-call work is required for a communication. Only used when the ACW Setting is Agent Requested.

cobrowse_role[RW]

This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer).

cobrowse_session_id[RW]

The co-browse session ID.

connected_time[RW]

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

controlling[RW]

ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages).

disconnect_type[RW]

System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.

disconnected_time[RW]

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

id[RW]

A globally unique identifier for this communication.

peer_id[RW]

The id of the peer communication corresponding to a matching leg for this communication.

provider[RW]

The source provider for the co-browse session.

provider_event_time[RW]

The time when the provider event which triggered this conversation update happened in the corrected provider clock (milliseconds since 1970-01-01 00:00:00 UTC). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

segments[RW]

The time line of the participant's call, divided into activity segments.

start_alerting_time[RW]

The timestamp the communication has when it is first put into an alerting state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

state[RW]

The connection state of this communication.

viewer_url[RW]

The URL that can be used to open co-browse session in web browser.

wrapup[RW]

Call wrap up or disposition data.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/cobrowsesession.rb, line 76
def self.attribute_map
  {
    
    :'state' => :'state',
    
    :'id' => :'id',
    
    :'disconnect_type' => :'disconnectType',
    
    :'_self' => :'self',
    
    :'cobrowse_session_id' => :'cobrowseSessionId',
    
    :'cobrowse_role' => :'cobrowseRole',
    
    :'controlling' => :'controlling',
    
    :'viewer_url' => :'viewerUrl',
    
    :'provider_event_time' => :'providerEventTime',
    
    :'start_alerting_time' => :'startAlertingTime',
    
    :'connected_time' => :'connectedTime',
    
    :'disconnected_time' => :'disconnectedTime',
    
    :'provider' => :'provider',
    
    :'peer_id' => :'peerId',
    
    :'segments' => :'segments',
    
    :'wrapup' => :'wrapup',
    
    :'after_call_work' => :'afterCallWork',
    
    :'after_call_work_required' => :'afterCallWorkRequired'
    
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

  
  if attributes.has_key?(:'self')
    
    
    self._self = attributes[:'self']
    
  
  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

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

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

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

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

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/cobrowsesession.rb, line 119
def self.swagger_types
  {
    
    :'state' => :'String',
    
    :'id' => :'String',
    
    :'disconnect_type' => :'String',
    
    :'_self' => :'Address',
    
    :'cobrowse_session_id' => :'String',
    
    :'cobrowse_role' => :'String',
    
    :'controlling' => :'Array<String>',
    
    :'viewer_url' => :'String',
    
    :'provider_event_time' => :'DateTime',
    
    :'start_alerting_time' => :'DateTime',
    
    :'connected_time' => :'DateTime',
    
    :'disconnected_time' => :'DateTime',
    
    :'provider' => :'String',
    
    :'peer_id' => :'String',
    
    :'segments' => :'Array<Segment>',
    
    :'wrapup' => :'Wrapup',
    
    :'after_call_work' => :'AfterCallWork',
    
    :'after_call_work_required' => :'BOOLEAN'
    
  }
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/cobrowsesession.rb, line 546
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      id == o.id &&
      disconnect_type == o.disconnect_type &&
      _self == o._self &&
      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 &&
      start_alerting_time == o.start_alerting_time &&
      connected_time == o.connected_time &&
      disconnected_time == o.disconnected_time &&
      provider == o.provider &&
      peer_id == o.peer_id &&
      segments == o.segments &&
      wrapup == o.wrapup &&
      after_call_work == o.after_call_work &&
      after_call_work_required == o.after_call_work_required
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/cobrowsesession.rb, line 601
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/cobrowsesession.rb, line 661
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/cobrowsesession.rb, line 582
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
disconnect_type=(disconnect_type) click to toggle source

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

# File lib/purecloudplatformclientv2/models/cobrowsesession.rb, line 458
def disconnect_type=(disconnect_type)
  allowed_values = ["endpoint", "client", "system", "timeout", "transfer", "transfer.conference", "transfer.consult", "transfer.forward", "transport.failure", "error", "peer", "other", "spam", "uncallable"]
  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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/cobrowsesession.rb, line 571
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/cobrowsesession.rb, line 577
def hash
  [state, id, disconnect_type, _self, cobrowse_session_id, cobrowse_role, controlling, viewer_url, provider_event_time, start_alerting_time, connected_time, disconnected_time, provider, peer_id, segments, wrapup, after_call_work, after_call_work_required].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/cobrowsesession.rb, line 340
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
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/cobrowsesession.rb, line 439
def state=(state)
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "scheduled", "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/cobrowsesession.rb, line 644
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/cobrowsesession.rb, line 649
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/cobrowsesession.rb, line 639
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/cobrowsesession.rb, line 349
def valid?
  
  
  
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "scheduled", "none"]
  if @state && !allowed_values.include?(@state)
    return false
  end
  
  
  
  
  
  
  
  
  
  allowed_values = ["endpoint", "client", "system", "timeout", "transfer", "transfer.conference", "transfer.consult", "transfer.forward", "transport.failure", "error", "peer", "other", "spam", "uncallable"]
  if @disconnect_type && !allowed_values.include?(@disconnect_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end