Class: Freeclimb::SetTalk
- Inherits:
-
PerclCommand
- Object
- PerclCommand
- Freeclimb::SetTalk
- Defined in:
- lib/freeclimb/models/set_talk.rb
Overview
The ‘SetTalk` command enables or disables the talk privilege for a Participant in a Conference provided both calls are in the same conference. If ’true’, no audio from that Participant is shared with the other Participants of the Conference.
Instance Attribute Summary collapse
-
#call_id ⇒ Object
ID of the call leg that is to be muted or unmuted.
-
#talk ⇒ Object
Specifying ‘false` mutes the Participant.
Attributes inherited from PerclCommand
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about, including the ones defined in its parent(s).
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3).
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SetTalk
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Methods inherited from PerclCommand
openapi_discriminator_name, #to_percl_hash
Constructor Details
#initialize(attributes = {}) ⇒ SetTalk
Initializes the object
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/freeclimb/models/set_talk.rb', line 62 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::SetTalk` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::SetTalk`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } # call parent's initialize super(attributes) if attributes.key?(:'call_id') self.call_id = attributes[:'call_id'] end if attributes.key?(:'talk') self.talk = attributes[:'talk'] end self.command = "SetTalk" end |
Instance Attribute Details
#call_id ⇒ Object
ID of the call leg that is to be muted or unmuted. The Call must be in a Conference or an error will be triggered.
20 21 22 |
# File 'lib/freeclimb/models/set_talk.rb', line 20 def call_id @call_id end |
#talk ⇒ Object
Specifying ‘false` mutes the Participant.
23 24 25 |
# File 'lib/freeclimb/models/set_talk.rb', line 23 def talk @talk end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about, including the ones defined in its parent(s)
34 35 36 |
# File 'lib/freeclimb/models/set_talk.rb', line 34 def self.acceptable_attributes attribute_map.values.concat(superclass.acceptable_attributes) end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
26 27 28 29 30 31 |
# File 'lib/freeclimb/models/set_talk.rb', line 26 def self.attribute_map { :'call_id' => :'callId', :'talk' => :'talk' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
136 137 138 |
# File 'lib/freeclimb/models/set_talk.rb', line 136 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3)
53 54 55 56 57 58 |
# File 'lib/freeclimb/models/set_talk.rb', line 53 def self.openapi_all_of [ :'PerclCommand', :'SetTalkAllOf' ] end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
47 48 49 50 |
# File 'lib/freeclimb/models/set_talk.rb', line 47 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
39 40 41 42 43 44 |
# File 'lib/freeclimb/models/set_talk.rb', line 39 def self.openapi_types { :'call_id' => :'String', :'talk' => :'Boolean' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
114 115 116 117 118 119 |
# File 'lib/freeclimb/models/set_talk.rb', line 114 def ==(o) return true if self.equal?(o) self.class == o.class && call_id == o.call_id && talk == o.talk && super(o) end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/freeclimb/models/set_talk.rb', line 167 def _deserialize(type, value) case type.to_sym when :Time Time.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 =~ /\A(true|t|yes|y|1)\z/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 # models (e.g. Pet) or oneOf klass = Freeclimb.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/freeclimb/models/set_talk.rb', line 238 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) ⇒ Object
Builds the object from hash
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/freeclimb/models/set_talk.rb', line 143 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) super(attributes) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end |
#eql?(o) ⇒ Boolean
123 124 125 |
# File 'lib/freeclimb/models/set_talk.rb', line 123 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
129 130 131 |
# File 'lib/freeclimb/models/set_talk.rb', line 129 def hash [call_id, talk].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
90 91 92 93 94 95 96 97 |
# File 'lib/freeclimb/models/set_talk.rb', line 90 def list_invalid_properties invalid_properties = super if @call_id.nil? invalid_properties.push('invalid value for "call_id", call_id cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
214 215 216 |
# File 'lib/freeclimb/models/set_talk.rb', line 214 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/freeclimb/models/set_talk.rb', line 220 def to_hash hash = super self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
208 209 210 |
# File 'lib/freeclimb/models/set_talk.rb', line 208 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
101 102 103 104 105 106 107 108 109 110 |
# File 'lib/freeclimb/models/set_talk.rb', line 101 def valid? if @call_id.nil? false elsif @talk.nil? false else list_invalid_properties.length() == 0 end end |