IBuildDetail Interface

Interface for a build on the server that is running Team Foundation Build. For more information about how to use this interface, see Manage Build Information and Control Verbosity or Team Foundation Build Activities.

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

Syntax

'Declaration
Public Interface IBuildDetail

public interface IBuildDetail

public interface class IBuildDetail

type IBuildDetail =  interface end

public interface IBuildDetail

The IBuildDetail type exposes the following members.

Properties

	Name	Description
	BuildController	Gets the build controller used to perform this build. May be null.
	BuildControllerUri	Gets the URI of the build controller used to perform this build.
	BuildDefinition	Gets the build definition that owns this build. May be null.
	BuildDefinitionUri	Gets the URI of the build definition used to perform this build.
	BuildFinished	Gets a flag indicating whether the build has finished.
	BuildNumber	Gets or sets the number for this build.
	BuildServer	Gets the server that owns this build.
	CompilationStatus	Gets or sets the status of the compilation phase of this build.
	DropLocation	Gets or sets the location for the output of the build.
	DropLocationRoot	Gets the root drop location of the build.
	FinishTime	Gets the time that this build finished.
	Information	Gets the collection of information nodes for this build.
	IsDeleted	Gets a flag describing whether the build has been deleted.
	KeepForever	Gets or sets a flag describing whether the build participates in the retention policy of the build definition or to keep the build forever.
	LabelName	Gets or sets the name of the label created for the build.
	LastChangedBy	Gets the last user to change this build.
	LastChangedByDisplayName	Gets the display name of the last user to change the build.
	LastChangedOn	Gets the date and time of the last change to this build.
	LogLocation	Gets or sets the location of the log file for this build.
	ProcessParameters	Gets an XML formatted string representing all the process parameters for this build.
	Quality	Gets or sets the quality of this build.
	Reason	Gets the reason the build exists. For more information about the use of this property, see Specify Build Triggers and Reasons
	RequestedBy	Gets the user who requested this build.
	RequestedFor	Gets the user for whom this build was requested.
	RequestIds	The request Ids that started this build.
	Requests	The requests that started this build.
	ShelvesetName	Gets the shelveset that was built.
	SourceGetVersion	Gets or sets the version specification for which the sources were retrieved for this build.
	StartTime	Gets the time that this build actually started.
	Status	Gets or sets the overall status of this build.
	TeamProject	Gets the team project that owns this build.
	TestStatus	Gets or sets the status of the test phase of this build.
	Uri	Gets the URI of this build.

Top

Methods

	Name	Description
	Connect()	Starts polling by using the default interval of five seconds and no synchronization object. When events are handled by a visual Windows Forms component, the other overload should be used for this method and that component should be passed in as the synchronizingObject so that the event handlers are called on the same thread on which the component was created.
	Connect(Int32, ISynchronizeInvoke)	Starts polling by using the specified interval and ISynchronizeInvoke object. When the StatusChanging, StatusChanged, or PollingCompleted events are handled by a visual Windows Forms component, that component should be passed in as the synchronizingObject so that the event handlers are called on the same thread on which the component was created.
	Connect(Int32, Int32, ISynchronizeInvoke)	Starts polling, using the specified interval, time-out and ISynchronizeInvoke object. When the StatusChanging, StatusChanged, or PollingCompleted events are handled by a visual Windows Forms component, that component should be passed in as the synchronizingObject so that the event handlers are called on the same thread on which the component was created.
	Delete()	Deletes the build, and all associated data, from the server and drop location.
	Delete(DeleteOptions)	Delete the build and only the specified information.
	Disconnect	Stops polling the server.
	FinalizeStatus()	Notifies the server that the build is finished.
	FinalizeStatus(BuildStatus)	Notifies the server that the build is complete and sets the status accordingly.
	Refresh	Retrieves the latest build data from the server that has the specified query options and information types.
	RefreshAllDetails	Retrieves the latest build data from the server together with all details.
	RefreshMinimalDetails	Retrieves the latest build data from the server together with no details.
	RequestIntermediateLogs	Requests the intermediate diagnostics logs of an in-progress build.
	Save	Saves any changes that were made on the build to the server.
	Stop	Stops the build.
	Wait()	Blocks additional builds until this build is finished.
	Wait(TimeSpan, TimeSpan)	Blocks the calling thread until the build finishes or the time-out expires.
	Wait(TimeSpan, TimeSpan, ISynchronizeInvoke)	Blocks the calling thread until the build finishes or the time-out expires.

Top

Events

	Name	Description
	PollingCompleted	Raised when polling finishes.
	StatusChanged	Raised when any change in the build is discovered on the server.
	StatusChanging	Raised when any change in the build is discovered on the server.

Top

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace