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

Top

Methods

Name Description
Public method 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.
Public method 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.
Public method 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.
Public method Delete() Deletes the build, and all associated data, from the server and drop location.
Public method Delete(DeleteOptions) Delete the build and only the specified information.
Public method Disconnect Stops polling the server.
Public method FinalizeStatus() Notifies the server that the build is finished.
Public method FinalizeStatus(BuildStatus) Notifies the server that the build is complete and sets the status accordingly.
Public method Refresh Retrieves the latest build data from the server that has the specified query options and information types.
Public method RefreshAllDetails Retrieves the latest build data from the server together with all details.
Public method RefreshMinimalDetails Retrieves the latest build data from the server together with no details.
Public method RequestIntermediateLogs Requests the intermediate diagnostics logs of an in-progress build.
Public method Save Saves any changes that were made on the build to the server.
Public method Stop Stops the build.
Public method Wait() Blocks additional builds until this build is finished.
Public method Wait(TimeSpan, TimeSpan) Blocks the calling thread until the build finishes or the time-out expires.
Public method Wait(TimeSpan, TimeSpan, ISynchronizeInvoke) Blocks the calling thread until the build finishes or the time-out expires.

Top

Events

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

Top

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace