Language

DashboardHttpClientBase.GetWidgetsAsync Method

Definition

[Preview API] Get widgets contained on the specified dashboard.

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

Parameters

teamContext
TeamContext

The team context for the operation

dashboardId
Guid

ID of the dashboard to read.

eTag
String

Dashboard Widgets Version

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to