## Prompt

The Prompt function is intended to be used to interact with a running action. You specify a prompt message to be displayed in the Action Pending Window. When the prompt dialog is displayed you can choose to cancel the action or continue. The prompt is only issued once per set of files when run stepwise.

You can set the text colour for the prompt to one of Default, (Preferences-General), Black, Blue or Red.

You can elect to issue a beep with the prompt.

Typically the name of the action issuing the prompt, the file it is associated with and the reason for the prompt are displayed in the Pending Action window. You can disable the display of this information by selecting the Hide info option.

Typically the Pending Action window will display a Copy button for this statement. You can disable the display of the button if you wish.

The supplied prompt string may contain any of the escape sequences described in Escape Sequences. The prompt is a multi line scrolling area.

The displayed window will have a Copy button, enabling you to copy the displayed information to the system clipboard.

The following modes are available:

Standard
  As the name implies this is the standard mode of operation. When not batch processing, the Pending Action Window is displayed. When batch processing, the prompt is placed into the log file with the issuing action's information.
UI
  When not batch processing, the mode is the same as Standard. When batch processing, the prompt is issued to the UI (colour and beep is ignored). The UI mode is intended to be used within the special Batch Start and Batch End inline actions.
Log
  The log mode will cause the message to be logged to the system log. These messages can be viewed with the Console application. Note that on Sierra, the availability of the message in the Console application may depend on whether it was running at the time the message was issued. On Sierra, messages intentionally issued by Yate can be viewed by the following command when executed in the Terminal:
  log show --predicate 'process == "Yate" and eventMessage beginswith "(Yate-App)"'
Plain Text
  When not batch processing, the mode is the same as Standard. When batch processing, the prompt is is placed into the log file without the issuing action's information. The text is written as is without any leading or trailing newline characters added.
Status
  When performing lengthy operations it may be desirable to display status information. The status information is displayed on the main window's status bar. This option should be used with care as it will slow down action processing, especially while batch processing. Note that the mode is intended primarily for use while batch processing. While not batch processing, the status bar value can be overwritten by a number of other functions.