DashboardRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes aux API REST VSS

Extends

RestClientBase

Constructeurs

DashboardRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

createDashboard(Dashboard, TeamContext)	Créez le tableau de bord fourni.
createWidget(Widget, TeamContext, string)	Créez un widget sur le tableau de bord spécifié.
deleteDashboard(TeamContext, string)	Supprimer un tableau de bord en fonction de son ID. Cela supprime également les widgets associés à ce tableau de bord.
deleteWidget(TeamContext, string, string)	Supprimez le widget spécifié.
getDashboard(TeamContext, string)	Obtenez un tableau de bord par son ID.
getDashboardsByProject(TeamContext)	Obtenez la liste des tableaux de bord d’un projet.
getWidget(TeamContext, string, string)	Obtenez l’état actuel du widget spécifié.
getWidgetMetadata(string, string)	Obtenez les métadonnées du widget qui satisfont à l’ID de contribution spécifié.
getWidgetTypes(WidgetScope, string)	Obtenez toutes les métadonnées de widget disponibles dans l’ordre alphabétique, y compris les widgets marqués avec isVisibleFromCatalog == false.
replaceDashboard(Dashboard, TeamContext, string)	Remplacez la configuration du tableau de bord spécifié. Remplace la liste de widgets dans le tableau de bord, uniquement si la propriété est fournie.
replaceDashboards(DashboardGroup, TeamContext)	Mettez à jour le nom et la position des tableaux de bord dans le groupe fourni, et supprimez les tableaux de bord omis. Ne modifie pas le contenu du tableau de bord.
replaceWidget(Widget, TeamContext, string, string)	Remplacez l’état du widget spécifié.
updateWidget(Widget, TeamContext, string, string)	Effectuez une mise à jour partielle du widget spécifié.

Détails du constructeur

DashboardRestClient(IVssRestClientOptions)

new DashboardRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

createDashboard(Dashboard, TeamContext)

Créez le tableau de bord fourni.

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

Paramètres

dashboard

Dashboard

État initial du tableau de bord

teamContext

TeamContext

Contexte d’équipe pour l’opération

Retours

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Créez un widget sur le tableau de bord spécifié.

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

Paramètres

widget

Widget

État du widget à ajouter

teamContext

TeamContext

Contexte d’équipe pour l’opération

dashboardId

string

ID du tableau de bord à laquelle le widget sera ajouté.

Retours

Promise<Widget>

deleteDashboard(TeamContext, string)

Supprimer un tableau de bord en fonction de son ID. Cela supprime également les widgets associés à ce tableau de bord.

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

Paramètres

teamContext

TeamContext

Contexte d’équipe pour l’opération

dashboardId

string

ID du tableau de bord à supprimer.

Retours

Promise<void>

deleteWidget(TeamContext, string, string)

Supprimez le widget spécifié.

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

Paramètres

teamContext

TeamContext

Contexte d’équipe pour l’opération

dashboardId

string

ID du tableau de bord contenant le widget.

widgetId

string

ID du widget à mettre à jour.

Retours

Promise<Dashboard>

getDashboard(TeamContext, string)

Obtenez un tableau de bord par son ID.

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

Paramètres

teamContext

TeamContext

Contexte d’équipe pour l’opération

dashboardId

string

Retours

Promise<Dashboard>

getDashboardsByProject(TeamContext)

Obtenez la liste des tableaux de bord d’un projet.

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

Paramètres

teamContext

TeamContext

Contexte d’équipe pour l’opération

Retours

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

Obtenez l’état actuel du widget spécifié.

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

Paramètres

teamContext

TeamContext

Contexte d’équipe pour l’opération

dashboardId

string

ID du tableau de bord contenant le widget.

widgetId

string

ID du widget à lire.

Retours

Promise<Widget>

getWidgetMetadata(string, string)

Obtenez les métadonnées du widget qui satisfont à l’ID de contribution spécifié.

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

Paramètres

contributionId

string

ID de contribution pour le widget

project

string

ID de projet ou nom du projet

Retours

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

Obtenez toutes les métadonnées de widget disponibles dans l’ordre alphabétique, y compris les widgets marqués avec isVisibleFromCatalog == false.

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

Paramètres

scope

WidgetScope

project

string

ID de projet ou nom du projet

Retours

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

Remplacez la configuration du tableau de bord spécifié. Remplace la liste de widgets dans le tableau de bord, uniquement si la propriété est fournie.

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

Paramètres

dashboard

Dashboard

Configuration du tableau de bord à remplacer.

teamContext

TeamContext

Contexte d’équipe pour l’opération

dashboardId

string

ID du tableau de bord à remplacer.

Retours

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Mettez à jour le nom et la position des tableaux de bord dans le groupe fourni, et supprimez les tableaux de bord omis. Ne modifie pas le contenu du tableau de bord.

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

Paramètres

group

DashboardGroup

teamContext

TeamContext

Contexte d’équipe pour l’opération

Retours

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

Remplacez l’état du widget spécifié.

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

Paramètres

widget

Widget

État à écrire pour le widget.

teamContext

TeamContext

Contexte d’équipe pour l’opération

dashboardId

string

ID du tableau de bord contenant le widget.

widgetId

string

ID du widget à mettre à jour.

Retours

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

Effectuez une mise à jour partielle du widget spécifié.

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

Paramètres

widget

Widget

Description des modifications du widget à appliquer. Tous les champs non null seront remplacés.

teamContext

TeamContext

Contexte d’équipe pour l’opération

dashboardId

string

ID du tableau de bord contenant le widget.

widgetId

string

ID du widget à mettre à jour.

Retours

Promise<Widget>