Language

DashboardHttpClientBase.CreateWidgetAsync Method

Definition

[Preview API] Create a widget on the specified dashboard.

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

Parameters

widget
Widget

State of the widget to add

teamContext
TeamContext

The team context for the operation

dashboardId
Guid

ID of dashboard the widget will be added to.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to