# dialog

Below is an example of a dialog box for selecting multiple files:

```javascript
let result = await eagle.dialog.showOpenDialog({ 
    properties: ['openFile', 'multiSelections'] 
});
```

***

#### Methods <a href="#z1a5y" id="z1a5y"></a>

## showOpenDialog(options) <a href="#tkp0d" id="tkp0d"></a>

Displays the open file dialog.

* `options` Object
  * `title` string (optional) - The title of the dialog window
  * `defaultPath` string (optional) - The default display path of the dialog
  * `buttonLabel` string (optional) - Custom label for the "Confirm" button; if empty, the default label is used.
  * `filters` [FileFilter](https://www.electronjs.org/zh/docs/latest/api/structures/file-filter)\[] (optional)
    * `name` string
    * `extensions` string\[]
  * `properties` string\[] (optional) - Contains dialog-related attributes. The following attribute values are supported:
    * `openFile` - Allows selecting files
    * `openDirectory` - Allows selecting folders
    * `multiSelections`- Allows multiple selections.
    * `showHiddenFiles`- Displays hidden files in the dialog.
    * `createDirectory` `macOS` - Allows you to create a new directory through the dialog.
    * `promptToCreate` `Windows`- If the entered file path does not exist in the dialog, prompt to create it. This does not actually create a file on the path but allows returning some non-existent addresses for the application to create.
  * `message` string (optional) `macOS` - The message displayed above the input box.
* Returns `Promise<result: Object>`
  * `result`Object
    * `canceled` boolean - Whether the dialog was canceled
    * `filePaths` string\[] - Array of chosen file paths by the user. If the dialog is canceled, this will be an empty array.

```javascript
{
  filters: [
    { name: 'Images', extensions: ['jpg', 'png', 'gif'] },
    { name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] },
    { name: 'Custom File Type', extensions: ['as'] },
    { name: 'All Files', extensions: ['*'] }
  ]
}
```

```javascript
let result = await eagle.dialog.showOpenDialog({
    properties: ['openFile', 'openDirectory']
});
```

{% hint style="info" %}
Note: This feature is similar to Electron API's [dialog.showOpenDialog](https://www.electronjs.org/zh/docs/latest/api/dialog#dialogshowopendialogbrowserwindow-options) feature.
{% endhint %}

***

## showSaveDialog(options) <a href="#g872m" id="g872m"></a>

Displays the save file dialog.

* `options` Object
  * `title` string (optional) - The title of the dialog window
  * `defaultPath` string (optional) - The default display path of the dialog
  * `buttonLabel` string (optional) - Custom label for the "Confirm" button; if empty, the default label is used.
  * `filters` [FileFilter](https://www.electronjs.org/zh/docs/latest/api/structures/file-filter)\[] (optional)
    * `name` string
    * `extensions` string\[]
  * `properties` string\[] (optional) - Contains dialog-related attributes. The following attribute values are supported:
    * `openDirectory` - Allows selecting folders
    * `showHiddenFiles`- Displays hidden files in the dialog.
    * `createDirectory` `macOS` - Allows you to create a new directory through the dialog.
* Returns `Promise<result: Object>`
  * `result`Object
    * `canceled` boolean - Whether the dialog was canceled
    * `filePath` string - If the dialog is canceled, this value will be `undefined`.

```javascript
{
  filters: [
    { name: 'Images', extensions: ['jpg', 'png', 'gif'] },
    { name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] },
    { name: 'Custom File Type', extensions: ['as'] },
    { name: 'All Files', extensions: ['*'] }
  ]
}
```

```javascript
let result = await eagle.dialog.showSaveDialog({
    properties: ['openDirectory']
});
```

{% hint style="info" %}
Note: This function is similar to the Electron API's [dialog.showSaveDialog](https://www.electronjs.org/zh/docs/latest/api/dialog#dialogshowsavedialogbrowserwindow-options) function.
{% endhint %}

***

## showMessageBox(options) <a href="#grq5h" id="grq5h"></a>

Display a message dialog.

* `options` Object
  * `message` string - The main content of the dialog
  * `title` string (optional) - Dialog title
  * `detail` string (optional) - Additional information
  * `buttons` strings\[] (optional) - Array of button texts
  * `type` string (optional) - Can be `none`, `info`, `error`, `question`, or `warning`
* Returns `Promise<result: Object>`
  * `result` Object
    * `response` Integer - The index of the clicked button

```javascript
let result = await eagle.dialog.showMessageBox({
    title: "Messagebox title",
    message: "Message from the Plugin process",
    detail: "Ultra message here",
    buttons: ["OK", "Cancel"],
    type: "info"
});

console.log(result);		// {response: 0}
```

{% hint style="info" %}
This function is similar to the Electron API's [dialog.showSaveDialog](https://www.electronjs.org/zh/docs/latest/api/dialog#dialogshowsavedialogbrowserwindow-options) function.
{% endhint %}

***

## showErrorBox(title, content) <a href="#erokr" id="erokr"></a>

Display an error message dialog.

* `title` string - The title displayed in the error box
* `content` string - The text content displayed in the error box
* Returns `Promise<void>`

{% code overflow="wrap" %}

```javascript
await eagle.dialog.showErrorBox("Error box title", "Error message from the Plugin process");
```

{% endcode %}

{% hint style="info" %}
Note: This function is similar to the Electron API's [dialog.showSaveDialog](https://www.electronjs.org/zh/docs/latest/api/dialog#dialogshowsavedialogbrowserwindow-options) function.
{% endhint %}

### &#x20;<a href="#nptwx" id="nptwx"></a>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.eagle.cool/plugin-api/api/dialog.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.