class PureCloud::ScreenShareConversationNotificationParticipants
Attributes
address[RW]
attributes[RW]
connected_time[RW]
context[RW]
direction[RW]
disconnect_type[RW]
end_time[RW]
error_info[RW]
external_contact[RW]
external_organization[RW]
held[RW]
id[RW]
name[RW]
peer_count[RW]
provider[RW]
purpose[RW]
queue[RW]
script[RW]
sharing[RW]
start_hold_time[RW]
start_time[RW]
state[RW]
user[RW]
wrapup[RW]
wrapup_prompt[RW]
wrapup_required[RW]
wrapup_skipped[RW]
wrapup_timeout_ms[RW]
Public Class Methods
attribute_map()
click to toggle source
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/screen_share_conversation_notification_participants.rb, line 78 def self.attribute_map { :'wrapup_skipped' => :'wrapupSkipped', :'peer_count' => :'peerCount', :'purpose' => :'purpose', :'held' => :'held', :'wrapup_timeout_ms' => :'wrapupTimeoutMs', :'error_info' => :'errorInfo', :'provider' => :'provider', :'wrapup_required' => :'wrapupRequired', :'context' => :'context', :'connected_time' => :'connectedTime', :'disconnect_type' => :'disconnectType', :'start_time' => :'startTime', :'id' => :'id', :'state' => :'state', :'direction' => :'direction', :'wrapup' => :'wrapup', :'address' => :'address', :'external_contact' => :'externalContact', :'sharing' => :'sharing', :'external_organization' => :'externalOrganization', :'script' => :'script', :'name' => :'name', :'wrapup_prompt' => :'wrapupPrompt', :'attributes' => :'attributes', :'end_time' => :'endTime', :'start_hold_time' => :'startHoldTime', :'user' => :'user', :'queue' => :'queue' } end
new(attributes = {})
click to toggle source
# File lib/purecloud/models/screen_share_conversation_notification_participants.rb, line 175 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[:'wrapupSkipped'] self.wrapup_skipped = attributes[:'wrapupSkipped'] end if attributes[:'peerCount'] self.peer_count = attributes[:'peerCount'] end if attributes[:'purpose'] self.purpose = attributes[:'purpose'] end if attributes[:'held'] self.held = attributes[:'held'] end if attributes[:'wrapupTimeoutMs'] self.wrapup_timeout_ms = attributes[:'wrapupTimeoutMs'] end if attributes[:'errorInfo'] self.error_info = attributes[:'errorInfo'] end if attributes[:'provider'] self.provider = attributes[:'provider'] end if attributes[:'wrapupRequired'] self.wrapup_required = attributes[:'wrapupRequired'] end if attributes[:'context'] self.context = attributes[:'context'] end if attributes[:'connectedTime'] self.connected_time = attributes[:'connectedTime'] end if attributes[:'disconnectType'] self.disconnect_type = attributes[:'disconnectType'] end if attributes[:'startTime'] self.start_time = attributes[:'startTime'] end if attributes[:'id'] self.id = attributes[:'id'] end if attributes[:'state'] self.state = attributes[:'state'] end if attributes[:'direction'] self.direction = attributes[:'direction'] end if attributes[:'wrapup'] self.wrapup = attributes[:'wrapup'] end if attributes[:'address'] self.address = attributes[:'address'] end if attributes[:'externalContact'] self.external_contact = attributes[:'externalContact'] end if attributes[:'sharing'] self.sharing = attributes[:'sharing'] end if attributes[:'externalOrganization'] self.external_organization = attributes[:'externalOrganization'] end if attributes[:'script'] self.script = attributes[:'script'] end if attributes[:'name'] self.name = attributes[:'name'] end if attributes[:'wrapupPrompt'] self.wrapup_prompt = attributes[:'wrapupPrompt'] end if attributes[:'attributes'] if (value = attributes[:'attributes']).is_a?(Array) self.attributes = value end end if attributes[:'endTime'] self.end_time = attributes[:'endTime'] end if attributes[:'startHoldTime'] self.start_hold_time = attributes[:'startHoldTime'] end if attributes[:'user'] self.user = attributes[:'user'] end if attributes[:'queue'] self.queue = attributes[:'queue'] end end
swagger_types()
click to toggle source
Attribute
type mapping.
# File lib/purecloud/models/screen_share_conversation_notification_participants.rb, line 141 def self.swagger_types { :'wrapup_skipped' => :'BOOLEAN', :'peer_count' => :'Integer', :'purpose' => :'String', :'held' => :'BOOLEAN', :'wrapup_timeout_ms' => :'Integer', :'error_info' => :'ScreenShareConversationNotificationErrorInfo', :'provider' => :'String', :'wrapup_required' => :'BOOLEAN', :'context' => :'String', :'connected_time' => :'DateTime', :'disconnect_type' => :'String', :'start_time' => :'DateTime', :'id' => :'String', :'state' => :'String', :'direction' => :'String', :'wrapup' => :'ConversationNotificationWrapup', :'address' => :'String', :'external_contact' => :'ScreenShareConversationNotificationUriReference', :'sharing' => :'BOOLEAN', :'external_organization' => :'ScreenShareConversationNotificationUriReference', :'script' => :'ScreenShareConversationNotificationUriReference', :'name' => :'String', :'wrapup_prompt' => :'String', :'attributes' => :'Hash<String, String>', :'end_time' => :'DateTime', :'start_hold_time' => :'DateTime', :'user' => :'DocumentDataV2NotificationCreatedBy', :'queue' => :'ScreenShareConversationNotificationUriReference' } end
Public Instance Methods
==(o)
click to toggle source
Check equality by comparing each attribute.
# File lib/purecloud/models/screen_share_conversation_notification_participants.rb, line 326 def ==(o) return true if self.equal?(o) self.class == o.class && wrapup_skipped == o.wrapup_skipped && peer_count == o.peer_count && purpose == o.purpose && held == o.held && wrapup_timeout_ms == o.wrapup_timeout_ms && error_info == o.error_info && provider == o.provider && wrapup_required == o.wrapup_required && context == o.context && connected_time == o.connected_time && disconnect_type == o.disconnect_type && start_time == o.start_time && id == o.id && state == o.state && direction == o.direction && wrapup == o.wrapup && address == o.address && external_contact == o.external_contact && sharing == o.sharing && external_organization == o.external_organization && script == o.script && name == o.name && wrapup_prompt == o.wrapup_prompt && attributes == o.attributes && end_time == o.end_time && start_hold_time == o.start_hold_time && user == o.user && queue == o.queue end
_deserialize(type, value)
click to toggle source
# File lib/purecloud/models/screen_share_conversation_notification_participants.rb, line 389 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/purecloud/models/screen_share_conversation_notification_participants.rb, line 449 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/purecloud/models/screen_share_conversation_notification_participants.rb, line 370 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
direction=(direction)
click to toggle source
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/screen_share_conversation_notification_participants.rb, line 317 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
disconnect_type=(disconnect_type)
click to toggle source
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/screen_share_conversation_notification_participants.rb, line 299 def disconnect_type=(disconnect_type) allowed_values = ["endpoint", "client", "system", "transfer", "timeout", "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
eql?(o)
click to toggle source
@see the `==` method
# File lib/purecloud/models/screen_share_conversation_notification_participants.rb, line 360 def eql?(o) self == o end
hash()
click to toggle source
Calculate hash code according to all attributes.
# File lib/purecloud/models/screen_share_conversation_notification_participants.rb, line 365 def hash [wrapup_skipped, peer_count, purpose, held, wrapup_timeout_ms, error_info, provider, wrapup_required, context, connected_time, disconnect_type, start_time, id, state, direction, wrapup, address, external_contact, sharing, external_organization, script, name, wrapup_prompt, attributes, end_time, start_hold_time, user, queue].hash end
state=(state)
click to toggle source
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/screen_share_conversation_notification_participants.rb, line 308 def state=(state) allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "scheduled", "none"] if state && !allowed_values.include?(state) fail "invalid value for 'state', must be one of #{allowed_values}" end @state = state end
to_body()
click to toggle source
to_hash()
click to toggle source
return the object in the form of hash
# File lib/purecloud/models/screen_share_conversation_notification_participants.rb, line 437 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/purecloud/models/screen_share_conversation_notification_participants.rb, line 427 def to_s to_hash.to_s end