Class: Freeclimb::Play
- Inherits:
-
PerclCommand
- Object
- PerclCommand
- Freeclimb::Play
- Defined in:
- lib/freeclimb/models/play.rb
Overview
The ‘Play` command plays an audio file back to the caller. The audio file may be located at any location accessible via a URL. `Play` can exist as a stand-alone command or as a nested command. It does not allow barge-in unless nested within a `GetSpeech` command. The file will always be played to completion unless nested.
Instance Attribute Summary collapse
-
#conference_id ⇒ Object
ID of the Conference the audio should be rendered to.
-
#file ⇒ Object
RL of the audio file to be played to the caller.
-
#loop ⇒ Object
Number of times the audio file is played.
-
#privacy_mode ⇒ Object
Parameter ‘privacyMode` will not log the `text` as required by PCI compliance.
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 = {}) ⇒ Play
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 = {}) ⇒ Play
Initializes the object
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/freeclimb/models/play.rb', line 72 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::Play` 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::Play`. 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?(:'file') self.file = attributes[:'file'] end if attributes.key?(:'loop') self.loop = attributes[:'loop'] end if attributes.key?(:'conference_id') self.conference_id = attributes[:'conference_id'] end if attributes.key?(:'privacy_mode') self.privacy_mode = attributes[:'privacy_mode'] end self.command = "Play" end |
Instance Attribute Details
#conference_id ⇒ Object
ID of the Conference the audio should be rendered to. If this is not specified, the audio is by default rendered to the caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error.
26 27 28 |
# File 'lib/freeclimb/models/play.rb', line 26 def conference_id @conference_id end |
#file ⇒ Object
RL of the audio file to be played to the caller. The URL can be the ‘recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands.
20 21 22 |
# File 'lib/freeclimb/models/play.rb', line 20 def file @file end |
#loop ⇒ Object
Number of times the audio file is played. Specifying ‘0’ causes the Play action to loop until the Call is hung up.
23 24 25 |
# File 'lib/freeclimb/models/play.rb', line 23 def loop @loop end |
#privacy_mode ⇒ Object
Parameter ‘privacyMode` will not log the `text` as required by PCI compliance.
29 30 31 |
# File 'lib/freeclimb/models/play.rb', line 29 def privacy_mode @privacy_mode end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about, including the ones defined in its parent(s)
42 43 44 |
# File 'lib/freeclimb/models/play.rb', line 42 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.
32 33 34 35 36 37 38 39 |
# File 'lib/freeclimb/models/play.rb', line 32 def self.attribute_map { :'file' => :'file', :'loop' => :'loop', :'conference_id' => :'conferenceId', :'privacy_mode' => :'privacyMode' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
160 161 162 |
# File 'lib/freeclimb/models/play.rb', line 160 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3)
63 64 65 66 67 68 |
# File 'lib/freeclimb/models/play.rb', line 63 def self.openapi_all_of [ :'PerclCommand', :'PlayAllOf' ] end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
57 58 59 60 |
# File 'lib/freeclimb/models/play.rb', line 57 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
47 48 49 50 51 52 53 54 |
# File 'lib/freeclimb/models/play.rb', line 47 def self.openapi_types { :'file' => :'String', :'loop' => :'Integer', :'conference_id' => :'String', :'privacy_mode' => :'Boolean' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
136 137 138 139 140 141 142 143 |
# File 'lib/freeclimb/models/play.rb', line 136 def ==(o) return true if self.equal?(o) self.class == o.class && file == o.file && loop == o.loop && conference_id == o.conference_id && privacy_mode == o.privacy_mode && super(o) end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/freeclimb/models/play.rb', line 191 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
262 263 264 265 266 267 268 269 270 271 272 273 274 |
# File 'lib/freeclimb/models/play.rb', line 262 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
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/freeclimb/models/play.rb', line 167 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
147 148 149 |
# File 'lib/freeclimb/models/play.rb', line 147 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
153 154 155 |
# File 'lib/freeclimb/models/play.rb', line 153 def hash [file, loop, conference_id, privacy_mode].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
108 109 110 111 112 113 114 115 |
# File 'lib/freeclimb/models/play.rb', line 108 def list_invalid_properties invalid_properties = super if @file.nil? invalid_properties.push('invalid value for "file", file cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
238 239 240 |
# File 'lib/freeclimb/models/play.rb', line 238 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/freeclimb/models/play.rb', line 244 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
232 233 234 |
# File 'lib/freeclimb/models/play.rb', line 232 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
119 120 121 122 123 124 125 126 127 128 129 130 131 132 |
# File 'lib/freeclimb/models/play.rb', line 119 def valid? if @file.nil? false elsif @loop.nil? false elsif @conference_id.nil? false elsif @privacy_mode.nil? false else list_invalid_properties.length() == 0 end end |