ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-17 11:01:37 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add comments for openFileBrowser (#24413)

Browse Source
This commit is contained in:
Cory Rivera
2023-09-13 16:12:45 -07:00
committed by GitHub
parent c3b8c97b9d
commit 51ea238b49
2 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/sql/azdata.d.ts vendored
View File

@@ -2273,6 +2273,13 @@ declare module 'azdata' {
// File browser interfaces ----------------------------------------------------------------------- // File browser interfaces -----------------------------------------------------------------------
export interface FileBrowserProvider extends DataProvider { 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<boolean>; openFileBrowser(ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean): Thenable<boolean>;
/** /**
* Registers a handler for FileBrowserOpened events. * Registers a handler for FileBrowserOpened events.

8
src/sql/azdata.proposed.d.ts vendored
View File

@@ -2075,6 +2075,14 @@ declare module 'azdata' {
} }
export interface FileBrowserProvider extends DataProvider { 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<boolean>; openFileBrowser(ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean, showFoldersOnly?: boolean): Thenable<boolean>;
} }