Bearbeiten

Freigeben über

TaskAgentHttpClientBase.GetTaskGroupsAsync Method

Definition

Namespace:
Microsoft.TeamFoundation.DistributedTask.WebApi
Assembly:
Microsoft.TeamFoundation.DistributedTask.WebApi.dll

Overloads

GetTaskGroupsAsync(Guid, Nullable<Guid>, Nullable<Boolean>, Nullable<Guid>, Nullable<Boolean>, Nullable<Int32>, Nullable<DateTime>, Nullable<TaskGroupQueryOrder>, Object, CancellationToken)

[Preview API] List task groups.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskGroup>> GetTaskGroupsAsync(Guid project, Nullable<Guid> taskGroupId = null, Nullable<bool> expanded = null, Nullable<Guid> taskIdFilter = null, Nullable<bool> deleted = null, Nullable<int> top = null, Nullable<DateTime> continuationToken = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskGroupQueryOrder> queryOrder = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetTaskGroupsAsync : Guid * Nullable<Guid> * Nullable<bool> * Nullable<Guid> * Nullable<bool> * Nullable<int> * Nullable<DateTime> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskGroupQueryOrder> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskGroup>>

Parameters

project
Guid

Project ID

taskGroupId
Nullable<Guid>

Id of the task group.

expanded
Nullable<Boolean>

'true' to recursively expand task groups. Default is 'false'.

taskIdFilter
Nullable<Guid>

Guid of the taskId to filter.

deleted
Nullable<Boolean>

'true'to include deleted task groups. Default is 'false'.

top
Nullable<Int32>

Number of task groups to get.

continuationToken
Nullable<DateTime>

Gets the task groups after the continuation token provided.

queryOrder
Nullable<TaskGroupQueryOrder>

Gets the results in the defined order. Default is 'CreatedOnDescending'.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<TaskGroup>>

Applies to

GetTaskGroupsAsync(String, Nullable<Guid>, Nullable<Boolean>, Nullable<Guid>, Nullable<Boolean>, Nullable<Int32>, Nullable<DateTime>, Nullable<TaskGroupQueryOrder>, Object, CancellationToken)

[Preview API] List task groups.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskGroup>> GetTaskGroupsAsync(string project, Nullable<Guid> taskGroupId = null, Nullable<bool> expanded = null, Nullable<Guid> taskIdFilter = null, Nullable<bool> deleted = null, Nullable<int> top = null, Nullable<DateTime> continuationToken = null, Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskGroupQueryOrder> queryOrder = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);
override this.GetTaskGroupsAsync : string * Nullable<Guid> * Nullable<bool> * Nullable<Guid> * Nullable<bool> * Nullable<int> * Nullable<DateTime> * Nullable<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskGroupQueryOrder> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.DistributedTask.WebApi.TaskGroup>>

Parameters

project
String

Project ID or project name

taskGroupId
Nullable<Guid>

Id of the task group.

expanded
Nullable<Boolean>

'true' to recursively expand task groups. Default is 'false'.

taskIdFilter
Nullable<Guid>

Guid of the taskId to filter.

deleted
Nullable<Boolean>

'true'to include deleted task groups. Default is 'false'.

top
Nullable<Int32>

Number of task groups to get.

continuationToken
Nullable<DateTime>

Gets the task groups after the continuation token provided.

queryOrder
Nullable<TaskGroupQueryOrder>

Gets the results in the defined order. Default is 'CreatedOnDescending'.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<TaskGroup>>

Applies to