Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add comments for openFileBrowser #24413

Merged
merged 2 commits into from
Sep 13, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
corivera marked this conversation as resolved.
Show resolved Hide resolved
*/
openFileBrowser(ownerUri: string, expandPath: string, fileFilters: string[], changeFilter: boolean, showFoldersOnly?: boolean): Thenable<boolean>;
}

Expand Down