DashboardRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends

RestClientBase

Konstruktory

DashboardRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

createDashboard(Dashboard, TeamContext)	Vytvořte dodaný řídicí panel.
createWidget(Widget, TeamContext, string)	Vytvořte widget na určeném řídicím panelu.
deleteDashboard(TeamContext, string)	Odstraňte řídicí panel s jeho ID. Tím odstraníte také widgety spojené s tímto panelem.
deleteWidget(TeamContext, string, string)	Odstraňte určený widget.
getDashboard(TeamContext, string)	Získejte řídicí panel podle jeho ID.
getDashboardsByProject(TeamContext)	Získejte seznam řídicích panelů v rámci projektu.
getWidget(TeamContext, string, string)	Získejte aktuální stav určeného widgetu.
getWidgetMetadata(string, string)	Získejte metadata widgetu splňující zadané ID příspěvku.
getWidgetTypes(WidgetScope, string)	Získejte všechna dostupná metadata widgetů v abecedním pořadí, včetně widgetů označených isVisibleFromCatalog == false.
replaceDashboard(Dashboard, TeamContext, string)	Nahraďte konfiguraci pro zadaný řídicí panel. Nahrazuje seznam widgetů na Dashboardu, pouze pokud je zadána vlastnost.
replaceDashboards(DashboardGroup, TeamContext)	Aktualizujte název a pozici panelů v zadané skupině a odstraňte vynechané panely. Nemění obsah panelu.
replaceWidget(Widget, TeamContext, string, string)	Přepíše stav určeného widgetu.
updateWidget(Widget, TeamContext, string, string)	Proveďte částečnou aktualizaci určeného widgetu.

Podrobnosti konstruktoru

DashboardRestClient(IVssRestClientOptions)

new DashboardRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

createDashboard(Dashboard, TeamContext)

Vytvořte dodaný řídicí panel.

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

Parametry

dashboard

Dashboard

Počáteční stav řídicího panelu

teamContext

TeamContext

Týmový kontext operace

Návraty

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Vytvořte widget na určeném řídicím panelu.

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

Parametry

widget

Widget

Stav widgetu, který chcete přidat

teamContext

TeamContext

Týmový kontext operace

dashboardId

string

ID řídicího panelu, do kterého bude widget přidán.

Návraty

Promise<Widget>

deleteDashboard(TeamContext, string)

Odstraňte řídicí panel s jeho ID. Tím odstraníte také widgety spojené s tímto panelem.

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

Parametry

teamContext

TeamContext

Týmový kontext operace

dashboardId

string

ID řídicího panelu, který chcete odstranit.

Návraty

Promise<void>

deleteWidget(TeamContext, string, string)

Odstraňte určený widget.

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

Parametry

teamContext

TeamContext

Týmový kontext operace

dashboardId

string

ID řídicího panelu obsahujícího widget.

widgetId

string

ID widgetu, který chcete aktualizovat.

Návraty

Promise<Dashboard>

getDashboard(TeamContext, string)

Získejte řídicí panel podle jeho ID.

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

Parametry

teamContext

TeamContext

Týmový kontext operace

dashboardId

string

Návraty

Promise<Dashboard>

getDashboardsByProject(TeamContext)

Získejte seznam řídicích panelů v rámci projektu.

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

Parametry

teamContext

TeamContext

Týmový kontext operace

Návraty

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

Získejte aktuální stav určeného widgetu.

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

Parametry

teamContext

TeamContext

Týmový kontext operace

dashboardId

string

ID řídicího panelu obsahujícího widget.

widgetId

string

ID widgetu, který chcete přečíst.

Návraty

Promise<Widget>

getWidgetMetadata(string, string)

Získejte metadata widgetu splňující zadané ID příspěvku.

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

Parametry

contributionId

string

ID příspěvku pro widget

project

string

ID projektu nebo název projektu

Návraty

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

Získejte všechna dostupná metadata widgetů v abecedním pořadí, včetně widgetů označených isVisibleFromCatalog == false.

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

Parametry

scope

WidgetScope

project

string

ID projektu nebo název projektu

Návraty

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

Nahraďte konfiguraci pro zadaný řídicí panel. Nahrazuje seznam widgetů na Dashboardu, pouze pokud je zadána vlastnost.

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

Parametry

dashboard

Dashboard

Konfigurace řídicího panelu, který chcete nahradit.

teamContext

TeamContext

Týmový kontext operace

dashboardId

string

ID řídicího panelu, který chcete nahradit.

Návraty

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Aktualizujte název a pozici panelů v zadané skupině a odstraňte vynechané panely. Nemění obsah panelu.

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

Parametry

group

DashboardGroup

teamContext

TeamContext

Týmový kontext operace

Návraty

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

Přepíše stav určeného widgetu.

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

Parametry

widget

Widget

Stav, který má být zapsán pro widget.

teamContext

TeamContext

Týmový kontext operace

dashboardId

string

ID řídicího panelu obsahujícího widget.

widgetId

string

ID widgetu, který chcete aktualizovat.

Návraty

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

Proveďte částečnou aktualizaci určeného widgetu.

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

Parametry

widget

Widget

Popis widgetu se má použít. Všechna nenulová pole budou nahrazena.

teamContext

TeamContext

Týmový kontext operace

dashboardId

string

ID řídicího panelu obsahujícího widget.

widgetId

string

ID widgetu, který chcete aktualizovat.

Návraty

Promise<Widget>