Language

DashboardHttpClientBase.UpdateWidgetAsync Method

Definition

[Preview API] Perform a partial update of the specified widget.

public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.Widget> UpdateWidgetAsync(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 UpdateWidgetAsync : 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.UpdateWidgetAsync : 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

Description of the widget changes to apply. All non-null fields will be replaced.

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