lib/tropo-webapi-ruby/tropo-webapi-ruby.rb
##
# Creates a conference or pushes a user to an existing conference
#
# @overload conference(params)
#   @param [Hash] params the options to create a conference with.
#   @option params [required, String] :name this is the key used to identify the result of an operation, so you can differentiate between multiple results
#   @option params [required, String] :id the number to assign to the conference room
#   @option params [optional, Float] :interdigitTimeout (5.0) defines how long to wait between key presses to determine the user has stopped entering input
#   @option params [optional, Boolean or Hash] :joinPrompt (false) determines a prompt that plays to all participants of a conference when someone joins the conference
#   @option params [optional, Boolean or Hash] :leavePrompt (false) determines a prompt that plays to all participants of a conference when someone leaves the conference
#   @option params [optional, Boolean] :mute (false) whether to mute this caller in the conference
#   @option params [optional, Boolean] :playTones (false) whether to allow the DTMF input from a user to play into the conference
#   @option params [optional, String] :terminator this is the touch-tone key (DTMF) used to exit the conference
#   @option params [optional, Boolean] :required (true) determines whether Tropo should move on to the next verb - if true, Tropo will only move on if the current operation completed
#   @option params [optional, String or Array] :allowSignals allows you to assign a signal to conference which can be used with REST to interrupt the function 
#   @option params [optional, String] :promptLogSecurity Controls whether Tropo logs the text to speech string used by the method.
# @overload conference(params, &block)
#   @param [Hash] params the options to create a conference with.
#   @param [Block] takes a block so that you may trigger actions, such as a say, on a specific event
#   @option params [required, String] :name this is the key used to identify the result of an operation, so you can differentiate between multiple results
#   @option params [required, String] :id the number to assign to the conference room
#   @option params [optional, Float] :interdigitTimeout (5.0) defines how long to wait between key presses to determine the user has stopped entering input
#   @option params [optional, Boolean or Hash] :joinPrompt (false) determines a prompt that plays to all participants of a conference when someone joins the conference
#   @option params [optional, Boolean or Hash] :leavePrompt (false) determines a prompt that plays to all participants of a conference when someone leaves the conference
#   @option params [optional, Boolean] :mute (false) whether to mute this caller in the conference
#   @option params [optional, Boolean] :playTones (false) whether to allow the DTMF input from a user to play into the conference
#   @option params [optional, String] :terminator this is the touch-tone key (DTMF) used to exit the conference
#   @option params [optional, Boolean] :required (true) determines whether Tropo should move on to the next verb - if true, Tropo will only move on if the current operation completed
#   @option params [optional, String or Array] :allowSignals allows you to assign a signal to conference which can be used with REST to interrupt the function 
#   @option params [optional, String] :promptLogSecurity Controls whether Tropo logs the text to speech string used by the method.
# @return [String, nil] the JSON string to be passed back to Tropo or nil
#   if the method has been called from inside a block
Creates a conference or pushes a user to an existing conference
Creates a conference or pushes a user to an existing conference
def conference(params={}, &block)
      if block_given?
        create_nested_hash('conference', params)
        instance_exec(&block)
        @response[:tropo] << @nested_hash
        @nested_hash = nil
        @nested_name = nil
      else
        hash = build_action('conference', params)
        @response[:tropo] << hash
      end
      render_response if @building.nil?
    end
def conference ( params = { } , & block ) if block_given? create_nested_hash ( 'conference' , params ) instance_exec ( & block ) @response [ :tropo ] << @nested_hash @nested_hash = nil @nested_name = nil else hash = build_action ( 'conference' , params ) @response [ :tropo ] << hash end render_response if @building . nil? end
Creates a conference or pushes a user to an existing conference
Creates a conference or pushes a user to an existing conference
the JSON string to be passed back to Tropo or nil if the method has been called from inside a block
the JSON string to be passed back to Tropo or nil if the method has been called from inside a block
String, nil
params
block
overload
conference(params) @param [Hash] params the options to create a conference with. @option params [required, String] :name this is the key used to identify the result of an operation, so you can differentiate between multiple results @option params [required, String] :id the number to assign to the conference room @option params [optional, Float] :interdigitTimeout (5.0) defines how long to wait between key presses to determine the user has stopped entering input @option params [optional, Boolean or Hash] :joinPrompt (false) determines a prompt that plays to all participants of a conference when someone joins the conference @option params [optional, Boolean or Hash] :leavePrompt (false) determines a prompt that plays to all participants of a conference when someone leaves the conference @option params [optional, Boolean] :mute (false) whether to mute this caller in the conference @option params [optional, Boolean] :playTones (false) whether to allow the DTMF input from a user to play into the conference @option params [optional, String] :terminator this is the touch-tone key (DTMF) used to exit the conference @option params [optional, Boolean] :required (true) determines whether Tropo should move on to the next verb - if true, Tropo will only move on if the current operation completed @option params [optional, String or Array] :allowSignals allows you to assign a signal to conference which can be used with REST to interrupt the function @option params [optional, String] :promptLogSecurity Controls whether Tropo logs the text to speech string used by the method.
conference ( params ) @param [ Hash ] params the options to create a conference with . @option params [ required String ] : name this is the key used to identify the result of an operation so you can differentiate between multiple results @option params [ required String ] : id the number to assign to the conference room @option params [ optional Float ] : interdigitTimeout ( 5 . 0 ) defines how long to wait between key presses to determine the user has stopped entering input @option params [ optional Boolean or Hash ] : joinPrompt ( false ) determines a prompt that plays to all participants of a conference when someone joins the conference @option params [ optional Boolean or Hash ] : leavePrompt ( false ) determines a prompt that plays to all participants of a conference when someone leaves the conference @option params [ optional Boolean ] : mute ( false ) whether to mute this caller in the conference @option params [ optional Boolean ] : playTones ( false ) whether to allow the DTMF input from a user to play into the conference @option params [ optional String ] : terminator this is the touch - tone key ( DTMF ) used to exit the conference @option params [ optional Boolean ] : required ( true ) determines whether Tropo should move on to the next verb - if true Tropo will only move on if the current operation completed @option params [ optional String or Array ] : allowSignals allows you to assign a signal to conference which can be used with REST to interrupt the function @option params [ optional String ] : promptLogSecurity Controls whether Tropo logs the text to speech string used by the method .
overload
conference(params, █) @param [Hash] params the options to create a conference with. @param [Block] takes a block so that you may trigger actions, such as a say, on a specific event @option params [required, String] :name this is the key used to identify the result of an operation, so you can differentiate between multiple results @option params [required, String] :id the number to assign to the conference room @option params [optional, Float] :interdigitTimeout (5.0) defines how long to wait between key presses to determine the user has stopped entering input @option params [optional, Boolean or Hash] :joinPrompt (false) determines a prompt that plays to all participants of a conference when someone joins the conference @option params [optional, Boolean or Hash] :leavePrompt (false) determines a prompt that plays to all participants of a conference when someone leaves the conference @option params [optional, Boolean] :mute (false) whether to mute this caller in the conference @option params [optional, Boolean] :playTones (false) whether to allow the DTMF input from a user to play into the conference @option params [optional, String] :terminator this is the touch-tone key (DTMF) used to exit the conference @option params [optional, Boolean] :required (true) determines whether Tropo should move on to the next verb - if true, Tropo will only move on if the current operation completed @option params [optional, String or Array] :allowSignals allows you to assign a signal to conference which can be used with REST to interrupt the function @option params [optional, String] :promptLogSecurity Controls whether Tropo logs the text to speech string used by the method.
conference ( params █ ) @param [ Hash ] params the options to create a conference with . @param [ Block ] takes a block so that you may trigger actions such as a say on a specific event @option params [ required String ] : name this is the key used to identify the result of an operation so you can differentiate between multiple results @option params [ required String ] : id the number to assign to the conference room @option params [ optional Float ] : interdigitTimeout ( 5 . 0 ) defines how long to wait between key presses to determine the user has stopped entering input @option params [ optional Boolean or Hash ] : joinPrompt ( false ) determines a prompt that plays to all participants of a conference when someone joins the conference @option params [ optional Boolean or Hash ] : leavePrompt ( false ) determines a prompt that plays to all participants of a conference when someone leaves the conference @option params [ optional Boolean ] : mute ( false ) whether to mute this caller in the conference @option params [ optional Boolean ] : playTones ( false ) whether to allow the DTMF input from a user to play into the conference @option params [ optional String ] : terminator this is the touch - tone key ( DTMF ) used to exit the conference @option params [ optional Boolean ] : required ( true ) determines whether Tropo should move on to the next verb - if true Tropo will only move on if the current operation completed @option params [ optional String or Array ] : allowSignals allows you to assign a signal to conference which can be used with REST to interrupt the function @option params [ optional String ] : promptLogSecurity Controls whether Tropo logs the text to speech string used by the method .