Skip to main content

Interface: BackgroundTaskDescriptor

Defined in: Extensions/ExtensionApiDtos.ts:959

Properties​

cancellable?​

optional cancellable?: boolean

Defined in: Extensions/ExtensionApiDtos.ts:966

Default true.

concurrency?​

optional concurrency?: "join" | "reject"

Defined in: Extensions/ExtensionApiDtos.ts:978

description?​

optional description?: LocalizedString

Defined in: Extensions/ExtensionApiDtos.ts:964

Optional longer description shown in the task panel.

id​

id: string

Defined in: Extensions/ExtensionApiDtos.ts:961

Namespaced 'ext..'. Used as a stable ID for cancel/resume.

notifyOnComplete?​

optional notifyOnComplete?: boolean

Defined in: Extensions/ExtensionApiDtos.ts:970

Default false.

showInStatusBar?​

optional showInStatusBar?: boolean

Defined in: Extensions/ExtensionApiDtos.ts:968

Default true.

singleton?​

optional singleton?: boolean

Defined in: Extensions/ExtensionApiDtos.ts:977

If set, only one task with this id may run at a time. A second call with the same id either rejects or joins the running task, per concurrency.

title​

title: LocalizedString

Defined in: Extensions/ExtensionApiDtos.ts:962

workEndpoint​

workEndpoint: string

Defined in: Extensions/ExtensionApiDtos.ts:972

Reverse-RPC endpoint name the host calls to do the work.