TestCompatHttpClientBase.GetPlansAsync 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

GetPlansAsync(Guid, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)	Obsolete. [Preview API] Get a list of test plans.
GetPlansAsync(String, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)	Obsolete. [Preview API] Get a list of test plans.

GetPlansAsync(Guid, String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, Object, CancellationToken)

Caution

This API is now deprecated.

[Preview API] Get a list of test plans.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestPlan>> GetPlansAsync(Guid project, string owner = null, Nullable<int> skip = null, Nullable<int> top = null, Nullable<bool> includePlanDetails = null, Nullable<bool> filterActivePlans = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

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

Parameters

project: Guid

Project ID

owner: String

Filter for test plan by owner ID or name.

skip: Nullable<Int32>

Number of test plans to skip.

top: Nullable<Int32>

Number of test plans to return.

includePlanDetails: Nullable<Boolean>

Get all properties of the test plan.

filterActivePlans: Nullable<Boolean>

Get just the active plans.

userState: Object

cancellationToken: CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<TestPlan>>

Attributes: ObsoleteAttribute

Applies to

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

Caution

This API is now deprecated.

[Preview API] Get a list of test plans.

[System.Obsolete]
public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestPlan>> GetPlansAsync(string project, string owner = null, Nullable<int> skip = null, Nullable<int> top = null, Nullable<bool> includePlanDetails = null, Nullable<bool> filterActivePlans = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

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