DashboardRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla používat (odvozená z) k vytváření požadavků na rozhraní REST api služby VSS

Extends

RestClientBase

Konstruktory

DashboardRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

createDashboard(Dashboard, TeamContext)	Vytvořte zadaný řídicí panel.
createWidget(Widget, TeamContext, string)	Na zadaném řídicím panelu vytvořte widget.
deleteDashboard(TeamContext, string)	Odstranění řídicího panelu s jeho ID Tím se odstraní také widgety přidružené k tomuto řídicímu panelu.
deleteWidget(TeamContext, string, string)	Odstraňte zadaný widget.
getDashboard(TeamContext, string)	Získání řídicího panelu podle jeho ID
getDashboardsByProject(TeamContext)	Získejte seznam řídicích panelů v rámci projektu.
getWidget(TeamContext, string, string)	Získejte aktuální stav zadané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 zadaného řídicího panelu. Nahradí seznam widgetů na řídicím panelu, pouze pokud je zadána vlastnost.
replaceDashboards(DashboardGroup, TeamContext)	Aktualizujte název a umístění řídicích panelů v zadané skupině a odeberte vynechané řídicí panely. Neupravuje obsah řídicího panelu.
replaceWidget(Widget, TeamContext, string, string)	Přepište stav zadaného widgetu.
updateWidget(Widget, TeamContext, string, string)	Proveďte částečnou aktualizaci zadané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 zadaný řídicí panel.

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

Parametry

dashboard

Dashboard

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

teamContext

TeamContext

Kontext týmu pro operaci

Návraty

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Na zadaném řídicím panelu vytvořte widget.

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

Parametry

widget

Widget

Stav widgetu, který se má přidat

teamContext

TeamContext

Kontext týmu pro operaci

dashboardId

string

ID řídicího panelu, na který se widget přidá.

Návraty

Promise<Widget>

deleteDashboard(TeamContext, string)

Odstranění řídicího panelu s jeho ID Tím se odstraní také widgety přidružené k tomuto řídicímu panelu.

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

Parametry

teamContext

TeamContext

Kontext týmu pro operaci

dashboardId

string

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

Návraty

Promise<void>

deleteWidget(TeamContext, string, string)

Odstraňte zadaný widget.

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

Parametry

teamContext

TeamContext

Kontext týmu pro operaci

dashboardId

string

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

widgetId

string

ID widgetu, který se má aktualizovat.

Návraty

Promise<Dashboard>

getDashboard(TeamContext, string)

Získání řídicího panelu podle jeho ID

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

Parametry

teamContext

TeamContext

Kontext týmu pro operaci

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

Kontext týmu pro operaci

Návraty

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

Získejte aktuální stav zadaného widgetu.

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

Parametry

teamContext

TeamContext

Kontext týmu pro operaci

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 zadaného řídicího panelu. Nahradí seznam widgetů na řídicím panelu, pouze pokud je zadána vlastnost.

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

Parametry

dashboard

Dashboard

Konfigurace řídicího panelu, který se má nahradit.

teamContext

TeamContext

Kontext týmu pro operaci

dashboardId

string

ID řídicího panelu, který se má nahradit.

Návraty

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Aktualizujte název a umístění řídicích panelů v zadané skupině a odeberte vynechané řídicí panely. Neupravuje obsah řídicího panelu.

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

Parametry

group

DashboardGroup

teamContext

TeamContext

Kontext týmu pro operaci

Návraty

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

Přepište stav zadaného widgetu.

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

Parametry

widget

Widget

Stav, který se má zapsat pro widget.

teamContext

TeamContext

Kontext týmu pro operaci

dashboardId

string

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

widgetId

string

ID widgetu, který se má aktualizovat.

Návraty

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

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

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

Parametry

widget

Widget

Popis změn widgetu, které se mají použít. Všechna pole, která nejsou null, budou nahrazena.

teamContext

TeamContext

Kontext týmu pro operaci

dashboardId

string

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

widgetId

string

ID widgetu, který se má aktualizovat.

Návraty

Promise<Widget>