DashboardHttpClientBase.UpdateWidgetsAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
[Preview API] Update the supplied widgets on the dashboard using supplied state. State of existing Widgets not passed in the widget list is preserved.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetsVersionedList> UpdateWidgetsAsync(System.Collections.Generic.IEnumerable<Microsoft.TeamFoundation.Dashboards.WebApi.Widget> widgets, Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext teamContext, Guid dashboardId, string eTag = null, object userState = null, System.Threading.CancellationToken cancellationToken = null);abstract member UpdateWidgetsAsync : seq<Microsoft.TeamFoundation.Dashboards.WebApi.Widget> * Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext * Guid * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetsVersionedList>
override this.UpdateWidgetsAsync : seq<Microsoft.TeamFoundation.Dashboards.WebApi.Widget> * Microsoft.TeamFoundation.Core.WebApi.Types.TeamContext * Guid * string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetsVersionedList>Parameters
- widgets
- IEnumerable<Widget>
The set of widget states to update on the dashboard.
- teamContext
- TeamContext
The team context for the operation
- dashboardId
- Guid
ID of the Dashboard to modify.
- eTag
- String
Dashboard Widgets Version
- userState
- Object
- cancellationToken
- CancellationToken
The cancellation token to cancel operation.