TestCompatHttpClientBase.GetTestSuitesForPlanAsync Method

Definition

Namespace:: Microsoft.TeamFoundation.TestManagement.WebApi

Assembly:: Microsoft.TeamFoundation.TestManagement.WebApi.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

GetTestSuitesForPlanAsync(String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	Obsolete. [Preview API] Get test suites for plan.
GetTestSuitesForPlanAsync(String, Int32, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	Obsolete. [Preview API]
GetTestSuitesForPlanAsync(Guid, Int32, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	Obsolete. [Preview API]
GetTestSuitesForPlanAsync(Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	Obsolete. [Preview API] Get test suites for plan.

GetTestSuitesForPlanAsync(String, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

Caution

This API is now deprecated.

[Preview API] Get test suites for plan.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>> GetTestSuitesForPlanAsync(string project, int planId, Nullable<int> expand = null, Nullable<int> skip = null, Nullable<int> top = null, Nullable<bool> asTreeView = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetTestSuitesForPlanAsync : string * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>>
override this.GetTestSuitesForPlanAsync : string * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>>

Parameters

project: String

Project ID or project name

planId: Int32

ID of the test plan for which suites are requested.

expand: Nullable<Int32>

Include the children suites and testers details.

skip: Nullable<Int32>

Number of suites to skip from the result.

top: Nullable<Int32>

Number of Suites to be return after skipping the suites from the result.

asTreeView: Nullable<Boolean>

If the suites returned should be in a tree structure.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<TestSuite>>

Attributes: ObsoleteAttribute

Applies to

GetTestSuitesForPlanAsync(String, Int32, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

Caution

This API is now deprecated.

[Preview API]

[System.Obsolete]
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>> GetTestSuitesForPlanAsync(string project, int planId, Nullable<bool> includeSuites, Nullable<int> skip, Nullable<int> top, Nullable<bool> asTreeView, object userState, System.Threading.CancellationToken cancellationToken);

abstract member GetTestSuitesForPlanAsync : string * int * Nullable<bool> * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>>
override this.GetTestSuitesForPlanAsync : string * int * Nullable<bool> * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>>

Parameters

project: String

Project ID or project name

planId: Int32

includeSuites: Nullable<Boolean>

skip: Nullable<Int32>

top: Nullable<Int32>

asTreeView: Nullable<Boolean>

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<TestSuite>>

Attributes: ObsoleteAttribute

Applies to

GetTestSuitesForPlanAsync(Guid, Int32, Nullable<Boolean>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

Caution

This API is now deprecated.

[Preview API]

[System.Obsolete]
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>> GetTestSuitesForPlanAsync(Guid project, int planId, Nullable<bool> includeSuites, Nullable<int> skip, Nullable<int> top, Nullable<bool> asTreeView, object userState, System.Threading.CancellationToken cancellationToken);

abstract member GetTestSuitesForPlanAsync : Guid * int * Nullable<bool> * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>>
override this.GetTestSuitesForPlanAsync : Guid * int * Nullable<bool> * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>>

Parameters

project: Guid

Project ID

planId: Int32

includeSuites: Nullable<Boolean>

skip: Nullable<Int32>

top: Nullable<Int32>

asTreeView: Nullable<Boolean>

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<TestSuite>>

Attributes: ObsoleteAttribute

Applies to

GetTestSuitesForPlanAsync(Guid, Int32, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)

Caution

This API is now deprecated.

[Preview API] Get test suites for plan.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>> GetTestSuitesForPlanAsync(Guid project, int planId, Nullable<int> expand = null, Nullable<int> skip = null, Nullable<int> top = null, Nullable<bool> asTreeView = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetTestSuitesForPlanAsync : Guid * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>>
override this.GetTestSuitesForPlanAsync : Guid * int * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSuite>>