Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Microsoft.TeamFoundation.TestManagement.Client Namespace

 

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.

ClassDescription
System_CAPS_pubclassAccessDeniedException

Represents an exception that was caused by an access problem in the test management.

System_CAPS_pubclassAttachmentUploadManagerException

Represents an exception that is thrown while an attachment is being uploaded.

System_CAPS_pubclassCloneOperationInformation

Holds information regarding a Clone operation

System_CAPS_pubclassCloneOptions

Options that can be specified during a Clone operation

System_CAPS_pubclassHierarchyEntry

Represents a test suite as a node in the hierarchy that is used to organize test points.

System_CAPS_pubclassInvalidParameterNameException

Represents an exception that is thrown when an invalid parameter name is encountered in the test management API.

System_CAPS_pubclassInvalidQueryException

Represents the exception that is thrown when a query string is not a valid work item query language (WIQL) query.

System_CAPS_pubclassInvalidResultUpdateRequestException

Represents an exception that is thrown when an invalid result is returned from an update request.

System_CAPS_pubclassInvalidStructurePathException

Represents the exception that is thrown when an invalid structure path is encountered in the test management framework.

System_CAPS_pubclassInvalidWorkItemTypeException

Represents the exception that is thrown when the expected work item type does not match the actual work item type.

System_CAPS_pubclassNameValuePair

System_CAPS_pubclassParameterizedString

Represents a string that has embedded parameters.

System_CAPS_pubclassSessionPropertyCollection<T>

Collection to store notes, bookmarks, or any collection that is a property of the session.

System_CAPS_pubclassStoredQueryNotFoundException

Represents the exception that is thrown when a stored query is not found.

System_CAPS_pubclassTeamFoundationIdentityName

TeamFoundationIdentityName.

System_CAPS_pubclassTeamProjectNotFoundException

Represents the exception that is thrown when the team project is not found.

System_CAPS_pubclassTemporaryFolderException

Represents the exception that is thrown when a temporary folder cannot be created.

System_CAPS_pubclassTestActionCollection

Provides an ordered list of test actions, in which actions are stored in the order that they are to be executed.

System_CAPS_pubclassTestActionResultCollection

Represents a collection of test action result objects.

System_CAPS_pubclassTestCaseResultIdentifier

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubclassTestManagementAPINotSupportedException

System_CAPS_pubclassTestManagementConfigurationException

Represents the exception that is thrown when an operation cannot finish because of a configuration error on the server.

System_CAPS_pubclassTestManagementConflictingOperation

System_CAPS_pubclassTestManagementException

Provides a base class for test management exceptions.

System_CAPS_pubclassTestManagementInvalidOperationException

Represents the exception that is thrown by the test management client for an invalid operation.

System_CAPS_pubclassTestManagementServerException

Represents an exception that is thrown by the test management server.

System_CAPS_pubclassTestManagementValidationException

Represents an exception that is thrown when a property of an object has a value that is not valid or is missing.

System_CAPS_pubclassTestMessageLogEntryCollection

This API supports the product infrastructure and is not intended to be used directly from your code. Provides a collection of test message log entries.

System_CAPS_pubclassTestObjectId

Represents the reserved object IDs.

System_CAPS_pubclassTestObjectInUseException

An exception that is thrown when an attempt is made to delete a test object that is being used by another object.

System_CAPS_pubclassTestObjectMustBeSavedException

Represents the exception that is thrown when the method of an object cannot execute successfully unless the object has been saved.

System_CAPS_pubclassTestObjectNotFoundException

Represents the exception that is thrown when a test object is required but not found.

System_CAPS_pubclassTestObjectUpdatedException

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.

System_CAPS_pubclassTestParameterCollection

Represents a collection of test parameters in a shared step set, a test case, or a test step.

System_CAPS_pubclassTestParameterDeletingEventArgs

Provides data for the event that is raised when a test parameter is deleted.

System_CAPS_pubclassTestResultParameterCollection

Represents a collection of test result parameters in a given test iteration, shared step set, or test action.

System_CAPS_pubclassTestSuiteInvalidOperationException

System_CAPS_pubclassUploadCompletionEventArgs

Represents the event arguments for the UploadCompletionEventHandler.

System_CAPS_pubclassUploadManagerEventArgs

Represents the event arguments for the UploadManagerEventHandler.

System_CAPS_pubclassWitLinkTypes

This API supports the product infrastructure and is not intended to be used directly from your code. Provides strings that are used in link text for the test client.

StructureDescription
System_CAPS_pubstructureIdAndName

Represents a test object that has only an ID and a name.

System_CAPS_pubstructureParameterizedStringPart

Represents an embedded parameter in a ParameterizedString object.

System_CAPS_pubstructureTestMessageLogEntryIdentity

A structure that holds information about the identity element of a log entry.

InterfaceDescription
System_CAPS_pubinterfaceIActionRecordingHelper

Provides a mapping connection between action recordings and their associated test cases.

System_CAPS_pubinterfaceIAttachmentCollection

Represents a collection of attachments that is associated with test objects, such as test cases, test steps, test runs, test results, and shared steps.

System_CAPS_pubinterfaceIAttachmentOwner

Represents the functionality that is required for an object to support attachments.

System_CAPS_pubinterfaceIAttachmentUploadEntry

Represents the information in IAttachmentUploadManager to track the background upload of a single attachment.

System_CAPS_pubinterfaceIAttachmentUploadManager

Provides properties and methods to manage background attachment uploads.

System_CAPS_pubinterfaceIBugFieldMapping

Represents the mapping of bug field properties to their work item tracking fields.

System_CAPS_pubinterfaceIBugFieldMappingHelper

Provides helper methods for bug field mapping objects in Visual Studio Test Professional.

System_CAPS_pubinterfaceIBuildConfiguration

Represents the build outputs for a specific platform and flavor against a specific build.

System_CAPS_pubinterfaceIBuildCoverage

Represents the coverage information pertaining to a build.

System_CAPS_pubinterfaceIBuildFilter

Defines the criteria to use to choose a build to associate with a test plan.

System_CAPS_pubinterfaceICoverage

Represents the coverage information

System_CAPS_pubinterfaceICoverageAnalysisManager

Manages interaction with coverage related API

System_CAPS_pubinterfaceICoverageStatistics

Represents various statistics associated with coverage.

System_CAPS_pubinterfaceIDataCollectorHelper

Represents methods for a set of data collectors that is registered on the Visual Studio Team Foundation Server.

System_CAPS_pubinterfaceIDataCollectorInformation

Represents information about a data collector that is registered in the Visual Studio Team Foundation Server.

System_CAPS_pubinterfaceIDataCollectorInformationCollection

A collection of information about data collectors.

System_CAPS_pubinterfaceIDynamicTestSuite

Represents a test suite that is populated dynamically by a Work Item Query Language (WIQL) query.

System_CAPS_pubinterfaceIDynamicTestSuite2

System_CAPS_pubinterfaceIDynamicTestSuiteBase

Provides a common base class for all suites that are populated by the server.

System_CAPS_pubinterfaceIDynamicTestSuiteBase2

System_CAPS_pubinterfaceIFunctionCoverage

Represents coverage information pertaining to a function.

System_CAPS_pubinterfaceIIdentifiable<TKey>

Specifies that the object that implements this interface is identified by an object of specified generic parameter.

System_CAPS_pubinterfaceIImpactedTestPoint

Represents a test point that has been affected by a build.

System_CAPS_pubinterfaceIImpactedTestPointCollection

Represents a collection of test points that is affected by a build.

System_CAPS_pubinterfaceIMachineRole

Describes a type of machine role for a testenvironment, such as the Web server role or the client role.

System_CAPS_pubinterfaceIMachineRoleCollection

Represents a collection of machine roles.

System_CAPS_pubinterfaceIMeasurementBlockProxy

IMeasurementBlockProxy.

System_CAPS_pubinterfaceIModuleCoverage

Represents coverage information pertaining to a module.

System_CAPS_pubinterfaceINewBuildStatistics

Provides statistics about the changes in the build since the last build was associated with the test plan.

System_CAPS_pubinterfaceIPropertyOwner

Provides a common interface for objects that support property binding.

System_CAPS_pubinterfaceIRequirementTestSuite

Represents a test suite that is populated dynamically by finding test cases that are associated with a requirement work item.

System_CAPS_pubinterfaceIRequirementTestSuite2

System_CAPS_pubinterfaceISession

Represent the execution of a charter.

System_CAPS_pubinterfaceISessionBookmark

Interface to represent the session book mark.

System_CAPS_pubinterfaceISessionHelper

System_CAPS_pubinterfaceISessionNote

Interface to represent the session note.

System_CAPS_pubinterfaceISharedStep

Represents a reusable collection of test actions.

System_CAPS_pubinterfaceISharedStepCollection

This API supports the product infrastructure and is not intended to be used directly from your code. Represents a collection of shared steps.

System_CAPS_pubinterfaceISharedStepHelper

No content here will be updated; please do not add material here.

System_CAPS_pubinterfaceISharedStepReference

This interface is used to call a shared step set from a test case.

System_CAPS_pubinterfaceISharedStepResult

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.

System_CAPS_pubinterfaceIStaticTestSuite

Represents a test suite that consists of a user-specified list of test cases.

System_CAPS_pubinterfaceIStaticTestSuite2

System_CAPS_pubinterfaceITestAction

Represents a single action and expected result.

System_CAPS_pubinterfaceITestActionGroup

Represents a group of test actions, each of which may contain other nested action groups.

System_CAPS_pubinterfaceITestActionResult

Represents the result of a single test action.

System_CAPS_pubinterfaceITestAttachment

Encapsulates a stream of bytes that is stored on the test management server.

System_CAPS_pubinterfaceITestBase

Contains the common properties and methods of ITestCase and ISharedStep

System_CAPS_pubinterfaceITestCase

A set of data representing a test case stored in the test management server.

System_CAPS_pubinterfaceITestCase2

System_CAPS_pubinterfaceITestCaseCollection

Represents a container for test cases.

System_CAPS_pubinterfaceITestCaseHelper

Provides helper methods and properties for ITestCase objects.

System_CAPS_pubinterfaceITestCaseQuery

Represents a stored test case query.

System_CAPS_pubinterfaceITestCaseResult

Represents the status of a test case executed against a test run.

System_CAPS_pubinterfaceITestCaseResultCollection

Collection for TestCaseResults

System_CAPS_pubinterfaceITestCaseResultHelper

Provides helper methods and properties for ITestCaseResult objects.

System_CAPS_pubinterfaceITestCaseResultIdentifier

Represents the complete unique identifier for a test case result.

System_CAPS_pubinterfaceITestConfiguration

Provides test configuration information for a test management object, such as an ITestPlan object.

System_CAPS_pubinterfaceITestConfigurationCollection

Represents a collection of ITestConfiguration objects.

System_CAPS_pubinterfaceITestConfigurationHelper

Provides helper properties and methods for test configuration objects.

System_CAPS_pubinterfaceITestController

Registers a test controller with the Visual Studio Test Professional.

System_CAPS_pubinterfaceITestControllerHelper

Provides helper methods for test controllers.

System_CAPS_pubinterfaceITestEnvironment

Represents a test environment in the test management client.

System_CAPS_pubinterfaceITestEnvironmentHelper

Provides a helper interface with methods for test environments.

System_CAPS_pubinterfaceITestExternalLink

Represents a link to an external object.

System_CAPS_pubinterfaceITestExternalLinkCollection

Represents a collection of links to external objects.

System_CAPS_pubinterfaceITestFailureType

Represents the failure type of a test case result

System_CAPS_pubinterfaceITestFailureTypeHelper

System_CAPS_pubinterfaceITestImplementation

Represents a link to the implementation of an automated test.

System_CAPS_pubinterfaceITestIterationResult

Represents the result of an execution of a test case against a row of data.

System_CAPS_pubinterfaceITestIterationResultCollection

Represents a collection of test iteration results that are shown in a test result.

System_CAPS_pubinterfaceITestManagementService

Represents the main object for the test management client API. Provides access to project collection level helper objects and ITestManagementTeamProject.

System_CAPS_pubinterfaceITestManagementService2

System_CAPS_pubinterfaceITestManagementTeamProject

Provides test case management functionality for a team project.

System_CAPS_pubinterfaceITestManagementTeamProject2

System_CAPS_pubinterfaceITestMessageLogEntry

Represents a log entry for a test object.

System_CAPS_pubinterfaceITestMessageLogOwner

Represents the owner of a log.

System_CAPS_pubinterfaceITestObject<T>

This API supports the product infrastructure and is not intended to be used directly from your code. Provides a base interface for objects that are stored on the Visual Studio Test Professional server.

System_CAPS_pubinterfaceITestObjectCollection<TObjectInterface>

This API supports the product infrastructure and is not intended to be used directly from your code. Represents the base interface for collections of test management objects.

System_CAPS_pubinterfaceITestParameter

Represents a parameter used in a test step.

System_CAPS_pubinterfaceITestPlan

No content here will be updated; please do not add material here.

System_CAPS_pubinterfaceITestPlan2

System_CAPS_pubinterfaceITestPlanCollection

This API supports the product infrastructure and is not intended to be used directly from your code. Represents a collection of test plans.

System_CAPS_pubinterfaceITestPlanHelper

No content here will be updated; please do not add material here.

System_CAPS_pubinterfaceITestPlanHelper2

System_CAPS_pubinterfaceITestPoint

Represents the execution state of a test case in a suite against a configuration as part of a test plan.

System_CAPS_pubinterfaceITestPointAssignment

Provides helper methods for the AssignTestPoints method.

System_CAPS_pubinterfaceITestPointCollection

Represents a collection of test points for the test point query methods in the ITestPlan interface.

System_CAPS_pubinterfaceITestPointHelper

System_CAPS_pubinterfaceITestPointProperties

Represents the mutable properties of a test point. These are tracked historically.

System_CAPS_pubinterfaceITestPointStatistic

Represent a count of test points per test plan for a combination of TestPointState, TestResultState and TestOutcome.

System_CAPS_pubinterfaceITestPointStatistics

Represents counts of points in various states as selected by ITestPlan.QueryTestPointStatistics()

System_CAPS_pubinterfaceITestPointStatisticsByPivot

System_CAPS_pubinterfaceITestPointStatisticsPivotItem

System_CAPS_pubinterfaceITestResolutionState

This API supports the product infrastructure and is not intended to be used directly from your code. Represents the resolution status of a test case result.

System_CAPS_pubinterfaceITestResolutionStateHelper

No content here will be updated; please do not add material here.

System_CAPS_pubinterfaceITestResolutionStateStatistic

This API supports the product infrastructure and is not intended to be used directly from your code. Represents the statistics for a particular resolution state in a test run.

System_CAPS_pubinterfaceITestResult

Provides a base interface for results from test cases, test actions, and test iterations.

System_CAPS_pubinterfaceITestResultParameter

This API supports the product infrastructure and is not intended to be used directly from your code. Represents the expected and actual values of a parameter during a test execution.

System_CAPS_pubinterfaceITestRun

Represents an execution of a set of tests against a specific build.

System_CAPS_pubinterfaceITestRunBase

No content here will be updated; please do not add material here.

System_CAPS_pubinterfaceITestRunCoverage

Represents the coverage information pertaining to a test run.

System_CAPS_pubinterfaceITestRunHelper

Provides helper properties and methods for test run objects in Visual Studio Test Professional.

System_CAPS_pubinterfaceITestRunStatistic

Represents a count of results for test runs that have a specific resolution state, result outcome, and result state.

System_CAPS_pubinterfaceITestRunStatistics

Represents the counts of several aspects of test results for a test run.

System_CAPS_pubinterfaceITestSettings

Represents the test settings that are used by test plans and test runs.

System_CAPS_pubinterfaceITestSettingsHelper

Provides helper properties and methods for test settings objects in Visual Studio Test Professional.

System_CAPS_pubinterfaceITestSettingsMachineRole

Represents a machine role that is associated with a test settings object.

System_CAPS_pubinterfaceITestSettingsMachineRoleCollection

Represents a collection of machine roles that is associated with a test settings object.

System_CAPS_pubinterfaceITestStep

Represents a single test action and expected test result.

System_CAPS_pubinterfaceITestStepResult

Represents the test result of execution of a single test step.

System_CAPS_pubinterfaceITestSuiteBase

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

System_CAPS_pubinterfaceITestSuiteBase2

System_CAPS_pubinterfaceITestSuiteCollection

This API supports the product infrastructure and is not intended to be used directly from your code. Represents a collection of test suites.

System_CAPS_pubinterfaceITestSuiteEntry

Represents an entry in a test suite entry collection.

System_CAPS_pubinterfaceITestSuiteEntryCollection

Represents a collection of test suite entries.

System_CAPS_pubinterfaceITestSuiteHelper

No content here will be updated; please do not add material here.

System_CAPS_pubinterfaceITestVariable

Represents a variable name that is used in test configurations and its possible values.

System_CAPS_pubinterfaceITestVariableHelper

Provides helper properties and methods for test variable objects in Visual Studio Test Professional.

System_CAPS_pubinterfaceITestVariableValue

Represents a possible value for a test variable.

System_CAPS_pubinterfaceITfsIdentityStore

Manages an identity cache which is loaded from disk and periodically refreshed from the identity management service.

System_CAPS_pubinterfaceITmiTestImplementation

Represents a link to an automated test in the unit test infrastructure.

DelegateDescription
System_CAPS_pubdelegateTestParameterDeletingEventEventHandler

Represents the method that will handle the event that is raised when a test parameter is deleted.

System_CAPS_pubdelegateUploadCompletionEventHandler

Represents the method that handles the event that is raised when an attachment has been successfully uploaded.

System_CAPS_pubdelegateUploadManagerEventHandler

Represents the method that handles events that are raised by the upload manager.

EnumerationDescription
System_CAPS_pubenumCloneItemType

Corresponds to ItemType column in tbl_CloneOperation

System_CAPS_pubenumCloneOperationState

The State of a CloneOperation.

System_CAPS_pubenumCoverageQueryFlags

Used to choose which coverage data is returned when a query coverage method is called.

System_CAPS_pubenumCoverageState

Indicates the current state of a set of coverage data.

System_CAPS_pubenumDeleteAction

Indicates the test actions that are to be executed when test objects are deleted from a test.

System_CAPS_pubenumEnvironmentParentTypes

This API supports the product infrastructure and is not intended to be used directly from your code. Indicates the type of owner of the test environments.

System_CAPS_pubenumFailureType

Indicates the type of failure for a test run.

System_CAPS_pubenumGeneratedBugFields

Represents the predefined fields whose customized names are provided in IBugFieldMapping.FieldMappings.

System_CAPS_pubenumMessageCodes

No content here will be updated; please do not add material here.

System_CAPS_pubenumObjectTypes

No content here will be updated; please do not add material here.

System_CAPS_pubenumPostProcessState

This API supports the product infrastructure and is not intended to be used directly from your code. Enumerates the possible settings for the state of any post-processing that occurs on the server, such as code coverage analysis.

System_CAPS_pubenumResultObjectType

The top level entity that is being cloned as part of a Clone operation

System_CAPS_pubenumServerVersion

The version of TFS server to which the client is connected

System_CAPS_pubenumSessionState

Describes the status of a session.

System_CAPS_pubenumSourceFileAction

Represents possible actions to take after uploading a file attachment.

System_CAPS_pubenumTcmProperty

System_CAPS_pubenumTestConfigurationState

Enumerates the possible values that indicate the state of a test configuration.

System_CAPS_pubenumTestControllerState

System_CAPS_pubenumTestManagementServiceVersion

System_CAPS_pubenumTestMessageLogEntryLevel

Enumerates the possible levels for the log entry in the test message log.

System_CAPS_pubenumTestOutcome

Represents the outcome of a completed test.

System_CAPS_pubenumTestPlanSource

System_CAPS_pubenumTestPlanState

Provides the settings for the ITestPlan.State property.

System_CAPS_pubenumTestPointState

Represents the possible values for the State property.

System_CAPS_pubenumTestPointStatisticsQueryPivotType

Types of the Pivots used for QueryTestPointStatisticsByPivot.

System_CAPS_pubenumTestResultState

Enumerates the possible states of a test.

System_CAPS_pubenumTestRunAbortOptions

Enumerates the options to use to abort a test run.

System_CAPS_pubenumTestRunState

Enumerates the possible status settings for a test run.

System_CAPS_pubenumTestRunType

The types for test run.

System_CAPS_pubenumTestStepType

Enumerates the possible types of test steps.

System_CAPS_pubenumTestSuiteEntryType

Enumerates the possible types of test suite entries.

System_CAPS_pubenumTestSuiteSource

System_CAPS_pubenumTestSuiteState

Enumerates the possible states for a test suite.

System_CAPS_pubenumTestSuiteType

Enumerates the possible types of test suites.

System_CAPS_pubenumUploadManagerEventType

Enumerates the possible types of events that are handled by the UploadManagerEventHandler.

System_CAPS_pubenumUploadPauseReason

Provides the reasons that an IAttachmentUploadEntry could be paused.

System_CAPS_pubenumUploadState

Represents the possible states during the upload process.

Return to top
Show: