DashboardRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

DashboardRestClient(IVssRestClientOptions)

Özellikler

RESOURCE_AREA_ID

Yöntemler

createDashboard(Dashboard, TeamContext)	Sağlanan panoyu oluşturun.
createWidget(Widget, TeamContext, string)	Belirtilen panoda bir pencere öğesi oluşturun.
deleteDashboard(TeamContext, string)	Kimliği verilen bir panoyu silin. Bu işlem, bu panoyla ilişkili pencere öğelerini de siler.
deleteWidget(TeamContext, string, string)	Belirtilen pencere öğesini silin.
getDashboard(TeamContext, string)	Kimliğine göre bir pano alın.
getDashboardsByProject(TeamContext)	Bir projenin altındaki panoların listesini alma.
getWidget(TeamContext, string, string)	Belirtilen pencere öğesinin geçerli durumunu alın.
getWidgetMetadata(string, string)	Belirtilen katkı kimliğini karşılayan pencere öğesi meta verilerini alın.
getWidgetTypes(WidgetScope, string)	isVisibleFromCatalog == false ile işaretlenmiş pencere öğeleri de dahil olmak üzere tüm kullanılabilir pencere öğesi meta verilerini alfabetik sırada alın.
replaceDashboard(Dashboard, TeamContext, string)	Belirtilen panonun yapılandırmasını değiştirin. Panodaki Pencere Öğesi listesini yalnızca özellik sağlandığında değiştirir.
replaceDashboards(DashboardGroup, TeamContext)	Sağlanan gruptaki panoların adını ve konumunu güncelleştirin ve atlanmış panoları kaldırın. Pano içeriğini değiştirmez.
replaceWidget(Widget, TeamContext, string, string)	Belirtilen pencere öğesinin durumunu geçersiz kılın.
updateWidget(Widget, TeamContext, string, string)	Belirtilen pencere öğesinin kısmi güncelleştirmesini gerçekleştirin.

Oluşturucu Ayrıntıları

DashboardRestClient(IVssRestClientOptions)

new DashboardRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Özellik Ayrıntıları

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Özellik Değeri

string

Yöntem Ayrıntıları

createDashboard(Dashboard, TeamContext)

Sağlanan panoyu oluşturun.

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

Parametreler

dashboard

Dashboard

Panonun ilk durumu

teamContext

TeamContext

İşlemin ekip bağlamı

Döndürülenler

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Belirtilen panoda bir pencere öğesi oluşturun.

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

Parametreler

widget

Widget

Eklenecek pencere öğesinin durumu

teamContext

TeamContext

İşlemin ekip bağlamı

dashboardId

string

Pencere öğesinin eklendiği panonun kimliği.

Döndürülenler

Promise<Widget>

deleteDashboard(TeamContext, string)

Kimliği verilen bir panoyu silin. Bu işlem, bu panoyla ilişkili pencere öğelerini de siler.

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

Parametreler

teamContext

TeamContext

İşlemin ekip bağlamı

dashboardId

string

Silinecek panonun kimliği.

Döndürülenler

Promise<void>

deleteWidget(TeamContext, string, string)

Belirtilen pencere öğesini silin.

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

Parametreler

teamContext

TeamContext

İşlemin ekip bağlamı

dashboardId

string

Pencere öğesini içeren panonun kimliği.

widgetId

string

Güncelleştirilecek pencere öğesinin kimliği.

Döndürülenler

Promise<Dashboard>

getDashboard(TeamContext, string)

Kimliğine göre bir pano alın.

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

Parametreler

teamContext

TeamContext

İşlemin ekip bağlamı

dashboardId

string

Döndürülenler

Promise<Dashboard>

getDashboardsByProject(TeamContext)

Bir projenin altındaki panoların listesini alma.

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

Parametreler

teamContext

TeamContext

İşlemin ekip bağlamı

Döndürülenler

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

Belirtilen pencere öğesinin geçerli durumunu alın.

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

Parametreler

teamContext

TeamContext

İşlemin ekip bağlamı

dashboardId

string

Pencere öğesini içeren panonun kimliği.

widgetId

string

Okunacak pencere öğesinin kimliği.

Döndürülenler

Promise<Widget>

getWidgetMetadata(string, string)

Belirtilen katkı kimliğini karşılayan pencere öğesi meta verilerini alın.

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

Parametreler

contributionId

string

Pencere Öğesi için Katkı Kimliği

project

string

Proje kimliği veya proje adı

Döndürülenler

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

isVisibleFromCatalog == false ile işaretlenmiş pencere öğeleri de dahil olmak üzere tüm kullanılabilir pencere öğesi meta verilerini alfabetik sırada alın.

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

Parametreler

scope

WidgetScope

project

string

Proje kimliği veya proje adı

Döndürülenler

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

Belirtilen panonun yapılandırmasını değiştirin. Panodaki Pencere Öğesi listesini yalnızca özellik sağlandığında değiştirir.

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

Parametreler

dashboard

Dashboard

Değiştirilecek pano yapılandırması.

teamContext

TeamContext

İşlemin ekip bağlamı

dashboardId

string

Değiştirilecek panonun kimliği.

Döndürülenler

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Sağlanan gruptaki panoların adını ve konumunu güncelleştirin ve atlanmış panoları kaldırın. Pano içeriğini değiştirmez.

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

Parametreler

group

DashboardGroup

teamContext

TeamContext

İşlemin ekip bağlamı

Döndürülenler

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

Belirtilen pencere öğesinin durumunu geçersiz kılın.

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

Parametreler

widget

Widget

Pencere öğesi için yazılacak durum.

teamContext

TeamContext

İşlemin ekip bağlamı

dashboardId

string

Pencere öğesini içeren panonun kimliği.

widgetId

string

Güncelleştirilecek pencere öğesinin kimliği.

Döndürülenler

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

Belirtilen pencere öğesinin kısmi güncelleştirmesini gerçekleştirin.

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

Parametreler

widget

Widget

Uygulanacak pencere öğesi değişikliklerinin açıklaması. Null olmayan tüm alanlar değiştirilir.

teamContext

TeamContext

İşlemin ekip bağlamı

dashboardId

string

Pencere öğesini içeren panonun kimliği.

widgetId

string

Güncelleştirilecek pencere öğesinin kimliği.

Döndürülenler

Promise<Widget>