DashboardRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni

Extends

RestClientBase

Konstruktorok

DashboardRestClient(IVssRestClientOptions)

Tulajdonságok

RESOURCE_AREA_ID

Metódusok

createDashboard(Dashboard, TeamContext)	Hozza létre a megadott irányítópultot.
createWidget(Widget, TeamContext, string)	Hozzon létre egy widgetet a megadott irányítópulton.
deleteDashboard(TeamContext, string)	Irányítópult törlése az azonosítója alapján. Ezzel törli az irányítópulthoz társított widgeteket is.
deleteWidget(TeamContext, string, string)	Törölje a megadott widgetet.
getDashboard(TeamContext, string)	Irányítópult lekérése az azonosítója alapján.
getDashboardsByProject(TeamContext)	Szerezze be a projekt alatti irányítópultok listáját.
getWidget(TeamContext, string, string)	Szerezze be a megadott widget aktuális állapotát.
getWidgetMetadata(string, string)	Szerezze be a widget metaadatait, amelyek megfelelnek a megadott hozzájárulási azonosítónak.
getWidgetTypes(WidgetScope, string)	Szerezze be az összes elérhető widget metaadatot ábécé sorrendben, beleértve az isVisibleFromCatalog == false jelölésű widgeteket is.
replaceDashboard(Dashboard, TeamContext, string)	Cserélje le a megadott irányítópult konfigurációját. Lecseréli a widgetlistát az irányítópulton, csak akkor, ha a tulajdonság meg van adva.
replaceDashboards(DashboardGroup, TeamContext)	Frissítse az irányítópultok nevét és pozícióját a megadott csoportban, és távolítsa el a kihagyott irányítópultokat. Nem módosítja az irányítópult tartalmát.
replaceWidget(Widget, TeamContext, string, string)	Felülbírálja a megadott widget állapotát.
updateWidget(Widget, TeamContext, string, string)	Hajtsa végre a megadott widget részleges frissítését.

Konstruktor adatai

DashboardRestClient(IVssRestClientOptions)

new DashboardRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Tulajdonság adatai

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Tulajdonság értéke

string

Metódus adatai

createDashboard(Dashboard, TeamContext)

Hozza létre a megadott irányítópultot.

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

Paraméterek

dashboard

Dashboard

Az irányítópult kezdeti állapota

teamContext

TeamContext

A művelet csapatkörnyezete

Válaszok

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Hozzon létre egy widgetet a megadott irányítópulton.

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

Paraméterek

widget

Widget

A hozzáadni kívánt felületi elem állapota

teamContext

TeamContext

A művelet csapatkörnyezete

dashboardId

string

Annak az irányítópultnak az azonosítója, amelyhez a widget hozzá lesz adva.

Válaszok

Promise<Widget>

deleteDashboard(TeamContext, string)

Irányítópult törlése az azonosítója alapján. Ezzel törli az irányítópulthoz társított widgeteket is.

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

Paraméterek

teamContext

TeamContext

A művelet csapatkörnyezete

dashboardId

string

A törölni kívánt irányítópult azonosítója.

Válaszok

Promise<void>

deleteWidget(TeamContext, string, string)

Törölje a megadott widgetet.

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

Paraméterek

teamContext

TeamContext

A művelet csapatkörnyezete

dashboardId

string

A widgetet tartalmazó irányítópult azonosítója.

widgetId

string

A frissíteni kívánt widget azonosítója.

Válaszok

Promise<Dashboard>

getDashboard(TeamContext, string)

Irányítópult lekérése az azonosítója alapján.

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

Paraméterek

teamContext

TeamContext

A művelet csapatkörnyezete

dashboardId

string

Válaszok

Promise<Dashboard>

getDashboardsByProject(TeamContext)

Szerezze be a projekt alatti irányítópultok listáját.

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

Paraméterek

teamContext

TeamContext

A művelet csapatkörnyezete

Válaszok

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

Szerezze be a megadott widget aktuális állapotát.

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

Paraméterek

teamContext

TeamContext

A művelet csapatkörnyezete

dashboardId

string

A widgetet tartalmazó irányítópult azonosítója.

widgetId

string

Az olvasni kívánt widget azonosítója.

Válaszok

Promise<Widget>

getWidgetMetadata(string, string)

Szerezze be a widget metaadatait, amelyek megfelelnek a megadott hozzájárulási azonosítónak.

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

Paraméterek

contributionId

string

A widget hozzájárulásának azonosítója

project

string

Projektazonosító vagy projektnév

Válaszok

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

Szerezze be az összes elérhető widget metaadatot ábécé sorrendben, beleértve az isVisibleFromCatalog == false jelölésű widgeteket is.

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

Paraméterek

scope

WidgetScope

project

string

Projektazonosító vagy projektnév

Válaszok

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

Cserélje le a megadott irányítópult konfigurációját. Lecseréli a widgetlistát az irányítópulton, csak akkor, ha a tulajdonság meg van adva.

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

Paraméterek

dashboard

Dashboard

A lecserélni kívánt irányítópult konfigurációja.

teamContext

TeamContext

A művelet csapatkörnyezete

dashboardId

string

A lecserélni kívánt irányítópult azonosítója.

Válaszok

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Frissítse az irányítópultok nevét és pozícióját a megadott csoportban, és távolítsa el a kihagyott irányítópultokat. Nem módosítja az irányítópult tartalmát.

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

Paraméterek

group

DashboardGroup

teamContext

TeamContext

A művelet csapatkörnyezete

Válaszok

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

Felülbírálja a megadott widget állapotát.

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

Paraméterek

widget

Widget

A widgethez írandó állapot.

teamContext

TeamContext

A művelet csapatkörnyezete

dashboardId

string

A widgetet tartalmazó irányítópult azonosítója.

widgetId

string

A frissíteni kívánt widget azonosítója.

Válaszok

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

Hajtsa végre a megadott widget részleges frissítését.

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

Paraméterek

widget

Widget

A widget leírása alkalmazandóvá válik. A rendszer minden nem null mezőt lecserél.

teamContext

TeamContext

A művelet csapatkörnyezete

dashboardId

string

A widgetet tartalmazó irányítópult azonosítója.

widgetId

string

A frissíteni kívánt widget azonosítója.

Válaszok

Promise<Widget>