> For the complete documentation index, see [llms.txt](https://documentation.hak5.org/wifi-pineapple-pager/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.hak5.org/wifi-pineapple-pager/confirmation_dialog.md).

# CONFIRMATION\_DIALOG

`CONFIRMATION_DIALOG` Ask the user to confirm an action via the UI

### When to use it <a href="#when-to-use-it" id="when-to-use-it"></a>

Use `CONFIRMATION_DIALOG` before taking a payload action which might take a log time, be intrusive, take action against a remote system, or any other time your payload should warn the user before an action and give them time to cancel.

#### Syntax <a href="#syntax" id="syntax"></a>

```none
CONFIRMATION_DIALOG [text prompt]
```

**text prompt&#x20;*****required***

Arbitrary text shown to the user. The text should be kept short enough to fit on the device display.

<figure><img src="/files/Z1ktHZbOgUpplMZpY9S9" alt="An example confirmation dialog"><figcaption><p>An example confirmation dialog</p></figcaption></figure>

### Results <a href="#results" id="results"></a>

`CONFIRMATION_DIALOG` will wait until the user has made a selection, pausing the payload.

`CONFIRMATION_DIALOG` prints a `1` as a return if the user continues or `0` if the user cancels.

`CONFIRMATION_DIALOG` exits with a return code of 0 under normal operation, and non-zero if the command fails.

### Examples <a href="#examples" id="examples"></a>

```bash
resp=$(CONFIRMATION_DIALOG "Continue the payload?") || exit 1 if [ "$resp" != "$DUCKYSCRIPT_USER_CONFIRMED" ]; then LOG "User cancelled!" exit 0 fi
```

{% hint style="info" %}
Remember to enclose the prompt text in quotes if it contains spaces!
{% endhint %}
