Reference API for new dialog and exec.close() APIs

Signed-off-by: Guillaume Tardif <guillaume.tardif@gmail.com>

Author: gtardif

docs/dev/api/reference/README.md

@@ -13,9 +13,12 @@
 - [ExecResultV0](interfaces/ExecResultV0.md)
 - [RequestConfigV0](interfaces/RequestConfigV0.md)
 - [BackendV0](interfaces/BackendV0.md)
+- [OpenDialogResult](interfaces/OpenDialogResult.md)
+- [Dialog](interfaces/Dialog.md)
 - [Docker](interfaces/Docker.md)
 - [DockerCommand](interfaces/DockerCommand.md)
 - [Exec](interfaces/Exec.md)
+- [ExecProcess](interfaces/ExecProcess.md)
 - [ExecStreamOptions](interfaces/ExecStreamOptions.md)
 - [ExecResult](interfaces/ExecResult.md)
 - [RawExecResult](interfaces/RawExecResult.md)

docs/dev/api/reference/interfaces/DesktopUI.md

@@ -5,6 +5,7 @@
 ### Properties
 
 - [toast](DesktopUI.md#toast)
+- [dialog](DesktopUI.md#dialog)
 - [navigate](DesktopUI.md#navigate)
 
 ## Properties
@@ -15,6 +16,12 @@
 
 ___
 
+### dialog
+
+• `Readonly` **dialog**: [`Dialog`](Dialog.md)
+
+___
+
 ### navigate
 
 • `Readonly` **navigate**: [`NavigationIntents`](NavigationIntents.md)

docs/dev/api/reference/interfaces/Dialog.md

@@ -0,0 +1,31 @@
+# Interface: Dialog
+
+Allows to open native dialog boxes.
+
+## Table of contents
+
+### Methods
+
+- [showOpenDialog](Dialog.md#showopendialog)
+
+## Methods
+
+### showOpenDialog
+
+▸ **showOpenDialog**(`dialogProperties`): `Promise`<[`OpenDialogResult`](OpenDialogResult.md)\>
+
+Display a native open dialog, allowing to select a file or a folder.
+
+```typescript
+ddClient.desktopUI.dialog.showOpenDialog({properties: ['openFile']});
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `dialogProperties` | `any` | properties to specify the open dialog behaviour, see https://www.electronjs.org/docs/latest/api/dialog#dialogshowopendialogbrowserwindow-options. |
+
+#### Returns
+
+`Promise`<[`OpenDialogResult`](OpenDialogResult.md)\>

docs/dev/api/reference/interfaces/Exec.md

@@ -23,7 +23,7 @@ A promise that will resolve once the command finishes.
 
 ### Exec
 
-▸ **Exec**(`cmd`, `args`, `options`): `void`
+▸ **Exec**(`cmd`, `args`, `options`): [`ExecProcess`](ExecProcess.md)
 
 Streams the result of a command if `stream` is specified in the `options` parameter.
 
@@ -40,4 +40,4 @@ Specify the `stream` if the output of your command is too long or if you need to
 
 #### Returns
 
-`void`
+[`ExecProcess`](ExecProcess.md)

docs/dev/api/reference/interfaces/ExecProcess.md

@@ -0,0 +1,19 @@
+# Interface: ExecProcess
+
+## Table of contents
+
+### Methods
+
+- [close](ExecProcess.md#close)
+
+## Methods
+
+### close
+
+▸ **close**(): `void`
+
+Close the process started by exec(streamingOptions)
+
+#### Returns
+
+`void`

docs/dev/api/reference/interfaces/OpenDialogResult.md

@@ -0,0 +1,33 @@
+# Interface: OpenDialogResult
+
+## Table of contents
+
+### Properties
+
+- [canceled](OpenDialogResult.md#canceled)
+- [filePaths](OpenDialogResult.md#filepaths)
+- [bookmarks](OpenDialogResult.md#bookmarks)
+
+## Properties
+
+### canceled
+
+• `Readonly` **canceled**: `boolean`
+
+whether or not the dialog was canceled.
+
+___
+
+### filePaths
+
+• `Readonly` **filePaths**: `string`[]
+
+An array of file paths chosen by the user. If the dialog is cancelled this will be an empty array.
+
+___
+
+### bookmarks
+
+• `Optional` `Readonly` **bookmarks**: `string`[]
+
+macOS only- An array matching the filePaths array of base64 encoded strings which contains security scoped bookmark data. securityScopedBookmarks must be enabled for this to be populated