DashboardRestClient class
Basisklasse, die verwendet (von abgeleitet) werden soll, um Anforderungen an VSS-REST-APIs zu senden
- Extends
Konstruktoren
| Dashboard |
Eigenschaften
| RESOURCE_AREA_ID |
Methoden
| create |
Erstellen Sie die angegebene Dashboard. |
| create |
Erstellen Sie ein Widget für die angegebene Dashboard. |
| delete |
Löschen Sie eine Dashboard mit ihrer ID. Dadurch werden auch die Widgets gelöscht, die diesem Dashboard zugeordnet sind. |
| delete |
Löschen Sie das angegebene Widget. |
| get |
Rufen Sie einen Dashboard anhand seiner ID ab. |
| get |
Rufen Sie eine Liste der Dashboards unter einem Projekt ab. |
| get |
Ruft den aktuellen Zustand des angegebenen Widgets ab. |
| get |
Rufen Sie die Widgetmetadaten ab, die die angegebene Beitrags-ID erfüllen. |
| get |
Rufen Sie alle verfügbaren Widgetmetadaten in alphabetischer Reihenfolge ab, einschließlich widgets, die mit isVisibleFromCatalog == false gekennzeichnet sind. |
| replace |
Ersetzen Sie die Konfiguration für die angegebene Dashboard. Ersetzt die Widgetliste im Dashboard nur, wenn die -Eigenschaft angegeben wird. |
| replace |
Aktualisieren Sie den Namen und die Position der Dashboards in der angegebenen Gruppe, und entfernen Sie ausgelassene Dashboards. Ändert Dashboard Inhalt nicht. |
| replace |
Überschreiben Sie den Status des angegebenen Widgets. |
| update |
Führen Sie eine partielle Aktualisierung des angegebenen Widgets aus. |
Details zum Konstruktor
DashboardRestClient(IVssRestClientOptions)
Details zur Eigenschaft
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringEigenschaftswert
string
Details zur Methode
createDashboard(Dashboard, TeamContext)
Erstellen Sie die angegebene Dashboard.
function createDashboard(dashboard: Dashboard, teamContext: TeamContext): Promise<Dashboard>Parameter
- dashboard
- Dashboard
Der Anfangszustand der Dashboard
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
Gibt zurück
Promise<Dashboard>
createWidget(Widget, TeamContext, string)
Erstellen Sie ein Widget für die angegebene Dashboard.
function createWidget(widget: Widget, teamContext: TeamContext, dashboardId: string): Promise<Widget>Parameter
- widget
- Widget
Status des hinzuzufügenden Widgets
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
- dashboardId
-
string
ID der Dashboard das Widget hinzugefügt wird.
Gibt zurück
Promise<Widget>
deleteDashboard(TeamContext, string)
Löschen Sie eine Dashboard mit ihrer ID. Dadurch werden auch die Widgets gelöscht, die diesem Dashboard zugeordnet sind.
function deleteDashboard(teamContext: TeamContext, dashboardId: string): Promise<void>Parameter
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
- dashboardId
-
string
ID des zu löschenden Dashboard.
Gibt zurück
Promise<void>
deleteWidget(TeamContext, string, string)
Löschen Sie das angegebene Widget.
function deleteWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard>Parameter
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
- dashboardId
-
string
ID der Dashboard, die das Widget enthält.
- widgetId
-
string
ID des zu aktualisierenden Widgets.
Gibt zurück
Promise<Dashboard>
getDashboard(TeamContext, string)
Rufen Sie einen Dashboard anhand seiner ID ab.
function getDashboard(teamContext: TeamContext, dashboardId: string): Promise<Dashboard>Parameter
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
- dashboardId
-
string
Gibt zurück
Promise<Dashboard>
getDashboardsByProject(TeamContext)
Rufen Sie eine Liste der Dashboards unter einem Projekt ab.
function getDashboardsByProject(teamContext: TeamContext): Promise<Dashboard[]>Parameter
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
Gibt zurück
Promise<Dashboard[]>
getWidget(TeamContext, string, string)
Ruft den aktuellen Zustand des angegebenen Widgets ab.
function getWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>Parameter
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
- dashboardId
-
string
ID der Dashboard, die das Widget enthält.
- widgetId
-
string
ID des zu lesenden Widgets.
Gibt zurück
Promise<Widget>
getWidgetMetadata(string, string)
Rufen Sie die Widgetmetadaten ab, die die angegebene Beitrags-ID erfüllen.
function getWidgetMetadata(contributionId: string, project?: string): Promise<WidgetMetadataResponse>Parameter
- contributionId
-
string
Die ID des Beitrags für das Widget
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WidgetMetadataResponse>
getWidgetTypes(WidgetScope, string)
Rufen Sie alle verfügbaren Widgetmetadaten in alphabetischer Reihenfolge ab, einschließlich widgets, die mit isVisibleFromCatalog == false gekennzeichnet sind.
function getWidgetTypes(scope: WidgetScope, project?: string): Promise<WidgetTypesResponse>Parameter
- scope
- WidgetScope
- project
-
string
Projekt-ID oder Projektname
Gibt zurück
Promise<WidgetTypesResponse>
replaceDashboard(Dashboard, TeamContext, string)
Ersetzen Sie die Konfiguration für die angegebene Dashboard. Ersetzt die Widgetliste im Dashboard nur, wenn die -Eigenschaft angegeben wird.
function replaceDashboard(dashboard: Dashboard, teamContext: TeamContext, dashboardId: string): Promise<Dashboard>Parameter
- dashboard
- Dashboard
Die Konfiguration des zu ersetzenden Dashboard.
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
- dashboardId
-
string
ID des zu ersetzenden Dashboard.
Gibt zurück
Promise<Dashboard>
replaceDashboards(DashboardGroup, TeamContext)
Aktualisieren Sie den Namen und die Position der Dashboards in der angegebenen Gruppe, und entfernen Sie ausgelassene Dashboards. Ändert Dashboard Inhalt nicht.
function replaceDashboards(group: DashboardGroup, teamContext: TeamContext): Promise<DashboardGroup>Parameter
- group
- DashboardGroup
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
Gibt zurück
Promise<DashboardGroup>
replaceWidget(Widget, TeamContext, string, string)
Überschreiben Sie den Status des angegebenen Widgets.
function replaceWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>Parameter
- widget
- Widget
Zustand, der für das Widget geschrieben werden soll.
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
- dashboardId
-
string
ID der Dashboard, die das Widget enthält.
- widgetId
-
string
ID des zu aktualisierenden Widgets.
Gibt zurück
Promise<Widget>
updateWidget(Widget, TeamContext, string, string)
Führen Sie eine partielle Aktualisierung des angegebenen Widgets aus.
function updateWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>Parameter
- widget
- Widget
Beschreibung der anzuwendenden Widgetänderungen. Alle Felder ungleich NULL werden ersetzt.
- teamContext
- TeamContext
Der Teamkontext für den Vorgang
- dashboardId
-
string
ID der Dashboard, die das Widget enthält.
- widgetId
-
string
ID des zu aktualisierenden Widgets.
Gibt zurück
Promise<Widget>
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für