Language

DashboardHttpClientBase.ReplaceWidgetAsync Method

Definition

[Preview API] Override the state of the specified widget.

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

Parameters

widget
Widget

State to be written for the widget.

teamContext
TeamContext

The team context for the operation

dashboardId
Guid

ID of the dashboard containing the widget.

widgetId
Guid

ID of the widget to update.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to