DashboardRestClient class

new DashboardRestClient(options: IVssRestClientOptions)

Parameter

static RESOURCE_AREA_ID: string

Eigenschaftswert

Erstellen Sie die angegebene Dashboard.

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

Parameter

Gibt zurück

Erstellen Sie ein Widget für die angegebene Dashboard.

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

Parameter

Gibt zurück

Löschen Sie eine Dashboard mit ihrer ID. Dadurch werden auch die Widgets gelöscht, die diesem Dashboard zugeordnet sind.

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

Parameter

Gibt zurück

Löschen Sie das angegebene Widget.

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

Parameter

Gibt zurück

Rufen Sie einen Dashboard anhand seiner ID ab.

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

Parameter

Gibt zurück

Rufen Sie eine Liste der Dashboards unter einem Projekt ab.

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

Parameter

Gibt zurück

Ruft den aktuellen Zustand des angegebenen Widgets ab.

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

Parameter

Gibt zurück

Rufen Sie die Widgetmetadaten ab, die die angegebene Beitrags-ID erfüllen.

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

Parameter

Gibt zurück

Rufen Sie alle verfügbaren Widgetmetadaten in alphabetischer Reihenfolge ab, einschließlich widgets, die mit isVisibleFromCatalog == false gekennzeichnet sind.

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

Parameter

Gibt zurück

Ersetzen Sie die Konfiguration für die angegebene Dashboard. Ersetzt die Widgetliste im Dashboard nur, wenn die -Eigenschaft angegeben wird.

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

Parameter

Gibt zurück

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

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

Parameter

Gibt zurück

Überschreiben Sie den Status des angegebenen Widgets.

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

Parameter

Gibt zurück

Führen Sie eine partielle Aktualisierung des angegebenen Widgets aus.

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

Parameter

Gibt zurück