Language

DashboardHttpClientBase.ReplaceDashboardAsync Method

Definition

[Preview API] Replace configuration for the specified dashboard. Replaces Widget list on Dashboard, only if property is supplied.

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

Parameters

dashboard
Dashboard

The Configuration of the dashboard to replace.

teamContext
TeamContext

The team context for the operation

dashboardId
Guid

ID of the dashboard to replace.

userState
Object
cancellationToken
CancellationToken

The cancellation token to cancel operation.

Returns

Applies to