Language

DashboardHttpClientBase.GetWidgetAsync Method

Definition

[Preview API] Get the current state of the specified widget.

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

Parameters

teamContext
TeamContext

The team context for the operation

dashboardId
Guid

ID of the dashboard containing the widget.

widgetId
Guid

ID of the widget to read.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to