DashboardRestClient class

Pakiet:

azure-devops-extension-api

Klasa podstawowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends

RestClientBase

Konstruktory

DashboardRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

createDashboard(Dashboard, TeamContext)	Utwórz podany pulpit nawigacyjny.
createWidget(Widget, TeamContext, string)	Utwórz widżet na określonym pulpicie nawigacyjnym.
deleteDashboard(TeamContext, string)	Usuń pulpit nawigacyjny z identyfikatorem. Spowoduje to również usunięcie widżetów skojarzonych z tym pulpitem nawigacyjnym.
deleteWidget(TeamContext, string, string)	Usuń określony widżet.
getDashboard(TeamContext, string)	Pobierz pulpit nawigacyjny według jego identyfikatora.
getDashboardsByProject(TeamContext)	Pobierz listę pulpitów nawigacyjnych w projekcie.
getWidget(TeamContext, string, string)	Pobierz bieżący stan określonego widżetu.
getWidgetMetadata(string, string)	Pobierz metadane widżetu spełniające określony identyfikator udziału.
getWidgetTypes(WidgetScope, string)	Pobierz wszystkie dostępne metadane widżetu w kolejności alfabetycznej, w tym widżety oznaczone ciągiem isVisibleFromCatalog == false.
replaceDashboard(Dashboard, TeamContext, string)	Zastąp konfigurację określonego pulpitu nawigacyjnego. Zastępuje listę widżetów na pulpicie nawigacyjnym tylko wtedy, gdy podano właściwość.
replaceDashboards(DashboardGroup, TeamContext)	Zaktualizuj nazwę i położenie pulpitów nawigacyjnych w podanej grupie i usuń pominięte pulpity nawigacyjne. Nie modyfikuje zawartości pulpitu nawigacyjnego.
replaceWidget(Widget, TeamContext, string, string)	Zastąpij stan określonego widżetu.
updateWidget(Widget, TeamContext, string, string)	Wykonaj częściową aktualizację określonego widżetu.

Szczegóły konstruktora

DashboardRestClient(IVssRestClientOptions)

new DashboardRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

createDashboard(Dashboard, TeamContext)

Utwórz podany pulpit nawigacyjny.

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

Parametry

dashboard

Dashboard

Początkowy stan pulpitu nawigacyjnego

teamContext

TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Utwórz widżet na określonym pulpicie nawigacyjnym.

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

Parametry

widget

Widget

Stan widżetu do dodania

teamContext

TeamContext

Kontekst zespołu dla operacji

dashboardId

string

Identyfikator pulpitu nawigacyjnego, do których zostanie dodany widżet.

Zwraca

Promise<Widget>

deleteDashboard(TeamContext, string)

Usuń pulpit nawigacyjny z identyfikatorem. Spowoduje to również usunięcie widżetów skojarzonych z tym pulpitem nawigacyjnym.

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

Parametry

teamContext

TeamContext

Kontekst zespołu dla operacji

dashboardId

string

Identyfikator pulpitu nawigacyjnego do usunięcia.

Zwraca

Promise<void>

deleteWidget(TeamContext, string, string)

Usuń określony widżet.

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

Parametry

teamContext

TeamContext

Kontekst zespołu dla operacji

dashboardId

string

Identyfikator pulpitu nawigacyjnego zawierającego widżet.

widgetId

string

Identyfikator widżetu do zaktualizowania.

Zwraca

Promise<Dashboard>

getDashboard(TeamContext, string)

Pobierz pulpit nawigacyjny według jego identyfikatora.

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

Parametry

teamContext

TeamContext

Kontekst zespołu dla operacji

dashboardId

string

Zwraca

Promise<Dashboard>

getDashboardsByProject(TeamContext)

Pobierz listę pulpitów nawigacyjnych w projekcie.

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

Parametry

teamContext

TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

Pobierz bieżący stan określonego widżetu.

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

Parametry

teamContext

TeamContext

Kontekst zespołu dla operacji

dashboardId

string

Identyfikator pulpitu nawigacyjnego zawierającego widżet.

widgetId

string

Identyfikator widżetu do odczytania.

Zwraca

Promise<Widget>

getWidgetMetadata(string, string)

Pobierz metadane widżetu spełniające określony identyfikator udziału.

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

Parametry

contributionId

string

Identyfikator współtworzenia widżetu

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

Pobierz wszystkie dostępne metadane widżetu w kolejności alfabetycznej, w tym widżety oznaczone ciągiem isVisibleFromCatalog == false.

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

Parametry

scope

WidgetScope

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

Zastąp konfigurację określonego pulpitu nawigacyjnego. Zastępuje listę widżetów na pulpicie nawigacyjnym tylko wtedy, gdy podano właściwość.

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

Parametry

dashboard

Dashboard

Konfiguracja pulpitu nawigacyjnego do zastąpienia.

teamContext

TeamContext

Kontekst zespołu dla operacji

dashboardId

string

Identyfikator pulpitu nawigacyjnego do zastąpienia.

Zwraca

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Zaktualizuj nazwę i położenie pulpitów nawigacyjnych w podanej grupie i usuń pominięte pulpity nawigacyjne. Nie modyfikuje zawartości pulpitu nawigacyjnego.

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

Parametry

group

DashboardGroup

teamContext

TeamContext

Kontekst zespołu dla operacji

Zwraca

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

Zastąpij stan określonego widżetu.

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

Parametry

widget

Widget

Stan do zapisania dla widżetu.

teamContext

TeamContext

Kontekst zespołu dla operacji

dashboardId

string

Identyfikator pulpitu nawigacyjnego zawierającego widżet.

widgetId

string

Identyfikator widżetu do zaktualizowania.

Zwraca

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

Wykonaj częściową aktualizację określonego widżetu.

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

Parametry

widget

Widget

Opis zmian widżetu do zastosowania. Wszystkie pola inne niż null zostaną zastąpione.

teamContext

TeamContext

Kontekst zespołu dla operacji

dashboardId

string

Identyfikator pulpitu nawigacyjnego zawierającego widżet.

widgetId

string

Identyfikator widżetu do zaktualizowania.

Zwraca

Promise<Widget>