Export (0) Print
Expand All

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)

public interface class IBuildDetail

The IBuildDetail type exposes the following members.

  NameDescription
Public propertyBuildControllerGets the build controller used to perform this build. May be null.
Public propertyBuildControllerUriGets the URI of the build controller used to perform this build.
Public propertyBuildDefinitionGets the build definition that owns this build. May be null.
Public propertyBuildDefinitionUriGets the URI of the build definition used to perform this build.
Public propertyBuildFinishedGets a flag indicating whether the build has finished.
Public propertyBuildNumberGets or sets the number for this build.
Public propertyBuildServerGets the server that owns this build.
Public propertyCompilationStatusGets or sets the status of the compilation phase of this build.
Public propertyContainerIdGets the ContainerId for the container associated with this BuildDetail
Public propertyDropLocationGets or sets the location for the output of the build.
Public propertyDropLocationRootGets the root drop location of the build.
Public propertyFinishTimeGets the time that this build finished.
Public propertyInformationGets the collection of information nodes for this build.
Public propertyIsDeletedGets a flag describing whether the build has been deleted.
Public propertyKeepForeverGets or sets a flag describing whether the build participates in the retention policy of the build definition or to keep the build forever.
Public propertyLabelNameGets or sets the name of the label created for the build.
Public propertyLastChangedByGets the last user to change this build.
Public propertyLastChangedByDisplayNameGets the display name of the last user to change the build.
Public propertyLastChangedOnGets the date and time of the last change to this build.
Public propertyLogLocationGets or sets the location of the log file for this build.
Public propertyProcessParametersGets an XML formatted string representing all the process parameters for this build.
Public propertyQualityGets or sets the quality of this build.
Public propertyReasonGets the reason the build exists. For more information about the use of this property, see Specify build triggers and reasons
Public propertyRequestedByGets the user who requested this build.
Public propertyRequestedForGets the user for whom this build was requested.
Public propertyRequestIdsThe request Ids that started this build.
Public propertyRequestsThe requests that started this build.
Public propertyShelvesetNameGets the shelveset that was built.
Public propertySourceGetVersionGets or sets the version specification for which the sources were retrieved for this build.
Public propertyStartTimeGets the time that this build actually started.
Public propertyStatusGets or sets the overall status of this build.
Public propertyTeamProjectGets the team project that owns this build.
Public propertyTestStatusGets or sets the status of the test phase of this build.
Public propertyUriGets the URI of this build.
Top

  NameDescription
Public methodConnect()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 methodConnect(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 methodConnect(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 methodDelete()Deletes the build, and all associated data, from the server and drop location.
Public methodDelete(DeleteOptions)Delete the build and only the specified information.
Public methodDisconnectStops polling the server.
Public methodFinalizeStatus()Notifies the server that the build is finished.
Public methodFinalizeStatus(BuildStatus)Notifies the server that the build is complete and sets the status accordingly.
Public methodRefreshRetrieves the latest build data from the server that has the specified query options and information types.
Public methodRefreshAllDetailsRetrieves the latest build data from the server together with all details.
Public methodRefreshMinimalDetailsRetrieves the latest build data from the server together with no details.
Public methodRequestIntermediateLogsRequests the intermediate diagnostics logs of an in-progress build.
Public methodSaveSaves any changes that were made on the build to the server.
Public methodStopStops the build.
Public methodWait()Blocks additional builds until this build is finished.
Public methodWait(TimeSpan, TimeSpan)Blocks the calling thread until the build finishes or the time-out expires.
Public methodWait(TimeSpan, TimeSpan, ISynchronizeInvoke)Blocks the calling thread until the build finishes or the time-out expires.
Top

  NameDescription
Public eventPollingCompletedRaised when polling finishes.
Public eventStatusChangedRaised when any change in the build is discovered on the server.
Public eventStatusChangingRaised when any change in the build is discovered on the server.
Top
Show:
© 2014 Microsoft