DashboardRestClient class

Paket:

azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas

RestClientBase

Konstruktor

DashboardRestClient(IVssRestClientOptions)

Properti

RESOURCE_AREA_ID

Metode

createDashboard(Dashboard, TeamContext)	Buat dasbor yang disediakan.
createWidget(Widget, TeamContext, string)	Buat widget di dasbor yang ditentukan.
deleteDashboard(TeamContext, string)	Hapus dasbor yang diberikan ID-nya. Ini juga menghapus widget yang terkait dengan dasbor ini.
deleteWidget(TeamContext, string, string)	Hapus widget yang ditentukan.
getDashboard(TeamContext, string)	Dapatkan dasbor dengan ID-nya.
getDashboardsByProject(TeamContext)	Dapatkan daftar dasbor di bawah proyek.
getWidget(TeamContext, string, string)	Dapatkan status widget yang ditentukan saat ini.
getWidgetMetadata(string, string)	Dapatkan metadata widget yang memenuhi ID kontribusi yang ditentukan.
getWidgetTypes(WidgetScope, string)	Dapatkan semua metadata widget yang tersedia dalam urutan alfabet, termasuk widget yang ditandai dengan isVisibleFromCatalog == false.
replaceDashboard(Dashboard, TeamContext, string)	Ganti konfigurasi untuk dasbor yang ditentukan. Mengganti daftar Widget di Dasbor, hanya jika properti disediakan.
replaceDashboards(DashboardGroup, TeamContext)	Perbarui nama dan posisi dasbor dalam grup yang disediakan, dan hapus dasbor yang dihilangkan. Tidak mengubah konten dasbor.
replaceWidget(Widget, TeamContext, string, string)	Ambil alih status widget yang ditentukan.
updateWidget(Widget, TeamContext, string, string)	Lakukan pembaruan parsial widget yang ditentukan.

Detail Konstruktor

DashboardRestClient(IVssRestClientOptions)

new DashboardRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

createDashboard(Dashboard, TeamContext)

Buat dasbor yang disediakan.

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

Parameter

dashboard

Dashboard

Status awal dasbor

teamContext

TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Buat widget di dasbor yang ditentukan.

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

Parameter

widget

Widget

Status widget yang akan ditambahkan

teamContext

TeamContext

Konteks tim untuk operasi

dashboardId

string

ID dasbor tempat widget akan ditambahkan.

Mengembalikan

Promise<Widget>

deleteDashboard(TeamContext, string)

Hapus dasbor yang diberikan ID-nya. Ini juga menghapus widget yang terkait dengan dasbor ini.

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

Parameter

teamContext

TeamContext

Konteks tim untuk operasi

dashboardId

string

ID dasbor yang akan dihapus.

Mengembalikan

Promise<void>

deleteWidget(TeamContext, string, string)

Hapus widget yang ditentukan.

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

Parameter

teamContext

TeamContext

Konteks tim untuk operasi

dashboardId

string

ID dasbor yang berisi widget.

widgetId

string

ID widget yang akan diperbarui.

Mengembalikan

Promise<Dashboard>

getDashboard(TeamContext, string)

Dapatkan dasbor dengan ID-nya.

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

Parameter

teamContext

TeamContext

Konteks tim untuk operasi

dashboardId

string

Mengembalikan

Promise<Dashboard>

getDashboardsByProject(TeamContext)

Dapatkan daftar dasbor di bawah proyek.

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

Parameter

teamContext

TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

Dapatkan status widget yang ditentukan saat ini.

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

Parameter

teamContext

TeamContext

Konteks tim untuk operasi

dashboardId

string

ID dasbor yang berisi widget.

widgetId

string

ID widget yang akan dibaca.

Mengembalikan

Promise<Widget>

getWidgetMetadata(string, string)

Dapatkan metadata widget yang memenuhi ID kontribusi yang ditentukan.

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

Parameter

contributionId

string

ID Kontribusi untuk Widget

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

Dapatkan semua metadata widget yang tersedia dalam urutan alfabet, termasuk widget yang ditandai dengan isVisibleFromCatalog == false.

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

Parameter

scope

WidgetScope

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

Ganti konfigurasi untuk dasbor yang ditentukan. Mengganti daftar Widget di Dasbor, hanya jika properti disediakan.

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

Parameter

dashboard

Dashboard

Konfigurasi dasbor untuk diganti.

teamContext

TeamContext

Konteks tim untuk operasi

dashboardId

string

ID dasbor untuk diganti.

Mengembalikan

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Perbarui nama dan posisi dasbor dalam grup yang disediakan, dan hapus dasbor yang dihilangkan. Tidak mengubah konten dasbor.

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

Parameter

group

DashboardGroup

teamContext

TeamContext

Konteks tim untuk operasi

Mengembalikan

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

Ambil alih status widget yang ditentukan.

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

Parameter

widget

Widget

Status yang akan ditulis untuk widget.

teamContext

TeamContext

Konteks tim untuk operasi

dashboardId

string

ID dasbor yang berisi widget.

widgetId

string

ID widget yang akan diperbarui.

Mengembalikan

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

Lakukan pembaruan parsial widget yang ditentukan.

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

Parameter

widget

Widget

Deskripsi perubahan widget yang akan diterapkan. Semua bidang non-null akan diganti.

teamContext

TeamContext

Konteks tim untuk operasi

dashboardId

string

ID dasbor yang berisi widget.

widgetId

string

ID widget yang akan diperbarui.

Mengembalikan

Promise<Widget>