DashboardRestClient class

Paket:

azure-devops-extension-api

Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen

Extends

RestClientBase

Konstruktoren

DashboardRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

createDashboard(Dashboard, TeamContext)	Erstellen Sie das mitgelieferte Dashboard.
createWidget(Widget, TeamContext, string)	Erstellen Sie ein Widget auf dem angegebenen Dashboard.
deleteDashboard(TeamContext, string)	Löschen Sie ein Dashboard anhand seiner ID. Dadurch werden auch die Widgets gelöscht, die mit diesem Dashboard verknüpft sind.
deleteWidget(TeamContext, string, string)	Löschen Sie das angegebene Widget.
getDashboard(TeamContext, string)	Rufen Sie ein Dashboard anhand seiner ID ab.
getDashboardsByProject(TeamContext)	Rufen Sie eine Liste der Dashboards unter einem Projekt ab.
getWidget(TeamContext, string, string)	Rufen Sie den aktuellen Status des angegebenen Widgets ab.
getWidgetMetadata(string, string)	Rufen Sie die Widget-Metadaten ab, die der angegebenen Beitrags-ID entsprechen.
getWidgetTypes(WidgetScope, string)	Rufen Sie alle verfügbaren Widget-Metadaten in alphabetischer Reihenfolge ab, einschließlich Widgets, die mit isVisibleFromCatalog == false gekennzeichnet sind.
replaceDashboard(Dashboard, TeamContext, string)	Ersetzen Sie die Konfiguration für das angegebene Dashboard. Ersetzt die Widget-Liste im Dashboard nur, wenn die Eigenschaft angegeben ist.
replaceDashboards(DashboardGroup, TeamContext)	Aktualisieren Sie den Namen und die Position von Dashboards in der angegebenen Gruppe, und entfernen Sie ausgelassene Dashboards. Ändert den Dashboard-Inhalt nicht.
replaceWidget(Widget, TeamContext, string, string)	Überschreiben Sie den Status des angegebenen Widgets.
updateWidget(Widget, TeamContext, string, string)	Führen Sie eine Teilaktualisierung des angegebenen Widgets durch.

Details zum Konstruktor

DashboardRestClient(IVssRestClientOptions)

new DashboardRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

createDashboard(Dashboard, TeamContext)

Erstellen Sie das mitgelieferte Dashboard.

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

Parameter

dashboard

Dashboard

Der Anfangszustand des Dashboards

teamContext

TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Erstellen Sie ein Widget auf dem angegebenen Dashboard.

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

Parameter

widget

Widget

Status des hinzuzufügenden Widgets

teamContext

TeamContext

Der Teamkontext für den Vorgang

dashboardId

string

ID des Dashboards, zu dem das Widget hinzugefügt wird.

Gibt zurück

Promise<Widget>

deleteDashboard(TeamContext, string)

Löschen Sie ein Dashboard anhand seiner ID. Dadurch werden auch die Widgets gelöscht, die mit diesem Dashboard verknüpft sind.

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

Parameter

teamContext

TeamContext

Der Teamkontext für den Vorgang

dashboardId

string

ID des zu löschenden Dashboards.

Gibt zurück

Promise<void>

deleteWidget(TeamContext, string, string)

Löschen Sie das angegebene Widget.

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

Parameter

teamContext

TeamContext

Der Teamkontext für den Vorgang

dashboardId

string

ID des Dashboards, das das Widget enthält.

widgetId

string

ID des zu aktualisierenden Widgets.

Gibt zurück

Promise<Dashboard>

getDashboard(TeamContext, string)

Rufen Sie ein Dashboard anhand seiner ID ab.

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

Parameter

teamContext

TeamContext

Der Teamkontext für den Vorgang

dashboardId

string

Gibt zurück

Promise<Dashboard>

getDashboardsByProject(TeamContext)

Rufen Sie eine Liste der Dashboards unter einem Projekt ab.

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

Parameter

teamContext

TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

Rufen Sie den aktuellen Status des angegebenen Widgets ab.

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

Parameter

teamContext

TeamContext

Der Teamkontext für den Vorgang

dashboardId

string

ID des Dashboards, das das Widget enthält.

widgetId

string

ID des auszulesenden Widgets.

Gibt zurück

Promise<Widget>

getWidgetMetadata(string, string)

Rufen Sie die Widget-Metadaten ab, die der angegebenen Beitrags-ID entsprechen.

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

Parameter

contributionId

string

Die ID des Beitrags für das Widget

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

Rufen Sie alle verfügbaren Widget-Metadaten in alphabetischer Reihenfolge ab, einschließlich Widgets, die mit isVisibleFromCatalog == false gekennzeichnet sind.

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

Parameter

scope

WidgetScope

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

Ersetzen Sie die Konfiguration für das angegebene Dashboard. Ersetzt die Widget-Liste im Dashboard nur, wenn die Eigenschaft angegeben ist.

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

Parameter

dashboard

Dashboard

Die Konfiguration des zu ersetzenden Dashboards.

teamContext

TeamContext

Der Teamkontext für den Vorgang

dashboardId

string

ID des zu ersetzenden Dashboards.

Gibt zurück

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Aktualisieren Sie den Namen und die Position von Dashboards in der angegebenen Gruppe, und entfernen Sie ausgelassene Dashboards. Ändert den Dashboard-Inhalt nicht.

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

Parameter

group

DashboardGroup

teamContext

TeamContext

Der Teamkontext für den Vorgang

Gibt zurück

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

Überschreiben Sie den Status des angegebenen Widgets.

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

Parameter

widget

Widget

Status, der für das Widget geschrieben werden soll.

teamContext

TeamContext

Der Teamkontext für den Vorgang

dashboardId

string

ID des Dashboards, das das Widget enthält.

widgetId

string

ID des zu aktualisierenden Widgets.

Gibt zurück

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

Führen Sie eine Teilaktualisierung des angegebenen Widgets durch.

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

Parameter

widget

Widget

Beschreibung der Widget-Änderungen, die übernommen werden sollen. Alle Felder, die nicht NULL sind, werden ersetzt.

teamContext

TeamContext

Der Teamkontext für den Vorgang

dashboardId

string

ID des Dashboards, das das Widget enthält.

widgetId

string

ID des zu aktualisierenden Widgets.

Gibt zurück

Promise<Widget>