Share via


IBuildService Interface

Definition

Provides support for build related operations. Obtain this using BuildService.

public interface class IBuildService
public interface IBuildService
type IBuildService = interface
Public Interface IBuildService

Remarks

The interface provides the following:

1. Methods for invoking a BuildAction on a list of buildables or all.

2. An event for build availability change.

A buildable is defined as a project in a solution, or a buildable target in a folder.

Methods

BuildAsync(BuildAction, IReadOnlyList<String>, IProgress<Int32>, CancellationToken)

Invokes the BuildAction on a list of buildable items.

LaunchAsync(String, String, String, IProgress<Int32>, CancellationToken)

Builds and launches the requested buildable.

RequestBuildEventsAsync(CancellationToken)

Request that build events be raised. If this method is not called, instances of IBuildService will not raise the BuildableItemsChanged, BuildStarted, or BuildEnded events.

RequestBuildProgressChangedEventsAsync(CancellationToken)

Request that BuildProgressChanged events be raised. If this method is not called, instances of IBuildService will not raise the BuildProgressChanged event.

StartBuildOperationAsync(BuildAction, Guid, IReadOnlyList<String>, IProgress<Int32>, CancellationToken)

Invokes the BuildAction on a list of buildable items.

StartLaunchOperationAsync(Guid, String, String, String, IProgress<Int32>, CancellationToken)

Builds and launches the requested buildable.

Events

BuildableItemsChanged

Raised when a change occurs in the set of buildable items.

BuildEnded

Raised when a build operation ends.

BuildProgressChanged

Raised when the build progress changes.

BuildStarted

Raised when a build operation begins.

Applies to