DashboardRestClient class

Paquete:

azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

RestClientBase

Constructores

DashboardRestClient(IVssRestClientOptions)

Propiedades

RESOURCE_AREA_ID

Métodos

createDashboard(Dashboard, TeamContext)	Cree el panel proporcionado.
createWidget(Widget, TeamContext, string)	Cree un widget en el panel especificado.
deleteDashboard(TeamContext, string)	Elimine un panel según su identificador. Esto también elimina los widgets asociados a este panel.
deleteWidget(TeamContext, string, string)	Elimine el widget especificado.
getDashboard(TeamContext, string)	Obtenga un panel por su identificador.
getDashboardsByProject(TeamContext)	Obtenga una lista de paneles en un proyecto.
getWidget(TeamContext, string, string)	Obtenga el estado actual del widget especificado.
getWidgetMetadata(string, string)	Obtiene los metadatos del widget que satisfacen el identificador de contribución especificado.
getWidgetTypes(WidgetScope, string)	Obtenga todos los metadatos de widget disponibles en orden alfabético, incluidos los widgets marcados con isVisibleFromCatalog == false.
replaceDashboard(Dashboard, TeamContext, string)	Reemplace la configuración del panel especificado. Reemplaza la lista de widgets en el panel, solo si se proporciona la propiedad .
replaceDashboards(DashboardGroup, TeamContext)	Actualice el nombre y la posición de los paneles del grupo proporcionado y quite los paneles omitidos. No modifica el contenido del panel.
replaceWidget(Widget, TeamContext, string, string)	Invalide el estado del widget especificado.
updateWidget(Widget, TeamContext, string, string)	Realice una actualización parcial del widget especificado.

Detalles del constructor

DashboardRestClient(IVssRestClientOptions)

new DashboardRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles de las propiedades

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de propiedad

string

Detalles del método

createDashboard(Dashboard, TeamContext)

Cree el panel proporcionado.

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

Parámetros

dashboard

Dashboard

Estado inicial del panel

teamContext

TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Cree un widget en el panel especificado.

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

Parámetros

widget

Widget

Estado del widget que se va a agregar

teamContext

TeamContext

Contexto del equipo para la operación

dashboardId

string

Identificador del panel al que se agregará el widget.

Devoluciones

Promise<Widget>

deleteDashboard(TeamContext, string)

Elimine un panel según su identificador. Esto también elimina los widgets asociados a este panel.

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

Parámetros

teamContext

TeamContext

Contexto del equipo para la operación

dashboardId

string

Identificador del panel que se va a eliminar.

Devoluciones

Promise<void>

deleteWidget(TeamContext, string, string)

Elimine el widget especificado.

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

Parámetros

teamContext

TeamContext

Contexto del equipo para la operación

dashboardId

string

Identificador del panel que contiene el widget.

widgetId

string

Identificador del widget que se va a actualizar.

Devoluciones

Promise<Dashboard>

getDashboard(TeamContext, string)

Obtenga un panel por su identificador.

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

Parámetros

teamContext

TeamContext

Contexto del equipo para la operación

dashboardId

string

Devoluciones

Promise<Dashboard>

getDashboardsByProject(TeamContext)

Obtenga una lista de paneles en un proyecto.

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

Parámetros

teamContext

TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

Obtenga el estado actual del widget especificado.

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

Parámetros

teamContext

TeamContext

Contexto del equipo para la operación

dashboardId

string

Identificador del panel que contiene el widget.

widgetId

string

Identificador del widget que se va a leer.

Devoluciones

Promise<Widget>

getWidgetMetadata(string, string)

Obtiene los metadatos del widget que satisfacen el identificador de contribución especificado.

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

Parámetros

contributionId

string

Identificador de contribución para el widget

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

Obtenga todos los metadatos de widget disponibles en orden alfabético, incluidos los widgets marcados con isVisibleFromCatalog == false.

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

Parámetros

scope

WidgetScope

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

Reemplace la configuración del panel especificado. Reemplaza la lista de widgets en el panel, solo si se proporciona la propiedad .

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

Parámetros

dashboard

Dashboard

Configuración del panel que se va a reemplazar.

teamContext

TeamContext

Contexto del equipo para la operación

dashboardId

string

Identificador del panel que se va a reemplazar.

Devoluciones

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Actualice el nombre y la posición de los paneles del grupo proporcionado y quite los paneles omitidos. No modifica el contenido del panel.

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

Parámetros

group

DashboardGroup

teamContext

TeamContext

Contexto del equipo para la operación

Devoluciones

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

Invalide el estado del widget especificado.

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

Parámetros

widget

Widget

Estado que se va a escribir para el widget.

teamContext

TeamContext

Contexto del equipo para la operación

dashboardId

string

Identificador del panel que contiene el widget.

widgetId

string

Identificador del widget que se va a actualizar.

Devoluciones

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

Realice una actualización parcial del widget especificado.

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

Parámetros

widget

Widget

Descripción de los cambios del widget que se van a aplicar. Se reemplazarán todos los campos que no sean NULL.

teamContext

TeamContext

Contexto del equipo para la operación

dashboardId

string

Identificador del panel que contiene el widget.

widgetId

string

Identificador del widget que se va a actualizar.

Devoluciones

Promise<Widget>