From 51ea238b49643140fd087005b597a311426dd6a4 Mon Sep 17 00:00:00 2001 From: Cory Rivera Date: Wed, 13 Sep 2023 16:12:45 -0700 Subject: [PATCH] Add comments for openFileBrowser (#24413) --- src/sql/azdata.d.ts | 7 +++++++ src/sql/azdata.proposed.d.ts | 8 ++++++++ 2 files changed, 15 insertions(+) diff --git a/src/sql/azdata.d.ts b/src/sql/azdata.d.ts index afa65705bc..b4a5967fc3 100644 --- a/src/sql/azdata.d.ts +++ b/src/sql/azdata.d.ts @@ -2273,6 +2273,13 @@ declare module 'azdata' { // File browser interfaces ----------------------------------------------------------------------- export interface FileBrowserProvider extends DataProvider { + /** + * Opens a file browser for selecting file paths on a local or remote machine. + * @param ownerUri The connection URI of the machine whose files are to be browsed. + * @param expandPath The initial path to open in the file browser. + * @param fileFilters The list of filters to apply to the file browser (e.g. '*.sql' for SQL files). Ignored if showFoldersOnly is set to true. + * @param changeFilter Whether to update the list of file filters from the last time the dialog was opened for this connection URI. + */ openFileBrowser(ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean): Thenable; /** * Registers a handler for FileBrowserOpened events. diff --git a/src/sql/azdata.proposed.d.ts b/src/sql/azdata.proposed.d.ts index 3e5553f6c3..9cd09d54b1 100644 --- a/src/sql/azdata.proposed.d.ts +++ b/src/sql/azdata.proposed.d.ts @@ -2075,6 +2075,14 @@ declare module 'azdata' { } export interface FileBrowserProvider extends DataProvider { + /** + * Opens a file browser for selecting file paths on a local or remote machine. + * @param ownerUri The connection URI of the machine whose files are to be browsed. + * @param expandPath The initial path to open in the file browser. + * @param fileFilters The list of filters to apply to the file browser (e.g. '*.sql' for SQL files). Ignored if showFoldersOnly is set to true. + * @param changeFilter Whether to update the list of file filters from the last time the dialog was opened for this connection URI. + * @param showFoldersOnly (Optional) Whether to only show folders in the file browser. Default value is false. + */ openFileBrowser(ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean, showFoldersOnly?: boolean): Thenable; }