WorkHttpClientBase.GetPredefinedQueryResultsAsync Method

Definition

Namespace:

Microsoft.TeamFoundation.Work.WebApi

Assembly:

Microsoft.TeamFoundation.Work.WebApi.dll

Overloads

GetPredefinedQueryResultsAsync(Guid, String, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieves the specified predefined query including the query results
GetPredefinedQueryResultsAsync(String, String, Nullable<Int32>, Nullable<Boolean>, Object, CancellationToken)	[Preview API] Retrieves the specified predefined query including the query results

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

[Preview API] Retrieves the specified predefined query including the query results

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Work.WebApi.PredefinedQuery> GetPredefinedQueryResultsAsync(Guid project, string id, Nullable<int> top = null, Nullable<bool> includeCompleted = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPredefinedQueryResultsAsync : Guid * string * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Work.WebApi.PredefinedQuery>
override this.GetPredefinedQueryResultsAsync : Guid * string * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Work.WebApi.PredefinedQuery>

Parameters

project

Guid

Project ID

id

String

Id of the query to run

top

Nullable<Int32>

The maximum number of items to return

includeCompleted

Nullable<Boolean>

Whether or not to retrieve the 'completed' work items (work items in the 'completed' meta state)

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<PredefinedQuery>

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

[Preview API] Retrieves the specified predefined query including the query results

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Work.WebApi.PredefinedQuery> GetPredefinedQueryResultsAsync(string project, string id, Nullable<int> top = null, Nullable<bool> includeCompleted = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetPredefinedQueryResultsAsync : string * string * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Work.WebApi.PredefinedQuery>
override this.GetPredefinedQueryResultsAsync : string * string * Nullable<int> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Work.WebApi.PredefinedQuery>

Parameters

project

String

Project ID or project name

id

String

Id of the query to run

top

Nullable<Int32>

The maximum number of items to return

includeCompleted

Nullable<Boolean>

Whether or not to retrieve the 'completed' work items (work items in the 'completed' meta state)

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<PredefinedQuery>