Skip to content

Commit

Permalink
Add comments for openFileBrowser (#24413)
Browse files Browse the repository at this point in the history
  • Loading branch information
corivera authored and siyangMicrosoft committed Oct 12, 2023
1 parent ffad831 commit cc4c9c5
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/sql/azdata.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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<boolean>;
/**
* Registers a handler for FileBrowserOpened events.
Expand Down
8 changes: 8 additions & 0 deletions src/sql/azdata.proposed.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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<boolean>;
}

Expand Down

0 comments on commit cc4c9c5

Please sign in to comment.