class PureCloud::Video
Attributes
Indicates whether this participant has muted their outgoing audio.
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
The room id context (xmpp jid) for the conference session.
System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
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
A globally unique identifier for this communication.
The number of peer participants from the perspective of the participant in the conference.
The source provider for the video.
Indicates whether this participant is sharing their screen to the session.
The connection state of this communication.
Indicates whether this participant has muted/paused their outgoing video.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloud/models/video.rb, line 55 def self.attribute_map { :'state' => :'state', :'id' => :'id', :'context' => :'context', :'audio_muted' => :'audioMuted', :'video_muted' => :'videoMuted', :'sharing_screen' => :'sharingScreen', :'peer_count' => :'peerCount', :'disconnect_type' => :'disconnectType', :'connected_time' => :'connectedTime', :'disconnected_time' => :'disconnectedTime', :'provider' => :'provider' } end
# File lib/purecloud/models/video.rb, line 101 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[:'state'] self.state = attributes[:'state'] end if attributes[:'id'] self.id = attributes[:'id'] end if attributes[:'context'] self.context = attributes[:'context'] end if attributes[:'audioMuted'] self.audio_muted = attributes[:'audioMuted'] end if attributes[:'videoMuted'] self.video_muted = attributes[:'videoMuted'] end if attributes[:'sharingScreen'] self.sharing_screen = attributes[:'sharingScreen'] end if attributes[:'peerCount'] self.peer_count = attributes[:'peerCount'] end if attributes[:'disconnectType'] self.disconnect_type = attributes[:'disconnectType'] end if attributes[:'connectedTime'] self.connected_time = attributes[:'connectedTime'] end if attributes[:'disconnectedTime'] self.disconnected_time = attributes[:'disconnectedTime'] end if attributes[:'provider'] self.provider = attributes[:'provider'] end end
Attribute
type mapping.
# File lib/purecloud/models/video.rb, line 84 def self.swagger_types { :'state' => :'String', :'id' => :'String', :'context' => :'String', :'audio_muted' => :'BOOLEAN', :'video_muted' => :'BOOLEAN', :'sharing_screen' => :'BOOLEAN', :'peer_count' => :'Integer', :'disconnect_type' => :'String', :'connected_time' => :'DateTime', :'disconnected_time' => :'DateTime', :'provider' => :'String' } end
Public Instance Methods
Check equality by comparing each attribute.
# File lib/purecloud/models/video.rb, line 173 def ==(o) return true if self.equal?(o) self.class == o.class && state == o.state && id == o.id && context == o.context && audio_muted == o.audio_muted && video_muted == o.video_muted && sharing_screen == o.sharing_screen && peer_count == o.peer_count && disconnect_type == o.disconnect_type && connected_time == o.connected_time && disconnected_time == o.disconnected_time && provider == o.provider end
# File lib/purecloud/models/video.rb, line 219 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/video.rb, line 279 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/video.rb, line 200 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/video.rb, line 164 def disconnect_type=(disconnect_type) allowed_values = ["endpoint", "client", "system", "timeout", "transfer", "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
@see the `==` method
# File lib/purecloud/models/video.rb, line 190 def eql?(o) self == o end
Calculate hash code according to all attributes.
# File lib/purecloud/models/video.rb, line 195 def hash [state, id, context, audio_muted, video_muted, sharing_screen, peer_count, disconnect_type, connected_time, disconnected_time, provider].hash end
Custom attribute writer method checking allowed values (enum).
# File lib/purecloud/models/video.rb, line 155 def state=(state) allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "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/video.rb, line 267 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/video.rb, line 257 def to_s to_hash.to_s end