DashboardRestClient class
Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS
- Extends
Construtores
| Dashboard |
Propriedades
| RESOURCE_AREA_ID |
Métodos
| create |
Crie o dashboard fornecido. |
| create |
Crie um widget no dashboard especificado. |
| delete |
Exclua um dashboard dada sua ID. Isso também exclui os widgets associados a esse dashboard. |
| delete |
Exclua o widget especificado. |
| get |
Obtenha um dashboard por sua ID. |
| get |
Obtenha uma lista de painéis em um projeto. |
| get |
Obtenha o estado atual do widget especificado. |
| get |
Obtenha os metadados do widget que satisfazem a ID de contribuição especificada. |
| get |
Obtenha todos os metadados de widget disponíveis em ordem alfabética, incluindo widgets marcados com isVisibleFromCatalog == false. |
| replace |
Substitua a configuração do dashboard especificado. Substitui a lista widget no Painel, somente se a propriedade for fornecida. |
| replace |
Atualize o nome e a posição dos painéis no grupo fornecido e remova os painéis omitidos. Não modifica dashboard conteúdo. |
| replace |
Substitua o estado do widget especificado. |
| update |
Execute uma atualização parcial do widget especificado. |
Detalhes do construtor
DashboardRestClient(IVssRestClientOptions)
Detalhes da propriedade
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValor da propriedade
string
Detalhes do 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 equipe para a operação
Retornos
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 ser adicionado
- teamContext
- TeamContext
O contexto da equipe para a operação
- dashboardId
-
string
ID de dashboard ao qual o widget será adicionado.
Retornos
Promise<Widget>
deleteDashboard(TeamContext, string)
Exclua um dashboard dada sua ID. Isso também exclui os widgets associados a esse dashboard.
function deleteDashboard(teamContext: TeamContext, dashboardId: string): Promise<void>Parâmetros
- teamContext
- TeamContext
O contexto da equipe para a operação
- dashboardId
-
string
ID do dashboard a ser excluído.
Retornos
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 dashboard que contém o widget.
- widgetId
-
string
ID do widget a ser atualizado.
Retornos
Promise<Dashboard>
getDashboard(TeamContext, string)
Obtenha um dashboard por sua ID.
function getDashboard(teamContext: TeamContext, dashboardId: string): Promise<Dashboard>Parâmetros
- teamContext
- TeamContext
O contexto da equipe para a operação
- dashboardId
-
string
Retornos
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
Retornos
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 dashboard que contém o widget.
- widgetId
-
string
ID do widget a ser lido.
Retornos
Promise<Widget>
getWidgetMetadata(string, string)
Obtenha os metadados do widget que satisfazem a ID de contribuição especificada.
function getWidgetMetadata(contributionId: string, project?: string): Promise<WidgetMetadataResponse>Parâmetros
- contributionId
-
string
A ID da Contribuição para o Widget
- project
-
string
ID do projeto ou nome do projeto
Retornos
Promise<WidgetMetadataResponse>
getWidgetTypes(WidgetScope, string)
Obtenha todos os metadados de widget 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
Retornos
Promise<WidgetTypesResponse>
replaceDashboard(Dashboard, TeamContext, string)
Substitua a configuração do dashboard especificado. Substitui a lista widget no Painel, somente 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 ser substituída.
- teamContext
- TeamContext
O contexto da equipe para a operação
- dashboardId
-
string
ID do dashboard a ser substituído.
Retornos
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 dashboard conteúdo.
function replaceDashboards(group: DashboardGroup, teamContext: TeamContext): Promise<DashboardGroup>Parâmetros
- group
- DashboardGroup
- teamContext
- TeamContext
O contexto da equipe para a operação
Retornos
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 gravado para o widget.
- teamContext
- TeamContext
O contexto da equipe para a operação
- dashboardId
-
string
ID do dashboard que contém o widget.
- widgetId
-
string
ID do widget a ser atualizado.
Retornos
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 dashboard que contém o widget.
- widgetId
-
string
ID do widget a ser atualizado.
Retornos
Promise<Widget>
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de