DashboardHttpClientBase.ReplaceWidgetsAsync 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] Replace the widgets on specified dashboard with the supplied widgets.
public virtual System.Threading.Tasks.Task<Microsoft.TeamFoundation.Dashboards.WebApi.WidgetsVersionedList> ReplaceWidgetsAsync(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 ReplaceWidgetsAsync : 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.ReplaceWidgetsAsync : 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>
Revised state of widgets to store for 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.