TestHttpClientBase.GetTestSessionsAsync Method

Definition

Namespace:

Microsoft.TeamFoundation.TestManagement.WebApi

Assembly:

Microsoft.TeamFoundation.TestManagement.WebApi.dll

[Preview API] Get a list of test sessions

public virtual System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSession>> GetTestSessionsAsync(Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext teamContext, Nullable<int> period = null, Nullable<bool> allSessions = null, Nullable<bool> includeAllProperties = null, Nullable<Microsoft.TeamFoundation.TestManagement.WebApi.TestSessionSource> source = null, Nullable<bool> includeOnlyCompletedSessions = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);

abstract member GetTestSessionsAsync : Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext * Nullable<int> * Nullable<bool> * Nullable<bool> * Nullable<Microsoft.TeamFoundation.TestManagement.WebApi.TestSessionSource> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSession>>
override this.GetTestSessionsAsync : Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext * Nullable<int> * Nullable<bool> * Nullable<bool> * Nullable<Microsoft.TeamFoundation.TestManagement.WebApi.TestSessionSource> * Nullable<bool> * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.List<Microsoft.TeamFoundation.TestManagement.WebApi.TestSession>>

Parameters

teamContext

TeamContext

The team context for the operation

period

Nullable<Int32>

Period in days from now, for which test sessions are fetched.

allSessions

Nullable<Boolean>

If false, returns test sessions for current user. Otherwise, it returns test sessions for all users

includeAllProperties

Nullable<Boolean>

If true, it returns all properties of the test sessions. Otherwise, it returns the skinny version.

source

Nullable<TestSessionSource>

Source of the test session.

includeOnlyCompletedSessions

Nullable<Boolean>

If true, it returns test sessions in completed state. Otherwise, it returns test sessions for all states

userState

Object

cancellationToken

CancellationToken

The cancellation token to cancel operation.

Returns

Task<List<TestSession>>