# DialogsAPI

**Kind**: interface | **Module**: [Modals](https://docs.interop.io/desktop/reference/javascript/modals/index.md) | **Access**: `io.modals.dialogs`

**Source**: https://docs.interop.io/desktop/reference/javascript/modals/dialogsapi/index.html

The Dialogs API provides a way to create and manage dialogs within the io.Connect platform. There are predefined dialog templates from which you can choose
and you can configure various dialog settings, such as the size of the dialog window, whether to target the current window container or the entire platform, and more.

The Dialogs API is accessible via the `io.modals.dialogs` object.

## Methods

### request

Sends a request to the platform for displaying a dialog.

```ts
(config: DialogRequestConfig) => Promise<DialogResponse>
```

**Parameters**

- **`config`** (`DialogRequestConfig`, required)
  Settings for displaying a dialog.

**Returns**: `Promise<DialogResponse>`

## Related types

- [DialogRequestConfig](https://docs.interop.io/desktop/reference/javascript/modals/dialogrequestconfig/index.md)
- [DialogResponse](https://docs.interop.io/desktop/reference/javascript/modals/dialogresponse/index.md)