class PureCloud::MediaParticipantRequest
Attributes
True to confine this conversation participant. Should only be used for ad-hoc conferences
True to hold this conversation participant.
True to mute this conversation participant.
True to enable recording of this participant, otherwise false to disable recording.
The state to update to set for this participant's communications. Possible values are: 'connected' and 'disconnected'.
Wrap-up to assign to this participant.
True to skip wrap-up for this participant.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/media_participant_request.rb, line 43 def self.attribute_map { :'wrapup' => :'wrapup', :'state' => :'state', :'recording' => :'recording', :'muted' => :'muted', :'confined' => :'confined', :'held' => :'held', :'wrapup_skipped' => :'wrapupSkipped' } end
# File lib/purecloud/models/media_participant_request.rb, line 77 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[:'wrapup'] self.wrapup = attributes[:'wrapup'] end if attributes[:'state'] self.state = attributes[:'state'] end if attributes[:'recording'] self.recording = attributes[:'recording'] 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[:'wrapupSkipped'] self.wrapup_skipped = attributes[:'wrapupSkipped'] end end
Attribute
type mapping.
# File lib/purecloud/models/media_participant_request.rb, line 64 def self.swagger_types { :'wrapup' => :'Wrapup', :'state' => :'String', :'recording' => :'BOOLEAN', :'muted' => :'BOOLEAN', :'confined' => :'BOOLEAN', :'held' => :'BOOLEAN', :'wrapup_skipped' => :'BOOLEAN' } end
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/media_participant_request.rb, line 124 def ==(o) return true if self.equal?(o) self.class == o.class && wrapup == o.wrapup && state == o.state && recording == o.recording && muted == o.muted && confined == o.confined && held == o.held && wrapup_skipped == o.wrapup_skipped end
# File lib/purecloud/models/media_participant_request.rb, line 166 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/media_participant_request.rb, line 226 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/media_participant_request.rb, line 147 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
@see the `==` method
# File lib/purecloud/models/media_participant_request.rb, line 137 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/media_participant_request.rb, line 142 def hash [wrapup, state, recording, muted, confined, held, wrapup_skipped].hash end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/media_participant_request.rb, line 115 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/media_participant_request.rb, line 214 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/media_participant_request.rb, line 204 def to_s to_hash.to_s end