DashboardRestClient class

套件:

azure-devops-extension-api

應該 (衍生自) 的基類對 VSS REST API 提出要求

Extends

RestClientBase

建構函式

DashboardRestClient(IVssRestClientOptions)

屬性

RESOURCE_AREA_ID

方法

createDashboard(Dashboard, TeamContext)	建立提供的儀表板。
createWidget(Widget, TeamContext, string)	在指定的儀表板上建立小工具。
deleteDashboard(TeamContext, string)	刪除指定其識別碼的儀表板。 這也會刪除與此儀表板相關聯的小工具。
deleteWidget(TeamContext, string, string)	刪除指定的小工具。
getDashboard(TeamContext, string)	依其識別碼取得儀表板。
getDashboardsByProject(TeamContext)	取得專案底下的儀表板清單。
getWidget(TeamContext, string, string)	取得指定小工具的目前狀態。
getWidgetMetadata(string, string)	取得滿足指定貢獻識別碼的小工具中繼資料。
getWidgetTypes(WidgetScope, string)	依字母順序取得所有可用的小工具中繼資料，包括標示為 isVisibleFromCatalog == false 的小工具。
replaceDashboard(Dashboard, TeamContext, string)	取代指定儀表板的組態。 只有在提供 屬性時，才會取代儀表板上的 Widget 清單。
replaceDashboards(DashboardGroup, TeamContext)	更新所提供群組中儀表板的名稱和位置，並移除省略的儀表板。 不會修改儀表板內容。
replaceWidget(Widget, TeamContext, string, string)	覆寫指定小工具的狀態。
updateWidget(Widget, TeamContext, string, string)	執行指定小工具的部分更新。

建構函式詳細資料

DashboardRestClient(IVssRestClientOptions)

new DashboardRestClient(options: IVssRestClientOptions)

參數

options

IVssRestClientOptions

屬性詳細資料

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

屬性值

string

方法詳細資料

createDashboard(Dashboard, TeamContext)

建立提供的儀表板。

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

參數

dashboard

Dashboard

儀表板的初始狀態

teamContext

TeamContext

作業的小組內容

傳回

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

在指定的儀表板上建立小工具。

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

參數

widget

Widget

要新增的小工具狀態

teamContext

TeamContext

作業的小組內容

dashboardId

string

將新增小工具的儀表板識別碼。

傳回

Promise<Widget>

deleteDashboard(TeamContext, string)

刪除指定其識別碼的儀表板。 這也會刪除與此儀表板相關聯的小工具。

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

參數

teamContext

TeamContext

作業的小組內容

dashboardId

string

要刪除之儀表板的識別碼。

傳回

Promise<void>

deleteWidget(TeamContext, string, string)

刪除指定的小工具。

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

參數

teamContext

TeamContext

作業的小組內容

dashboardId

string

包含小工具的儀表板識別碼。

widgetId

string

要更新之小工具的識別碼。

傳回

Promise<Dashboard>

getDashboard(TeamContext, string)

依其識別碼取得儀表板。

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

參數

teamContext

TeamContext

作業的小組內容

dashboardId

string

傳回

Promise<Dashboard>

getDashboardsByProject(TeamContext)

取得專案底下的儀表板清單。

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

參數

teamContext

TeamContext

作業的小組內容

傳回

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

取得指定小工具的目前狀態。

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

參數

teamContext

TeamContext

作業的小組內容

dashboardId

string

包含小工具的儀表板識別碼。

widgetId

string

要讀取之小工具的識別碼。

傳回

Promise<Widget>

getWidgetMetadata(string, string)

取得滿足指定貢獻識別碼的小工具中繼資料。

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

參數

contributionId

string

Widget 的貢獻識別碼

project

string

專案識別碼或專案名稱

傳回

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

依字母順序取得所有可用的小工具中繼資料，包括標示為 isVisibleFromCatalog == false 的小工具。

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

參數

scope

WidgetScope

project

string

專案識別碼或專案名稱

傳回

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

取代指定儀表板的組態。 只有在提供 屬性時，才會取代儀表板上的 Widget 清單。

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

參數

dashboard

Dashboard

要取代之儀表板的組態。

teamContext

TeamContext

作業的小組內容

dashboardId

string

要取代之儀表板的識別碼。

傳回

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

更新所提供群組中儀表板的名稱和位置，並移除省略的儀表板。 不會修改儀表板內容。

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

參數

group

DashboardGroup

teamContext

TeamContext

作業的小組內容

傳回

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

覆寫指定小工具的狀態。

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

參數

widget

Widget

要針對小工具寫入的狀態。

teamContext

TeamContext

作業的小組內容

dashboardId

string

包含小工具的儀表板識別碼。

widgetId

string

要更新之小工具的識別碼。

傳回

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

執行指定小工具的部分更新。

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

參數

widget

Widget

要套用的小工具變更描述。 將會取代所有非 Null 欄位。

teamContext

TeamContext

作業的小組內容

dashboardId

string

包含小工具的儀表板識別碼。

widgetId

string

要更新之小工具的識別碼。

傳回

Promise<Widget>