Class ProvidedTaskConfigurations

Index

Constructors

Properties

taskDefinitionRegistry taskProviderRegistry tasksMap

Methods

activateProviders cacheTasks getCachedTask getTask getTasks getTaskToCustomize isTaskProviderActivationNeeded pushActivatedProvidersType refreshTasks resolveTaskConfigurations startUserAction updateUserAction

Constructors

constructor

new ProvidedTaskConfigurations(): ProvidedTaskConfigurations
Returns ProvidedTaskConfigurations

Properties

`Protected` `Readonly`taskDefinitionRegistry

taskDefinitionRegistry: TaskDefinitionRegistry

`Protected` `Readonly`taskProviderRegistry

taskProviderRegistry: TaskProviderRegistry

`Protected`tasksMap

tasksMap: Map<string, Map<string, Map<undefined | string, TaskConfiguration>>> = ...

Map of source (name of extension, or path of root folder that the task config comes from) and task config map. For the second level of inner map, the key is task label. For the third level of inner map, the key is the task scope and value TaskConfiguration.

Methods

`Protected`activateProviders

activateProviders(taskType?: string): Promise<void>
Activate providers for the given taskType
Parameters
- OptionaltaskType: string
  A specific task type or '*' to indicate all task providers
Returns Promise<void>
- Defined in packages/task/src/browser/provided-task-configurations.ts:71

`Protected`cacheTasks

cacheTasks(tasks: TaskConfiguration[]): void
Parameters
- tasks: TaskConfiguration[]
Returns void
- Defined in packages/task/src/browser/provided-task-configurations.ts:189

`Protected`getCachedTask

getCachedTask(
    source: string,
    taskLabel: string,
    scope?: TaskConfigurationScope,
): undefined | TaskConfiguration
Parameters
- source: string
- taskLabel: string
- Optionalscope: TaskConfigurationScope
Returns undefined | TaskConfiguration
- Defined in packages/task/src/browser/provided-task-configurations.ts:176

getTask

getTask(
    token: number,
    source: string,
    taskLabel: string,
    scope: TaskConfigurationScope,
): Promise<undefined | TaskConfiguration>
returns the task configuration for a given source and label or undefined if none
Parameters
- token: number
- source: string
- taskLabel: string
- scope: TaskConfigurationScope
Returns Promise<undefined | TaskConfiguration>
- Defined in packages/task/src/browser/provided-task-configurations.ts:124

getTasks

getTasks(token: number, type?: string): Promise<TaskConfiguration[]>
returns a list of provided tasks matching an optional given type, or all if '*' is used
Parameters
- token: number
- Optionaltype: string
Returns Promise<TaskConfiguration[]>
- Defined in packages/task/src/browser/provided-task-configurations.ts:79

getTaskToCustomize

getTaskToCustomize(
    token: number,
    customization: TaskCustomization,
    scope: TaskConfigurationScope,
): Promise<undefined | TaskConfiguration>
Finds the detected task for the given task customization. The detected task is considered as a "match" to the task customization if it has all the required properties. In case that more than one customization is found, return the one that has the biggest number of matched properties.
Parameters
- token: number
- customization: TaskCustomization
  the task customization
- scope: TaskConfigurationScope
Returns Promise<undefined | TaskConfiguration>
the detected task for the given task customization. If the task customization is not found, undefined is returned.
- Defined in packages/task/src/browser/provided-task-configurations.ts:137

`Protected`isTaskProviderActivationNeeded

isTaskProviderActivationNeeded(taskType?: string): boolean
Parameters
- OptionaltaskType: string
Returns boolean
- Defined in packages/task/src/browser/provided-task-configurations.ts:60

`Protected`pushActivatedProvidersType

pushActivatedProvidersType(taskType: string): void
Parameters
- taskType: string
Returns void
- Defined in packages/task/src/browser/provided-task-configurations.ts:54

`Protected`refreshTasks

refreshTasks(token: number, taskType?: string): Promise<void>
Parameters
- token: number
- OptionaltaskType: string
Returns Promise<void>
- Defined in packages/task/src/browser/provided-task-configurations.ts:94

`Protected`resolveTaskConfigurations

resolveTaskConfigurations(
taskProvider: TaskProvider,
): Promise<TaskConfiguration[]>
Parameters
- taskProvider: TaskProvider
Returns Promise<TaskConfiguration[]>
- Defined in packages/task/src/browser/provided-task-configurations.ts:107

startUserAction

startUserAction(): number
Returns number
- Defined in packages/task/src/browser/provided-task-configurations.ts:43

`Protected`updateUserAction

updateUserAction(token: number): void
Parameters
- token: number
Returns void
- Defined in packages/task/src/browser/provided-task-configurations.ts:47

Class ProvidedTaskConfigurations

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ProvidedTaskConfigurations

Properties

Protected ReadonlytaskDefinitionRegistry

Protected ReadonlytaskProviderRegistry

ProtectedtasksMap

Methods

ProtectedactivateProviders

Parameters

Returns Promise<void>

ProtectedcacheTasks

Parameters

Returns void

ProtectedgetCachedTask

Parameters

Returns undefined | TaskConfiguration

getTask

Parameters

Returns Promise<undefined | TaskConfiguration>

getTasks

Parameters

Returns Promise<TaskConfiguration[]>

getTaskToCustomize

Parameters

Returns Promise<undefined | TaskConfiguration>

ProtectedisTaskProviderActivationNeeded

Parameters

Returns boolean

ProtectedpushActivatedProvidersType

Parameters

Returns void

ProtectedrefreshTasks

Parameters

Returns Promise<void>

ProtectedresolveTaskConfigurations

Parameters

Returns Promise<TaskConfiguration[]>

startUserAction

Returns number

ProtectedupdateUserAction

Parameters

Returns void

Settings

On This Page

`Protected` `Readonly`taskDefinitionRegistry

`Protected` `Readonly`taskProviderRegistry

`Protected`tasksMap

`Protected`activateProviders

`Protected`cacheTasks

`Protected`getCachedTask

`Protected`isTaskProviderActivationNeeded

`Protected`pushActivatedProvidersType

`Protected`refreshTasks

`Protected`resolveTaskConfigurations

`Protected`updateUserAction