InformationNodeConverters Class

  • Article

Provides methods to convert IBuildInformationNode objects to more specific types.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Build.Client.InformationNodeConverters

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

Syntax

'Declaration
<ExtensionAttribute> _
Public NotInheritable Class InformationNodeConverters

public static class InformationNodeConverters

[ExtensionAttribute]
public ref class InformationNodeConverters abstract sealed

[<AbstractClass>]
[<Sealed>]
type InformationNodeConverters =  class end

public final class InformationNodeConverters

The InformationNodeConverters type exposes the following members.

Methods

  Name Description
Public methodStatic member AddActivityTracking Adds an activity tracking node to the specified build information object. Does not save to the server.
Public methodStatic member AddAgentScopeActivityTracking Adds an agent scope activity tracking node to a build information object. Does not save to the server.
Public methodStatic member AddAssociatedChangesets(IBuildDetail, array<Changeset[]) Associates summaries of changesets with a build.
Public methodStatic member AddAssociatedChangesets(IBuildInformation, array<Changeset[]) Adds an array of changesets to the specified build information. Saves the modified build information to the server.
Public methodStatic member AddAssociatedWorkItems(IBuildDetail, array<WorkItem[]) Adds associated work item summaries to the specified build. Saves to the server.
Public methodStatic member AddAssociatedWorkItems(IBuildInformation, array<WorkItem[]) Adds associates summaries of work items the specified build information object. Does not save to the server.
Public methodStatic member AddBuildError(IBuildInformation, String, DateTime) Adds an error to the specified build information object. Does not save to the server.
Public methodStatic member AddBuildError(IBuildInformation, String, Int32, Int32, String, String, DateTime) Adds an error to the specified build information object. Does not save to the server.
Public methodStatic member AddBuildError(IBuildInformation, String, String, Int32, Int32, String, String, DateTime) Adds an error to the specified build information object. Does not save to the server.
Public methodStatic member AddBuildError(IBuildInformation, String, String, String, Int32, Int32, String, String, DateTime) Adds an error to the specified build information object. Does not save to the server.
Public methodStatic member AddBuildMessage Adds a message to the specified build. Does not save to the server.
Public methodStatic member AddBuildProjectNode(IBuildInformation, String, String, String, String, DateTime, String) Adds a project to the specified build information. Does not save to the server.
Public methodStatic member AddBuildProjectNode(IBuildInformation, DateTime, String, String, String, String, DateTime, String) Adds a project to the specified build information object. Does not save to the server.
Public methodStatic member AddBuildStep(IBuildDetail, String, String) Adds a top-level build step to the specified build with a start time of DateTime.Now. Saves to the server.
Public methodStatic member AddBuildStep(IBuildInformation, String, String) Adds a top-level build step to the specified build information object that has a start time of DateTime.Now. Does not save to the server.
Public methodStatic member AddBuildStep(IBuildDetail, String, String, DateTime) Adds a top-level build step to the specified build. Saves to the server.
Public methodStatic member AddBuildStep(IBuildInformation, String, String, DateTime) Adds a top-level build step to the specified build information object. Does not save to the server.
Public methodStatic member AddBuildStep(IBuildDetail, String, String, DateTime, BuildStepStatus) Adds a top-level build step to the specified build. Saves to the server.
Public methodStatic member AddBuildStep(IBuildInformation, String, String, DateTime, BuildStepStatus) Adds a top-level build step to the specified build information object. Does not save to the server.
Public methodStatic member AddBuildWarning(IBuildInformation, String, DateTime) Adds a warning to the specified build information object. Does not save to the server.
Public methodStatic member AddBuildWarning(IBuildInformation, String, Int32, Int32, String, String, DateTime) Adds a warning to the specified build information object. Does not save to the server.
Public methodStatic member AddBuildWarning(IBuildInformation, String, Int32, Int32, String, String, DateTime, String) Adds a warning to the specified build information object. Does not save to the server.
Public methodStatic member AddBuildWarning(IBuildInformation, String, String, Int32, Int32, String, String, DateTime, String) Adds a warning to the specified build information object. Does not save to the server.
Public methodStatic member AddConfigurationSummary(IBuildInformation, String, String) Adds a configuration summary to the specified build information object. Does not save to the server.
Public methodStatic member AddConfigurationSummary(IBuildDetail, String, String, String) Obsolete. Adds a configuration summary to a build.
Public methodStatic member AddCustomSummaryInformation
Public methodStatic member AddExternalLink Adds an external link to the specified build information object. Does not save to the server.
Public methodStatic member AddOpenedWorkItems(IBuildDetail, array<WorkItem[]) Adds associated opened work item summaries with the specified build. Saves to the server.
Public methodStatic member AddOpenedWorkItems(IBuildInformation, array<WorkItem[]) Adds associated open work item summaries with the specified build information object. Does not save to the server.
Public methodStatic member GetActivityTracking(IBuildDetail, Int32) Gets an activity tracking node from the specified build with the specified ID.
Public methodStatic member GetActivityTracking(IBuildDetail, String) Gets an activity tracking node from the specified build with the specified instance ID.
Public methodStatic member GetActivityTracking(IBuildInformation, String) Gets an activity tracking node from the specified build information object that has the specified instance ID.
Public methodStatic member GetActivityTrackingNodes(IBuildDetail) Gets the activity tracking nodes from the specified build.
Public methodStatic member GetActivityTrackingNodes(IBuildInformation) Gets the activity tracking nodes from the specified build information object.
Public methodStatic member GetAssociatedChangesets(IBuildDetail) Gets the associated changeset summaries from the specified build.
Public methodStatic member GetAssociatedChangesets(IBuildInformation) Get the associated changeset summaries from the specified build information object.
Public methodStatic member GetAssociatedWorkItems(IBuildDetail) Gets the associated work item summaries from the specified build.
Public methodStatic member GetAssociatedWorkItems(IBuildInformation) Gets the associated work item summaries from the specified build information object.
Public methodStatic member GetBuildError Converts a single IBuildInformationNode of type BuildError into an IBuildError object.
Public methodStatic member GetBuildErrors(IBuildDetail) Gets the build error nodes from the specified build.
Public methodStatic member GetBuildErrors(IBuildInformation) Gets the build error nodes from a build information object.
Public methodStatic member GetBuildProjectNode Gets the project node with the corresponding local path, or null if none is found.
Public methodStatic member GetBuildProjectNodes(IBuildDetail) Gets the build project nodes from the specified build.
Public methodStatic member GetBuildProjectNodes(IBuildInformation) Gets the build project nodes from the specified build information object.
Public methodStatic member GetBuildSteps(IBuildDetail) Gets a sorted list of the build steps from the specified build.
Public methodStatic member GetBuildSteps(IBuildInformation) Gets a sorted list of the build steps from the specified build information object.
Public methodStatic member GetBuildWarning Converts a single IBuildInformationNode of type BuildWarning into an IBuildWarning object.
Public methodStatic member GetBuildWarnings(IBuildDetail) Gets build warning nodes from the specified build.
Public methodStatic member GetBuildWarnings(IBuildInformation) Gets the build warning nodes from the specified build information object.
Public methodStatic member GetChangesetId(IBuildInformation) Gets a changeset ID from the specified build information object.
Public methodStatic member GetChangesetId(IBuildInformation, Int32) Gets a changesetId from the build for a particular request
Public methodStatic member GetChangesetId(IBuildInformation, Int32, Boolean) Gets a changesetId from the build for a particular request, if returnFirstIfNotFound is specified, it returns the first changeset in the list if the one specified is not present.
Public methodStatic member GetChangesetsInfo Gets several changesets from the build
Public methodStatic member GetConfigurationSummaries(IBuildDetail) Gets the configuration summaries from the specified build.
Public methodStatic member GetConfigurationSummaries(IBuildInformation) Gets the configuration summaries from the specified build information object.
Public methodStatic member GetConfigurationSummary(IBuildInformationNode) Gets a configuration summary from the specified build information node.
Public methodStatic member GetConfigurationSummary(IBuildDetail, String, String) Gets a configuration summary from the specified build.
Public methodStatic member GetConfigurationSummary(IBuildInformation, String, String) Gets a configuration summary from the specified build information object.
Public methodStatic member GetCustomSummaryInformation Converts a single Information node of type CustomSummaryInformation into an ICustomSummaryInformation object.
Public methodStatic member GetCustomSummaryInformationNodes(IBuildDetail) Gets all of the Custom Summary Information nodes from a build.
Public methodStatic member GetCustomSummaryInformationNodes(IBuildInformation) Gets all of the Custom Summary Information nodes from a build information object.
Public methodStatic member GetOpenedWorkItems(IBuildDetail) Gets the associated opened work item summaries for the specified build.
Public methodStatic member GetOpenedWorkItems(IBuildInformation) Gets the associated opened work item summaries for the specified build information object.
Public methodStatic member GetTopLevelProjects(IBuildDetail) Gets the top-level build project nodes from the specified build.
Public methodStatic member GetTopLevelProjects(IBuildInformation) Gets top-level build project nodes from the specified build information object.

Top

Remarks

The InformationNodeConverters class can be used to add IBuildInformationNodes of various types to an IBuildDetail, or to get IBuildInformationNodes of various types from an IBuildDetail. In both cases, return values of the various static methods will typically be helper interface types, such as IBuildStep or IConfigurationSummary. These types serve to simplify access to the underlying IBuildInformationNode objects.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace