IBuildController Interface

Interface for a build controller in the server that is running Team Foundation Build.

Namespace:  Microsoft.TeamFoundation.Build.Client
Assembly:  Microsoft.TeamFoundation.Build.Client (in Microsoft.TeamFoundation.Build.Client.dll)

Syntax

'Declaration
Public Interface IBuildController

public interface IBuildController

public interface class IBuildController

type IBuildController =  interface end

public interface IBuildController

The IBuildController type exposes the following members.

Properties

	Name	Description
	Agents	Gets the build agents that are owned by this build controller.
	AttachedProperties	Attached properties
	CustomAssemblyPath	Gets or sets the version control path where custom assemblies are stored.
	DateCreated	Gets the date and time that this build controller was created.
	DateUpdated	Gets the date and time that this build controller was last updated.
	Description	Gets or sets the description of this build controller.
	Enabled	Gets or sets a flag that describes whether this build controller is enabled.
	MaxConcurrentBuilds	Gets or sets the maximum number of builds that may run at the same time on this build controller.
	MessageQueueUrl	Gets the message queue address. This field is for system use only.
	Name	Gets or sets the name of this build controller.
	QueueCount	Gets the current queue count for this build controller.
	ServiceHost	Gets the service host in which this build controller resides.
	Status	Gets or sets the status of this build controller.
	StatusMessage	Gets or sets a displayable message from the server about the status of this controller. May be empty.
	Tags	Gets a read-only collection of tags for all the agents of this controller.
	Uri	Gets the uniform resource identifier (URI) of this build controller.
	Url	Gets the URL of this build controller.

Top

Methods

	Name	Description
	AddBuildAgent	Adds a build agent to this build controller.
	Delete	Deletes this build controller.
	LoadCustomActivities	Downloads all assemblies from the CustomAssemblyLocation to the local path, loads the assemblies that contain custom activity types, and returns a list of the custom activity types.
	LoadCustomActivitiesAndExtensions	Downloads all assemblies from the CustomAssemblyLocation to the local path, loads the assemblies that contain custom activity and extension types, and returns a list of the custom activity and extension types.
	Refresh(Boolean)	Refreshes the build controller by getting current property values from the build server.
	Refresh(array<String[], Boolean)	Refreshes the build controller by getting current property values from the build server.
	RemoveBuildAgent	Removes a build agent from this controller.
	Save	Saves changes that were made to this build controller to the build server.

Top

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace