Class ProfileStore

Index

Constructors

Methods

watchExternalChanges checkForExternalChanges onDidChange listProfiles listProfilesSync getProfile upsertProfile removeProfile getActiveProfileId setActiveProfileId listSavedQueries saveQuery removeSavedQuery

Constructors

constructor

new ProfileStore(globalState: Memento, workspaceState: Memento): ProfileStore
Parameters
- globalState: Memento
- workspaceState: Memento
Returns ProfileStore
- Defined in services/profileStore.ts:17

Methods

watchExternalChanges

watchExternalChanges(): { dispose(): void }
Memento has no public change event; observe updates delivered from other VS Code windows.

Returns { dispose(): void }
- Defined in services/profileStore.ts:29

checkForExternalChanges

checkForExternalChanges(): void
Returns void
- Defined in services/profileStore.ts:35

onDidChange

onDidChange(listener: () => void): { dispose(): void }
Calls listener after profiles are added, changed or removed, or the active profile changes.
Parameters
- listener: () => void
Returns { dispose(): void }
- Defined in services/profileStore.ts:42

listProfiles

listProfiles(): Promise<ConnectionProfile[]>
Returns Promise<ConnectionProfile[]>
- Defined in services/profileStore.ts:58

listProfilesSync

listProfilesSync(): ConnectionProfile[]
The stored profiles without waiting; a webview needs them before its first paint.

Returns ConnectionProfile[]
- Defined in services/profileStore.ts:63

getProfile

getProfile(id: string): Promise<ConnectionProfile | undefined>
Parameters
- id: string
Returns Promise<ConnectionProfile | undefined>
- Defined in services/profileStore.ts:74

upsertProfile

upsertProfile(profile: ConnectionProfile): Promise<void>
Parameters
- profile: ConnectionProfile
Returns Promise<void>
- Defined in services/profileStore.ts:79

removeProfile

removeProfile(profileId: string): Promise<void>
Parameters
- profileId: string
Returns Promise<void>
- Defined in services/profileStore.ts:94

getActiveProfileId

getActiveProfileId(): string | undefined
Returns string | undefined
- Defined in services/profileStore.ts:110

setActiveProfileId

setActiveProfileId(profileId: string | undefined): Promise<void>
Parameters
- profileId: string | undefined
Returns Promise<void>
- Defined in services/profileStore.ts:114

listSavedQueries

listSavedQueries(): SavedQuery[]
Returns SavedQuery[]
- Defined in services/profileStore.ts:119

saveQuery

saveQuery(query: SavedQuery): Promise<void>
Parameters
- query: SavedQuery
Returns Promise<void>
- Defined in services/profileStore.ts:123

removeSavedQuery

removeSavedQuery(queryId: string): Promise<void>
Parameters
- queryId: string
Returns Promise<void>
- Defined in services/profileStore.ts:136