Class QuickConnectProfileProvider<P> Abstract

Type Parameters

P extends ConnectableProfile

Hierarchy

ConnectableProfileProvider<P>
- QuickConnectProfileProvider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new QuickConnectProfileProvider<P>(): QuickConnectProfileProvider<P>

Inherited from ConnectableProfileProvider.constructor
Type Parameters
- P extends ConnectableProfile
Returns QuickConnectProfileProvider<P>

Properties

configDefaults

configDefaults: {} = {}

Type declaration

id

id: string

name

name: string

Optional settingsComponent

settingsComponent?: (new (...args: any[]) => ProfileSettingsComponent<P>)

Type declaration

- new (...args: any[]): ProfileSettingsComponent<P>
- Parameters
  - Rest ...args: any[]
  Returns ProfileSettingsComponent<P>

Methods

deleteProfile

deleteProfile(profile: P): void

Inherited from ConnectableProfileProvider.deleteProfile
- Defined in tabby-core/src/api/profileProvider.ts:74
Parameters
- profile: P
Returns void

Abstract getBuiltinProfiles

getBuiltinProfiles(): Promise<PartialProfile<P>[]>

Inherited from ConnectableProfileProvider.getBuiltinProfiles
- Defined in tabby-core/src/api/profileProvider.ts:64
Returns Promise<PartialProfile<P>[]>

Abstract getDescription

getDescription(profile: PartialProfile<P>): string

Inherited from ConnectableProfileProvider.getDescription
- Defined in tabby-core/src/api/profileProvider.ts:72
Parameters
- profile: PartialProfile<P>
Returns string

Abstract getNewTabParameters

getNewTabParameters(profile: P): Promise<NewTabParameters<BaseTabComponent>>

Inherited from ConnectableProfileProvider.getNewTabParameters
- Defined in tabby-core/src/api/profileProvider.ts:66
Parameters
- profile: P
Returns Promise<NewTabParameters<BaseTabComponent>>

getSuggestedName

getSuggestedName(profile: PartialProfile<P>): null | string

Inherited from ConnectableProfileProvider.getSuggestedName
- Defined in tabby-core/src/api/profileProvider.ts:68
Parameters
- profile: PartialProfile<P>
Returns null | string

Abstract intoQuickConnectString

intoQuickConnectString(profile: P): null | string

- Defined in tabby-core/src/api/profileProvider.ts:83
Parameters
- profile: P
Returns null | string

Abstract quickConnect

quickConnect(query: string): null | PartialProfile<P>

- Defined in tabby-core/src/api/profileProvider.ts:81
Parameters
- query: string
Returns null | PartialProfile<P>

Generated using TypeDoc