DashboardRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends

RestClientBase

Construtores

DashboardRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

createDashboard(Dashboard, TeamContext)	Crie o dashboard fornecido.
createWidget(Widget, TeamContext, string)	Crie um widget no dashboard especificado.
deleteDashboard(TeamContext, string)	Elimine um dashboard com o respetivo ID. Isto também elimina os widgets associados a este dashboard.
deleteWidget(TeamContext, string, string)	Elimine o widget especificado.
getDashboard(TeamContext, string)	Obtenha um dashboard com o respetivo ID.
getDashboardsByProject(TeamContext)	Obtenha uma lista de dashboards num projeto.
getWidget(TeamContext, string, string)	Obtenha o estado atual do widget especificado.
getWidgetMetadata(string, string)	Obtenha os metadados do widget que satisfazem o ID de contribuição especificado.
getWidgetTypes(WidgetScope, string)	Obtenha todos os metadados de widget disponíveis por ordem alfabética, incluindo widgets marcados com isVisibleFromCatalog == false.
replaceDashboard(Dashboard, TeamContext, string)	Substitua a configuração do dashboard especificado. Substitui a lista de Widget no Dashboard, apenas se a propriedade for fornecida.
replaceDashboards(DashboardGroup, TeamContext)	Atualize o nome e a posição dos dashboards no grupo fornecido e remova dashboards omitidos. Não modifica o conteúdo do dashboard.
replaceWidget(Widget, TeamContext, string, string)	Substitua o estado do widget especificado.
updateWidget(Widget, TeamContext, string, string)	Efetue uma atualização parcial do widget especificado.

Detalhes do Construtor

DashboardRestClient(IVssRestClientOptions)

new DashboardRestClient(options: IVssRestClientOptions)

Parâmetros

options

IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

createDashboard(Dashboard, TeamContext)

Crie o dashboard fornecido.

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

Parâmetros

dashboard

Dashboard

O estado inicial do dashboard

teamContext

TeamContext

O contexto da equipa para a operação

Devoluções

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Crie um widget no dashboard especificado.

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

Parâmetros

widget

Widget

Estado do widget a adicionar

teamContext

TeamContext

O contexto da equipa para a operação

dashboardId

string

ID do dashboard ao que o widget será adicionado.

Devoluções

Promise<Widget>

deleteDashboard(TeamContext, string)

Elimine um dashboard com o respetivo ID. Isto também elimina os widgets associados a este dashboard.

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

Parâmetros

teamContext

TeamContext

O contexto da equipa para a operação

dashboardId

string

ID do dashboard a eliminar.

Devoluções

Promise<void>

deleteWidget(TeamContext, string, string)

Elimine o widget especificado.

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

Parâmetros

teamContext

TeamContext

O contexto da equipa para a operação

dashboardId

string

ID do dashboard que contém o widget.

widgetId

string

ID do widget a atualizar.

Devoluções

Promise<Dashboard>

getDashboard(TeamContext, string)

Obtenha um dashboard com o respetivo ID.

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

Parâmetros

teamContext

TeamContext

O contexto da equipa para a operação

dashboardId

string

Devoluções

Promise<Dashboard>

getDashboardsByProject(TeamContext)

Obtenha uma lista de dashboards num projeto.

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

Parâmetros

teamContext

TeamContext

O contexto da equipa para a operação

Devoluções

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

Obtenha o estado atual do widget especificado.

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

Parâmetros

teamContext

TeamContext

O contexto da equipa para a operação

dashboardId

string

ID do dashboard que contém o widget.

widgetId

string

ID do widget a ler.

Devoluções

Promise<Widget>

getWidgetMetadata(string, string)

Obtenha os metadados do widget que satisfazem o ID de contribuição especificado.

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

Parâmetros

contributionId

string

O ID da Contribuição para o Widget

project

string

ID do Projeto ou nome do projeto

Devoluções

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

Obtenha todos os metadados de widget disponíveis por ordem alfabética, incluindo widgets marcados com isVisibleFromCatalog == false.

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

Parâmetros

scope

WidgetScope

project

string

ID do Projeto ou nome do projeto

Devoluções

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

Substitua a configuração do dashboard especificado. Substitui a lista de Widget no Dashboard, apenas se a propriedade for fornecida.

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

Parâmetros

dashboard

Dashboard

A Configuração do dashboard a substituir.

teamContext

TeamContext

O contexto da equipa para a operação

dashboardId

string

ID do dashboard a substituir.

Devoluções

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Atualize o nome e a posição dos dashboards no grupo fornecido e remova dashboards omitidos. Não modifica o conteúdo do dashboard.

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

Parâmetros

group

DashboardGroup

teamContext

TeamContext

O contexto da equipa para a operação

Devoluções

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

Substitua o estado do widget especificado.

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

Parâmetros

widget

Widget

Estado a escrever para o widget.

teamContext

TeamContext

O contexto da equipa para a operação

dashboardId

string

ID do dashboard que contém o widget.

widgetId

string

ID do widget a atualizar.

Devoluções

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

Efetue uma atualização parcial do widget especificado.

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

Parâmetros

widget

Widget

Descrição das alterações ao widget a aplicar. Todos os campos não nulos serão substituídos.

teamContext

TeamContext

O contexto da equipa para a operação

dashboardId

string

ID do dashboard que contém o widget.

widgetId

string

ID do widget a atualizar.

Devoluções

Promise<Widget>