Microsoft.TeamFoundation.TestManagement.Client Namespace

  • Article

This namespace provides interfaces and classes that cannot be derived from Visual Studio Test Professional. However, these interfaces and classes are primarily used internally by Visual Studio Test Professional.

Classes

  Class Description
Public class AccessDeniedException Represents an exception that was caused by an access problem in the test management.
Public class AttachmentUploadManagerException Represents an exception that is thrown while an attachment is being uploaded.
Public class CloneOperationInformation Holds information regarding a Clone operation
Public class CloneOptions Options that can be specified during a Clone operation
Public class HierarchyEntry Represents a test suite as a node in the hierarchy that is used to organize test points.
Public class InvalidParameterNameException Represents an exception that is thrown when an invalid parameter name is encountered in the test management API.
Public class InvalidQueryException Represents the exception that is thrown when a query string is not a valid work item query language (WIQL) query.
Public class InvalidResultUpdateRequestException Represents an exception that is thrown when an invalid result is returned from an update request.
Public class InvalidStructurePathException Represents the exception that is thrown when an invalid structure path is encountered in the test management framework.
Public class InvalidWorkItemTypeException Represents the exception that is thrown when the expected work item type does not match the actual work item type.
Public class MeasurementBlockProxyFactory FOR INTERNAL USE ONLY. Factory for creating IMeasureBlockProxy.
Public class NameValuePair
Public class ParameterizedString Represents a string that has embedded parameters.
Public class SessionPropertyCollection<T> Collection to store notes, bookmarks, or any collection that is a property of the session.
Public class StoredQueryNotFoundException Represents the exception that is thrown when a stored query is not found.
Public class TeamFoundationIdentityName TeamFoundationIdentityName.
Public class TeamProjectNotFoundException Represents the exception that is thrown when the team project is not found.
Public class TemporaryFolderException Represents the exception that is thrown when a temporary folder cannot be created.
Public class TestActionCollection Provides an ordered list of test actions, in which actions are stored in the order that they are to be executed.
Public class TestActionResultCollection Represents a collection of test action result objects.
Public class TestCaseResultIdentifier Infrastructure.
Public class TestManagementAPINotSupportedException
Public class TestManagementConfigurationException Represents the exception that is thrown when an operation cannot finish because of a configuration error on the server.
Public class TestManagementConflictingOperation
Public class TestManagementException Provides a base class for test management exceptions.
Public class TestManagementInvalidOperationException Represents the exception that is thrown by the test management client for an invalid operation.
Public class TestManagementServerException Represents an exception that is thrown by the test management server.
Public class TestManagementService Infrastructure. For information about this class, see ITestManagementService.
Public class TestManagementValidationException Represents an exception that is thrown when a property of an object has a value that is not valid or is missing.
Public class TestMessageLogEntryCollection Infrastructure. Provides a collection of test message log entries.
Public class TestObjectId Represents the reserved object IDs.
Public class TestObjectInUseException An exception that is thrown when an attempt is made to delete a test object that is being used by another object.
Public class TestObjectMustBeSavedException Represents the exception that is thrown when the method of an object cannot execute successfully unless the object has been saved.
Public class TestObjectNotFoundException Represents the exception that is thrown when a test object is required but not found.
Public class TestObjectUpdatedException The exception that is thrown by the test management server when the user attempts to update an object that has been more recently changed by another user.
Public class TestParameterCollection Represents a collection of test parameters in a shared step set, a test case, or a test step.
Public class TestParameterDeletingEventArgs Provides data for the event that is raised when a test parameter is deleted.
Public class TestResultParameterCollection Represents a collection of test result parameters in a given test iteration, shared step set, or test action.
Public class TestSuiteInvalidOperationException
Public class UploadCompletionEventArgs Represents the event arguments for the UploadCompletionEventHandler.
Public class UploadManagerEventArgs Represents the event arguments for the UploadManagerEventHandler.
Public class WitLinkTypes Infrastructure. Provides strings that are used in link text for the test client.

Structures

  Structure Description
Public structure IdAndName Represents a test object that has only an ID and a name.
Public structure ParameterizedStringPart Represents an embedded parameter in a ParameterizedString object.
Public structure TestMessageLogEntryIdentity A structure that holds information about the identity element of a log entry.

Interfaces

  Interface Description
Public interface IActionRecordingHelper Provides a mapping connection between action recordings and their associated test cases.
Public interface IAttachmentCollection Represents a collection of attachments that is associated with test objects, such as test cases, test steps, test runs, test results, and shared steps.
Public interface IAttachmentOwner Represents the functionality that is required for an object to support attachments.
Public interface IAttachmentUploadEntry Represents the information in IAttachmentUploadManager to track the background upload of a single attachment.
Public interface IAttachmentUploadManager Provides properties and methods to manage background attachment uploads.
Public interface IBugFieldMapping Represents the mapping of bug field properties to their work item tracking fields.
Public interface IBugFieldMappingHelper Provides helper methods for bug field mapping objects in Visual Studio Test Professional.
Public interface IBuildConfiguration Represents the build outputs for a specific platform and flavor against a specific build.
Public interface IBuildCoverage Represents the coverage information pertaining to a build.
Public interface IBuildFilter Defines the criteria to use to choose a build to associate with a test plan.
Public interface ICoverage Represents the coverage information
Public interface ICoverageAnalysisManager Manages interaction with coverage related API
Public interface ICoverageStatistics Represents various statistics associated with coverage.
Public interface IDataCollectorHelper Represents methods for a set of data collectors that is registered on the Visual Studio Team Foundation Server.
Public interface IDataCollectorInformation Represents information about a data collector that is registered in the Visual Studio Team Foundation Server.
Public interface IDataCollectorInformationCollection A collection of information about data collectors.
Public interface IDynamicTestSuite Represents a test suite that is populated dynamically by a Work Item Query Language (WIQL) query.
Public interface IDynamicTestSuiteBase Provides a common base class for all suites that are populated by the server.
Public interface IFunctionCoverage Represents coverage information pertaining to a function.
Public interface IIdentifiable<TKey> Specifies that the object that implements this interface is identified by an object of specified generic parameter.
Public interface IImpactedTestPoint Represents a test point that has been affected by a build.
Public interface IImpactedTestPointCollection Represents a collection of test points that is affected by a build.
Public interface IMachineRole Describes a type of machine role for a testenvironment, such as the Web server role or the client role.
Public interface IMachineRoleCollection Represents a collection of machine roles.
Public interface IMeasurementBlockProxy IMeasurementBlockProxy.
Public interface IModuleCoverage Represents coverage information pertaining to a module.
Public interface INewBuildStatistics Provides statistics about the changes in the build since the last build was associated with the test plan.
Public interface IPropertyOwner Provides a common interface for objects that support property binding.
Public interface IRequirementTestSuite Represents a test suite that is populated dynamically by finding test cases that are associated with a requirement work item.
Public interface ISession Represent the execution of a charter.
Public interface ISessionBookmark Interface to represent the session book mark.
Public interface ISessionHelper
Public interface ISessionNote Interface to represent the session note.
Public interface ISharedStep Represents a reusable collection of test actions.
Public interface ISharedStepCollection Infrastructure. Represents a collection of shared steps.
Public interface ISharedStepHelper No content here will be updated; please do not add material here.
Public interface ISharedStepReference This interface is used to call a shared step set from a test case.
Public interface ISharedStepResult Represents the result of executing a shared step. The action ID will correspond to the action ID of the SharedStepReference that called the shared ste.
Public interface IStaticTestSuite Represents a test suite that consists of a user-specified list of test cases.
Public interface ITestAction Represents a single action and expected result.
Public interface ITestActionGroup Represents a group of test actions, each of which may contain other nested action groups.
Public interface ITestActionResult Represents the result of a single test action.
Public interface ITestAttachment Encapsulates a stream of bytes that is stored on the test management server.
Public interface ITestBase Contains the common properties and methods of ITestCase and ISharedStep
Public interface ITestCase A set of data representing a test case stored in the test management server.
Public interface ITestCaseCollection Represents a container for test cases.
Public interface ITestCaseHelper Provides helper methods and properties for ITestCase objects.
Public interface ITestCaseQuery Represents a stored test case query.
Public interface ITestCaseResult Represents the status of a test case executed against a test run.
Public interface ITestCaseResultCollection Collection for TestCaseResults
Public interface ITestCaseResultHelper Provides helper methods and properties for ITestCaseResult objects.
Public interface ITestCaseResultIdentifier Represents the complete unique identifier for a test case result.
Public interface ITestConfiguration Provides test configuration information for a test management object, such as an ITestPlan object.
Public interface ITestConfigurationCollection Represents a collection of ITestConfiguration objects.
Public interface ITestConfigurationHelper Provides helper properties and methods for test configuration objects.
Public interface ITestController Registers a test controller with the Visual Studio Test Professional.
Public interface ITestControllerHelper Provides helper methods for test controllers.
Public interface ITestEnvironment Represents a test environment in the test management client.
Public interface ITestEnvironmentHelper Provides a helper interface with methods for test environments.
Public interface ITestExternalLink Represents a link to an external object.
Public interface ITestExternalLinkCollection Represents a collection of links to external objects.
Public interface ITestFailureType Represents the failure type of a test case result
Public interface ITestFailureTypeHelper
Public interface ITestImplementation Represents a link to the implementation of an automated test.
Public interface ITestIterationResult Represents the result of an execution of a test case against a row of data.
Public interface ITestIterationResultCollection Represents a collection of test iteration results that are shown in a test result.
Public interface ITestManagementService Represents the main object for the test management client API. Provides access to project collection level helper objects and ITestManagementTeamProject.
Public interface ITestManagementTeamProject Provides test case management functionality for a team project.
Public interface ITestMessageLogEntry Represents a log entry for a test object.
Public interface ITestMessageLogOwner Represents the owner of a log.
Public interface ITestObject<T> Infrastructure. Provides a base interface for objects that are stored on the Visual Studio Test Professional server.
Public interface ITestObjectCollection<TObjectInterface> Infrastructure. Represents the base interface for collections of test management objects.
Public interface ITestParameter Represents a parameter used in a test step.
Public interface ITestPlan No content here will be updated; please do not add material here.
Public interface ITestPlanCollection Infrastructure. Represents a collection of test plans.
Public interface ITestPlanHelper No content here will be updated; please do not add material here.
Public interface ITestPoint Represents the execution state of a test case in a suite against a configuration as part of a test plan.
Public interface ITestPointAssignment Provides helper methods for the AssignTestPoints method.
Public interface ITestPointCollection Represents a collection of test points for the test point query methods in the ITestPlan interface.
Public interface ITestPointHelper
Public interface ITestPointProperties Represents the mutable properties of a test point. These are tracked historically.
Public interface ITestPointStatistic Represent a count of test points per test plan for a combination of TestPointState, TestResultState and TestOutcome.
Public interface ITestPointStatistics Represents counts of points in various states as selected by ITestPlan.QueryTestPointStatistics()
Public interface ITestPointStatisticsByPivot
Public interface ITestPointStatisticsPivotItem
Public interface ITestResolutionState Infrastructure. Represents the resolution status of a test case result.
Public interface ITestResolutionStateHelper No content here will be updated; please do not add material here.
Public interface ITestResolutionStateStatistic Infrastructure. Represents the statistics for a particular resolution state in a test run.
Public interface ITestResult Provides a base interface for results from test cases, test actions, and test iterations.
Public interface ITestResultParameter Infrastructure. Represents the expected and actual values of a parameter during a test execution.
Public interface ITestRun Represents an execution of a set of tests against a specific build.
Public interface ITestRunBase No content here will be updated; please do not add material here.
Public interface ITestRunCoverage Represents the coverage information pertaining to a test run.
Public interface ITestRunHelper Provides helper properties and methods for test run objects in Visual Studio Test Professional.
Public interface ITestRunStatistic Represents a count of results for test runs that have a specific resolution state, result outcome, and result state.
Public interface ITestRunStatistics Represents the counts of several aspects of test results for a test run.
Public interface ITestSettings Represents the test settings that are used by test plans and test runs.
Public interface ITestSettingsHelper Provides helper properties and methods for test settings objects in Visual Studio Test Professional.
Public interface ITestSettingsMachineRole Represents a machine role that is associated with a test settings object.
Public interface ITestSettingsMachineRoleCollection Represents a collection of machine roles that is associated with a test settings object.
Public interface ITestStep Represents a single test action and expected test result.
Public interface ITestStepResult Represents the test result of execution of a single test step.
Public interface ITestSuiteBase Generic notion of a Test Suite, Test suites may be based on Queries IDynamicTestSuite or on an explicit list of ids of TestCases or other TestSuites IStaticTestSuite
Public interface ITestSuiteCollection Infrastructure. Represents a collection of test suites.
Public interface ITestSuiteEntry Represents an entry in a test suite entry collection.
Public interface ITestSuiteEntryCollection Represents a collection of test suite entries.
Public interface ITestSuiteHelper No content here will be updated; please do not add material here.
Public interface ITestVariable Represents a variable name that is used in test configurations and its possible values.
Public interface ITestVariableHelper Provides helper properties and methods for test variable objects in Visual Studio Test Professional.
Public interface ITestVariableValue Represents a possible value for a test variable.
Public interface ITfsIdentityStore Manages an identity cache which is loaded from disk and periodically refreshed from the identity management service.
Public interface ITmiTestImplementation Represents a link to an automated test in the unit test infrastructure.

Delegates

  Delegate Description
Public delegate MeasurementBlockProxyFactory.MeasurementBlockProxyCreator
Public delegate TestParameterDeletingEventEventHandler Represents the method that will handle the event that is raised when a test parameter is deleted.
Public delegate UploadCompletionEventHandler Represents the method that handles the event that is raised when an attachment has been successfully uploaded.
Public delegate UploadManagerEventHandler Represents the method that handles events that are raised by the upload manager.

Enumerations

  Enumeration Description
Public enumeration CloneItemType Corresponds to ItemType column in tbl_CloneOperation
Public enumeration CloneOperationState The State of a CloneOperation.
Public enumeration CoverageQueryFlags Used to choose which coverage data is returned when a query coverage method is called.
Public enumeration CoverageState Indicates the current state of a set of coverage data.
Public enumeration DeleteAction Indicates the test actions that are to be executed when test objects are deleted from a test.
Public enumeration EnvironmentParentTypes Infrastructure. Indicates the type of owner of the test environments.
Public enumeration FailureType Indicates the type of failure for a test run.
Public enumeration GeneratedBugFields Represents the predefined fields whose customized names are provided in IBugFieldMapping.FieldMappings.
Public enumeration MessageCodes No content here will be updated; please do not add material here.
Public enumeration ObjectTypes No content here will be updated; please do not add material here.
Public enumeration PostProcessState Infrastructure. Enumerates the possible settings for the state of any post-processing that occurs on the server, such as code coverage analysis.
Public enumeration ResultObjectType The top level entity that is being cloned as part of a Clone operation
Public enumeration ServerVersion The version of TFS server to which the client is connected
Public enumeration SessionState Describes the status of a session.
Public enumeration SourceFileAction Represents possible actions to take after uploading a file attachment.
Public enumeration TcmProperty
Public enumeration TestConfigurationState Enumerates the possible values that indicate the state of a test configuration.
Public enumeration TestControllerState
Public enumeration TestMessageLogEntryLevel Enumerates the possible levels for the log entry in the test message log.
Public enumeration TestOutcome Represents the outcome of a completed test.
Public enumeration TestPlanSource
Public enumeration TestPlanState Provides the settings for the ITestPlan.State property.
Public enumeration TestPointState Represents the possible values for the State property.
Public enumeration TestPointStatisticsQueryPivotType Types of the Pivots used for QueryTestPointStatisticsByPivot.
Public enumeration TestResultState Enumerates the possible states of a test.
Public enumeration TestRunAbortOptions Enumerates the options to use to abort a test run.
Public enumeration TestRunState Enumerates the possible status settings for a test run.
Public enumeration TestRunType The types for test run.
Public enumeration TestStepType Enumerates the possible types of test steps.
Public enumeration TestSuiteEntryType Enumerates the possible types of test suite entries.
Public enumeration TestSuiteSource
Public enumeration TestSuiteState Enumerates the possible states for a test suite.
Public enumeration TestSuiteType Enumerates the possible types of test suites.
Public enumeration UploadManagerEventType Enumerates the possible types of events that are handled by the UploadManagerEventHandler.
Public enumeration UploadPauseReason Provides the reasons that an IAttachmentUploadEntry could be paused.
Public enumeration UploadState Represents the possible states during the upload process.