Language

DashboardHttpClientBase.GetDashboardAsync Method

Definition

[Preview API] Get a dashboard by its ID.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.Dashboard> GetDashboardAsync(Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext teamContext, Guid dashboardId, object userState = null, System.Threading.CancellationToken cancellationToken = null);
abstract member GetDashboardAsync : Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext * Guid * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.Dashboard>
override this.GetDashboardAsync : Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext * Guid * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.Dashboard>

Parameters

teamContext
TeamContext

The team context for the operation

dashboardId
Guid
userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to