IBuildController Interface

Represents a build controller in the TFS Build server.

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

Top

Methods

Name Description
Public method AddBuildAgent Adds a build agent to this build controller.
Public method Delete Deletes this build controller.
Public method 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.
Public method 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.
Public method Refresh(Boolean) Refreshes the build controller by getting current property values from the build server.
Public method Refresh(array<String[], Boolean) Refreshes the build controller by getting current property values from the build server.
Public method RemoveBuildAgent Removes a build agent from this controller.
Public method Save Saves changes that were made to this build controller to the build server.

Top

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace