Export (0) Print
Expand All

IQueuedBuild Interface

The interface for a queued build on the server that is running Team Foundation Build.

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

public interface IQueuedBuild : IComparable<IQueuedBuild>

The IQueuedBuild type exposes the following members.

  NameDescription
Public propertyBatchIdThe batch ID of the queued build.
Public propertyBuildGets the build in progress associated with this queued build.
Public propertyBuildControllerGets the build controller on which this queued build will be built.
Public propertyBuildControllerUriGets the URI of the build controller on which this queued build will be built.
Public propertyBuildDefinitionGets the build definition for which this queued build will be built.
Public propertyBuildDefinitionUriGets the URI of the build definition for which this queued build will be built.
Public propertyBuildsGets the collection of builds for this queue entry.
Public propertyBuildServerGets the server that owns this queued build.
Public propertyCustomGetVersionGets the time for which sources should be retrieved for the queued build.
Public propertyDropLocationGets the location where to drop the outputs of the queued build.
Public propertyGetOptionGets the time for which sources should be retrieved for the queued build.
Public propertyIdGets the ID of this queued build.
Public propertyPriorityGets or sets the priority of this queued build.
Public propertyProcessParametersGets the process parameters that were used for this build.
Public propertyQueuePositionGets the current position of the build in the queue.
Public propertyQueueTimeGets the time when the build was queued.
Public propertyReasonGets the reason that the build was queued.
Public propertyRequestedByGets the user who requested the queued build.
Public propertyRequestedByDisplayNameGets the display name of the user who requested the build.
Public propertyRequestedForGets the user for whom the queued build was requested.
Public propertyRequestedForDisplayNameGets the display name of the user for whom the build was requested.
Public propertyShelvesetNameGets the shelveset that will be built.
Public propertyStatusGets the status of the queued build.
Public propertyTeamProjectGets the team project that owns this queued build.
Top

  NameDescription
Public methodCancelRemoves this build from the queue.
Public methodCompareToCompares the current object with another object of the same type. (Inherited from IComparable<IQueuedBuild>.)
Public methodConnect()Starts polling, by using the default interval of five seconds and no synchronization object. Events will be fired on a thread pool thread. 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, Int32, ISynchronizeInvoke)Starts polling, by using the specified interval and ISynchronizeInvoke object. When the 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 methodCopyCopies the data from the specified queued build into the current instance. The return value indicates whether anything in the queued build was actually updated that would effect state.
Public methodDisconnectStops polling.
Public methodPostponePostpones this queued build.
Public methodRefreshGets the latest property values from the server.
Public methodResumeResumes the queued build.
Public methodRetry()Marks the build for retry without batching. If batching with other builds is desired see IBuildServer.RetryQueuedBuilds.
Public methodRetry(Guid)Marks the build for retry and puts it in the specified batch.
Public methodRetry(Guid, QueuedBuildRetryOption)Marks the build for retry and puts it in the specified batch with the specified retry option.
Public methodSaveSends any changes that were made on the queued build to the server.
Public methodStartNowStarts the queued build if its definition is currently paused.
Public methodWaitBlocks until the queued build is completed.
Public methodWaitForBuildCompletion(TimeSpan, TimeSpan)Blocks the calling thread until the build finishes or the time-out expires.
Public methodWaitForBuildCompletion(TimeSpan, TimeSpan, ISynchronizeInvoke)Blocks the calling thread until the build finishes or the time-out expires.
Public methodWaitForBuildStart()Blocks the build from starting by using the default polling interval of five seconds and an infinite time-out. When this method exits, the Build property will not be null.
Public methodWaitForBuildStart(Int32, Int32)Blocks the build from starting by using the specified polling interval and time-out.
Top

  NameDescription
Public eventPollingCompletedRaised when polling finishes. Note: to receive this event you must call the Connect method. This event is fired when polling finishes, either because the queued build finished or because an unrecoverable error was encountered (e.g. the queued build was deleted).
Public eventStatusChangedRaised when any change in the queued build is discovered on the server. Note: to receive these events you must call the Connect method. This causes the server to be polled regularly until the queued build is completed. This event is fired just after the queued build is updated.
Top
Show:
© 2014 Microsoft