DashboardRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST API:erna

Extends

RestClientBase

Konstruktorer

DashboardRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

createDashboard(Dashboard, TeamContext)	Skapa den angivna instrumentpanelen.
createWidget(Widget, TeamContext, string)	Skapa en widget på den angivna instrumentpanelen.
deleteDashboard(TeamContext, string)	Ta bort en instrumentpanel med dess ID. Detta tar också bort de widgetar som är associerade med den här instrumentpanelen.
deleteWidget(TeamContext, string, string)	Ta bort den angivna widgeten.
getDashboard(TeamContext, string)	Hämta en instrumentpanel med dess ID.
getDashboardsByProject(TeamContext)	Hämta en lista över instrumentpaneler under ett projekt.
getWidget(TeamContext, string, string)	Hämta det aktuella tillståndet för den angivna widgeten.
getWidgetMetadata(string, string)	Hämta widgetmetadata som uppfyller det angivna bidrags-ID:t.
getWidgetTypes(WidgetScope, string)	Hämta alla tillgängliga widgetmetadata i alfabetisk ordning, inklusive widgetar markerade med isVisibleFromCatalog == false.
replaceDashboard(Dashboard, TeamContext, string)	Ersätt konfigurationen för den angivna instrumentpanelen. Ersätter widgetlistan på instrumentpanelen, endast om egenskapen anges.
replaceDashboards(DashboardGroup, TeamContext)	Uppdatera namn och position för instrumentpaneler i den angivna gruppen och ta bort utelämnade instrumentpaneler. Ändrar inte instrumentpanelens innehåll.
replaceWidget(Widget, TeamContext, string, string)	Åsidosätt tillståndet för den angivna widgeten.
updateWidget(Widget, TeamContext, string, string)	Utför en partiell uppdatering av den angivna widgeten.

Konstruktorinformation

DashboardRestClient(IVssRestClientOptions)

new DashboardRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

createDashboard(Dashboard, TeamContext)

Skapa den angivna instrumentpanelen.

function createDashboard(dashboard: Dashboard, teamContext: TeamContext): Promise<Dashboard>

Parametrar

dashboard

Dashboard

Instrumentpanelens ursprungliga tillstånd

teamContext

TeamContext

Teamkontexten för åtgärden

Returer

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Skapa en widget på den angivna instrumentpanelen.

function createWidget(widget: Widget, teamContext: TeamContext, dashboardId: string): Promise<Widget>

Parametrar

widget

Widget

Status för widgeten som ska läggas till

teamContext

TeamContext

Teamkontexten för åtgärden

dashboardId

string

ID för instrumentpanelen som widgeten läggs till i.

Returer

Promise<Widget>

deleteDashboard(TeamContext, string)

Ta bort en instrumentpanel med dess ID. Detta tar också bort de widgetar som är associerade med den här instrumentpanelen.

function deleteDashboard(teamContext: TeamContext, dashboardId: string): Promise<void>

Parametrar

teamContext

TeamContext

Teamkontexten för åtgärden

dashboardId

string

ID för instrumentpanelen som ska tas bort.

Returer

Promise<void>

deleteWidget(TeamContext, string, string)

Ta bort den angivna widgeten.

function deleteWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard>

Parametrar

teamContext

TeamContext

Teamkontexten för åtgärden

dashboardId

string

ID för instrumentpanelen som innehåller widgeten.

widgetId

string

ID för widgeten som ska uppdateras.

Returer

Promise<Dashboard>

getDashboard(TeamContext, string)

Hämta en instrumentpanel med dess ID.

function getDashboard(teamContext: TeamContext, dashboardId: string): Promise<Dashboard>

Parametrar

teamContext

TeamContext

Teamkontexten för åtgärden

dashboardId

string

Returer

Promise<Dashboard>

getDashboardsByProject(TeamContext)

Hämta en lista över instrumentpaneler under ett projekt.

function getDashboardsByProject(teamContext: TeamContext): Promise<Dashboard[]>

Parametrar

teamContext

TeamContext

Teamkontexten för åtgärden

Returer

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

Hämta det aktuella tillståndet för den angivna widgeten.

function getWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>

Parametrar

teamContext

TeamContext

Teamkontexten för åtgärden

dashboardId

string

ID för instrumentpanelen som innehåller widgeten.

widgetId

string

ID för widgeten som ska läsas.

Returer

Promise<Widget>

getWidgetMetadata(string, string)

Hämta widgetmetadata som uppfyller det angivna bidrags-ID:t.

function getWidgetMetadata(contributionId: string, project?: string): Promise<WidgetMetadataResponse>

Parametrar

contributionId

string

ID för bidrag för widgeten

project

string

Projekt-ID eller projektnamn

Returer

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

Hämta alla tillgängliga widgetmetadata i alfabetisk ordning, inklusive widgetar markerade med isVisibleFromCatalog == false.

function getWidgetTypes(scope: WidgetScope, project?: string): Promise<WidgetTypesResponse>

Parametrar

scope

WidgetScope

project

string

Projekt-ID eller projektnamn

Returer

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

Ersätt konfigurationen för den angivna instrumentpanelen. Ersätter widgetlistan på instrumentpanelen, endast om egenskapen anges.

function replaceDashboard(dashboard: Dashboard, teamContext: TeamContext, dashboardId: string): Promise<Dashboard>

Parametrar

dashboard

Dashboard

Konfigurationen av instrumentpanelen som ska ersättas.

teamContext

TeamContext

Teamkontexten för åtgärden

dashboardId

string

ID för instrumentpanelen som ska ersättas.

Returer

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Uppdatera namn och position för instrumentpaneler i den angivna gruppen och ta bort utelämnade instrumentpaneler. Ändrar inte instrumentpanelens innehåll.

function replaceDashboards(group: DashboardGroup, teamContext: TeamContext): Promise<DashboardGroup>

Parametrar

group

DashboardGroup

teamContext

TeamContext

Teamkontexten för åtgärden

Returer

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

Åsidosätt tillståndet för den angivna widgeten.

function replaceWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>

Parametrar

widget

Widget

Tillstånd som ska skrivas för widgeten.

teamContext

TeamContext

Teamkontexten för åtgärden

dashboardId

string

ID för instrumentpanelen som innehåller widgeten.

widgetId

string

ID för widgeten som ska uppdateras.

Returer

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

Utför en partiell uppdatering av den angivna widgeten.

function updateWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>

Parametrar

widget

Widget

Beskrivning av de widgetändringar som ska tillämpas. Alla fält som inte är null kommer att ersättas.

teamContext

TeamContext

Teamkontexten för åtgärden

dashboardId

string

ID för instrumentpanelen som innehåller widgeten.

widgetId

string

ID för widgeten som ska uppdateras.

Returer

Promise<Widget>