Flush() method

Elements/Objects that the method can be called on

• <dtmf ...>
  • Attribute description:
    • Flush the DTMF buffer. Flush has no effect if called while the dtmf object is started.
      
  • Syntax: Object.Flush();
    
  • Parameters: none
    
  • Retrun Value: none
    
  • Exception: There are no explicit exceptions associated with this method.
    • However, if there is any problem an onError event is fired and the status codes as outlined in onError are set.

• PromptQueue
• Attribute description:
  • Stop playback and flush the audio buffer.
  • All subqueues are removed from the PromptQueue.
  • If playback is not underway (i.e. it has not been started or has already been stopped or paused) the method flushes all prompt subqueues.
  • In telephony profiles, the Flush() method is executed automatically by the detection of a disconnect (the order of firing is as follows: listen, dtmf, PromptQueue), and the onError event is thrown, with status code -30.
    
• Syntax: PromptQueue.Flush();
  
• Parameters: none
  
• Retrun Value: none
  
• Exception: There are no explicit exceptions associated with this method.
  • However, onError is thrown and status code -30 set in telephony profiles when a disconnect event automatically invokes Flush().

Example

Extra info

For details on usage of this element, see the SALT Specification, Version 1.0.