Microsoft.TeamFoundation.TestManagement.Client Namespace

Article
09/08/2015

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

Structures

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

Interfaces

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

Delegates

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

Enumerations

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

Return to top