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)	删除给定 ID 的仪表板。 此操作还会删除与此仪表板关联的小组件。
deleteWidget(TeamContext, string, string)	删除指定的小组件。
getDashboard(TeamContext, string)	按 ID 获取仪表板。
getDashboardsByProject(TeamContext)	获取项目下的仪表板列表。
getWidget(TeamContext, string, string)	获取指定小组件的当前状态。
getWidgetMetadata(string, string)	获取满足指定贡献 ID 的小组件元数据。
getWidgetTypes(WidgetScope, string)	按字母顺序获取所有可用的小组件元数据，包括标记为 isVisibleFromCatalog == false 的小组件。
replaceDashboard(Dashboard, TeamContext, string)	替换指定仪表板的配置。 仅当提供了 属性时，才替换仪表板上的小组件列表。
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

小组件将添加到仪表板的 ID。

返回

Promise<Widget>

deleteDashboard(TeamContext, string)

删除给定 ID 的仪表板。 此操作还会删除与此仪表板关联的小组件。

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

参数

teamContext

TeamContext

操作的团队上下文

dashboardId

string

要删除的仪表板的 ID。

返回

Promise<void>

deleteWidget(TeamContext, string, string)

删除指定的小组件。

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

参数

teamContext

TeamContext

操作的团队上下文

dashboardId

string

包含小组件的仪表板的 ID。

widgetId

string

要更新的小组件的 ID。

返回

Promise<Dashboard>

getDashboard(TeamContext, string)

按 ID 获取仪表板。

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

包含小组件的仪表板的 ID。

widgetId

string

要读取的小组件的 ID。

返回

Promise<Widget>

getWidgetMetadata(string, string)

获取满足指定贡献 ID 的小组件元数据。

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

参数

contributionId

string

小组件的参与 ID

project

string

项目 ID 或项目名称

返回

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

按字母顺序获取所有可用的小组件元数据，包括标记为 isVisibleFromCatalog == false 的小组件。

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

参数

scope

WidgetScope

project

string

项目 ID 或项目名称

返回

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

替换指定仪表板的配置。 仅当提供了 属性时，才替换仪表板上的小组件列表。

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

参数

dashboard

Dashboard

要替换的仪表板的配置。

teamContext

TeamContext

操作的团队上下文

dashboardId

string

要替换的仪表板的 ID。

返回

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

包含小组件的仪表板的 ID。

widgetId

string

要更新的小组件的 ID。

返回

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

包含小组件的仪表板的 ID。

widgetId

string

要更新的小组件的 ID。

返回

Promise<Widget>