Class: Twilio::TwiML::Gather

Inherits:
TwiML
  • Object
show all
Defined in:
lib/twilio-ruby/twiml/voice_response.rb

Overview

<Gather> TwiML Verb

Instance Attribute Summary

Attributes inherited from TwiML

#name

Instance Method Summary collapse

Methods inherited from TwiML

#add_child, #add_text, #append, #comment, to_lower_camel_case, #to_s, #xml

Constructor Details

#initialize(**keyword_args) {|_self| ... } ⇒ Gather

Returns a new instance of Gather.

Yields:

  • (_self)

Yield Parameters:


1427
1428
1429
1430
1431
1432
# File 'lib/twilio-ruby/twiml/voice_response.rb', line 1427

def initialize(**keyword_args)
  super(**keyword_args)
  @name = 'Gather'

  yield(self) if block_given?
end

Instance Method Details

#pause(length: nil, **keyword_args) ⇒ Object

Create a new <Pause> element

length

Length in seconds to pause

keyword_args

additional attributes


1452
1453
1454
# File 'lib/twilio-ruby/twiml/voice_response.rb', line 1452

def pause(length: nil, **keyword_args)
  append(Pause.new(length: length, **keyword_args))
end

#play(url: nil, loop: nil, digits: nil, **keyword_args) ⇒ Object

Create a new <Play> element

url

Media URL

loop

Times to loop media

digits

Play DTMF tones for digits

keyword_args

additional attributes


1462
1463
1464
# File 'lib/twilio-ruby/twiml/voice_response.rb', line 1462

def play(url: nil, loop: nil, digits: nil, **keyword_args)
  append(Play.new(url: url, loop: loop, digits: digits, **keyword_args))
end

#say(message: nil, voice: nil, loop: nil, language: nil, **keyword_args) {|say| ... } ⇒ Object

Create a new <Say> element

message

Message to say

voice

Voice to use

loop

Times to loop message

language

Message language

keyword_args

additional attributes

Yields:


1441
1442
1443
1444
1445
1446
# File 'lib/twilio-ruby/twiml/voice_response.rb', line 1441

def say(message: nil, voice: nil, loop: nil, language: nil, **keyword_args)
  say = Say.new(message: message, voice: voice, loop: loop, language: language, **keyword_args)

  yield(say) if block_given?
  append(say)
end