DashboardRestClient class

Pacote:

azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para APIs REST do VSS

Extends

RestClientBase

Construtores

DashboardRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

createDashboard(Dashboard, TeamContext)	Crie o painel fornecido.
createWidget(Widget, TeamContext, string)	Crie um widget no painel especificado.
deleteDashboard(TeamContext, string)	Exclua um painel de acordo com seu ID. Isso também exclui os widgets associados a este painel.
deleteWidget(TeamContext, string, string)	Exclua o widget especificado.
getDashboard(TeamContext, string)	Obtenha um painel pelo seu ID.
getDashboardsByProject(TeamContext)	Obtenha uma lista de painéis em um projeto.
getWidget(TeamContext, string, string)	Obtenha o estado atual do widget especificado.
getWidgetMetadata(string, string)	Obtenha os metadados do widget satisfazendo o ID de contribuição especificado.
getWidgetTypes(WidgetScope, string)	Obtenha todos os metadados de widgets disponíveis em ordem alfabética, incluindo widgets marcados com isVisibleFromCatalog == false.
replaceDashboard(Dashboard, TeamContext, string)	Substitua a configuração do painel especificado. Substitui a lista de widgets no Dashboard, somente se a propriedade for fornecida.
replaceDashboards(DashboardGroup, TeamContext)	Atualize o nome e a posição dos painéis no grupo fornecido e remova os painéis omitidos. Não modifica o conteúdo do painel.
replaceWidget(Widget, TeamContext, string, string)	Substitua o estado do widget especificado.
updateWidget(Widget, TeamContext, string, string)	Execute 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 painel fornecido.

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

Parâmetros

dashboard

Dashboard

O estado inicial do painel

teamContext

TeamContext

O contexto da equipe para a operação

Devoluções

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Crie um widget no painel especificado.

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

Parâmetros

widget

Widget

Estado do widget a ser adicionado

teamContext

TeamContext

O contexto da equipe para a operação

dashboardId

string

ID do painel ao qual o widget será adicionado.

Devoluções

Promise<Widget>

deleteDashboard(TeamContext, string)

Exclua um painel de acordo com seu ID. Isso também exclui os widgets associados a este painel.

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

Parâmetros

teamContext

TeamContext

O contexto da equipe para a operação

dashboardId

string

ID do painel a ser excluído.

Devoluções

Promise<void>

deleteWidget(TeamContext, string, string)

Exclua o widget especificado.

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

Parâmetros

teamContext

TeamContext

O contexto da equipe para a operação

dashboardId

string

ID do painel que contém o widget.

widgetId

string

ID do widget a ser atualizado.

Devoluções

Promise<Dashboard>

getDashboard(TeamContext, string)

Obtenha um painel pelo seu ID.

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

Parâmetros

teamContext

TeamContext

O contexto da equipe para a operação

dashboardId

string

Devoluções

Promise<Dashboard>

getDashboardsByProject(TeamContext)

Obtenha uma lista de painéis em um projeto.

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

Parâmetros

teamContext

TeamContext

O contexto da equipe 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 equipe para a operação

dashboardId

string

ID do painel que contém o widget.

widgetId

string

ID do widget a ser lido.

Devoluções

Promise<Widget>

getWidgetMetadata(string, string)

Obtenha os metadados do widget satisfazendo 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 widgets disponíveis em 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 painel especificado. Substitui a lista de widgets no Dashboard, somente se a propriedade for fornecida.

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

Parâmetros

dashboard

Dashboard

A configuração do painel a ser substituído.

teamContext

TeamContext

O contexto da equipe para a operação

dashboardId

string

ID do painel a ser substituído.

Devoluções

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Atualize o nome e a posição dos painéis no grupo fornecido e remova os painéis omitidos. Não modifica o conteúdo do painel.

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

Parâmetros

group

DashboardGroup

teamContext

TeamContext

O contexto da equipe 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 ser escrito para o widget.

teamContext

TeamContext

O contexto da equipe para a operação

dashboardId

string

ID do painel que contém o widget.

widgetId

string

ID do widget a ser atualizado.

Devoluções

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

Execute 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 do widget a serem aplicadas. Todos os campos não nulos serão substituídos.

teamContext

TeamContext

O contexto da equipe para a operação

dashboardId

string

ID do painel que contém o widget.

widgetId

string

ID do widget a ser atualizado.

Devoluções

Promise<Widget>