DashboardRestClient class
Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's
- Extends
Constructors
| Dashboard |
Eigenschappen
| RESOURCE_AREA_ID |
Methoden
| create |
Maak het opgegeven dashboard. |
| create |
Maak een widget op het opgegeven dashboard. |
| delete |
Verwijder een dashboard op basis van de id. Hiermee verwijdert u ook de widgets die aan dit dashboard zijn gekoppeld. |
| delete |
Verwijder de opgegeven widget. |
| get |
Een dashboard ophalen op basis van de id. |
| get |
Een lijst met dashboards onder een project ophalen. |
| get |
Haal de huidige status van de opgegeven widget op. |
| get |
Haal de metagegevens van de widget op die voldoen aan de opgegeven bijdrage-id. |
| get |
Haal alle beschikbare metagegevens van de widget op in alfabetische volgorde, inclusief widgets die zijn gemarkeerd met isVisibleFromCatalog == false. |
| replace |
Vervang de configuratie voor het opgegeven dashboard. Vervangt de widgetlijst op het dashboard, alleen als de eigenschap is opgegeven. |
| replace |
Werk de naam en positie van dashboards in de opgegeven groep bij en verwijder weggelaten dashboards. Hiermee wordt de inhoud van het dashboard niet gewijzigd. |
| replace |
Overschrijf de status van de opgegeven widget. |
| update |
Voer een gedeeltelijke update van de opgegeven widget uit. |
Constructordetails
DashboardRestClient(IVssRestClientOptions)
Eigenschapdetails
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringWaarde van eigenschap
string
Methodedetails
createDashboard(Dashboard, TeamContext)
Maak het opgegeven dashboard.
function createDashboard(dashboard: Dashboard, teamContext: TeamContext): Promise<Dashboard>Parameters
- dashboard
- Dashboard
De beginstatus van het dashboard
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<Dashboard>
createWidget(Widget, TeamContext, string)
Maak een widget op het opgegeven dashboard.
function createWidget(widget: Widget, teamContext: TeamContext, dashboardId: string): Promise<Widget>Parameters
- widget
- Widget
Status van de widget die u wilt toevoegen
- teamContext
- TeamContext
De teamcontext voor de bewerking
- dashboardId
-
string
Id van het dashboard waaraan de widget wordt toegevoegd.
Retouren
Promise<Widget>
deleteDashboard(TeamContext, string)
Verwijder een dashboard op basis van de id. Hiermee verwijdert u ook de widgets die aan dit dashboard zijn gekoppeld.
function deleteDashboard(teamContext: TeamContext, dashboardId: string): Promise<void>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- dashboardId
-
string
Id van het dashboard dat moet worden verwijderd.
Retouren
Promise<void>
deleteWidget(TeamContext, string, string)
Verwijder de opgegeven widget.
function deleteWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- dashboardId
-
string
Id van het dashboard met de widget.
- widgetId
-
string
Id van de widget die moet worden bijgewerkt.
Retouren
Promise<Dashboard>
getDashboard(TeamContext, string)
Een dashboard ophalen op basis van de id.
function getDashboard(teamContext: TeamContext, dashboardId: string): Promise<Dashboard>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- dashboardId
-
string
Retouren
Promise<Dashboard>
getDashboardsByProject(TeamContext)
Een lijst met dashboards onder een project ophalen.
function getDashboardsByProject(teamContext: TeamContext): Promise<Dashboard[]>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<Dashboard[]>
getWidget(TeamContext, string, string)
Haal de huidige status van de opgegeven widget op.
function getWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>Parameters
- teamContext
- TeamContext
De teamcontext voor de bewerking
- dashboardId
-
string
Id van het dashboard met de widget.
- widgetId
-
string
Id van de widget die moet worden gelezen.
Retouren
Promise<Widget>
getWidgetMetadata(string, string)
Haal de metagegevens van de widget op die voldoen aan de opgegeven bijdrage-id.
function getWidgetMetadata(contributionId: string, project?: string): Promise<WidgetMetadataResponse>Parameters
- contributionId
-
string
De id van de bijdrage voor de widget
- project
-
string
Project-id of projectnaam
Retouren
Promise<WidgetMetadataResponse>
getWidgetTypes(WidgetScope, string)
Haal alle beschikbare metagegevens van de widget op in alfabetische volgorde, inclusief widgets die zijn gemarkeerd met isVisibleFromCatalog == false.
function getWidgetTypes(scope: WidgetScope, project?: string): Promise<WidgetTypesResponse>Parameters
- scope
- WidgetScope
- project
-
string
Project-id of projectnaam
Retouren
Promise<WidgetTypesResponse>
replaceDashboard(Dashboard, TeamContext, string)
Vervang de configuratie voor het opgegeven dashboard. Vervangt de widgetlijst op het dashboard, alleen als de eigenschap is opgegeven.
function replaceDashboard(dashboard: Dashboard, teamContext: TeamContext, dashboardId: string): Promise<Dashboard>Parameters
- dashboard
- Dashboard
De configuratie van het dashboard dat moet worden vervangen.
- teamContext
- TeamContext
De teamcontext voor de bewerking
- dashboardId
-
string
Id van het dashboard dat moet worden vervangen.
Retouren
Promise<Dashboard>
replaceDashboards(DashboardGroup, TeamContext)
Werk de naam en positie van dashboards in de opgegeven groep bij en verwijder weggelaten dashboards. Hiermee wordt de inhoud van het dashboard niet gewijzigd.
function replaceDashboards(group: DashboardGroup, teamContext: TeamContext): Promise<DashboardGroup>Parameters
- group
- DashboardGroup
- teamContext
- TeamContext
De teamcontext voor de bewerking
Retouren
Promise<DashboardGroup>
replaceWidget(Widget, TeamContext, string, string)
Overschrijf de status van de opgegeven widget.
function replaceWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>Parameters
- widget
- Widget
Status die moet worden geschreven voor de widget.
- teamContext
- TeamContext
De teamcontext voor de bewerking
- dashboardId
-
string
Id van het dashboard met de widget.
- widgetId
-
string
Id van de widget die moet worden bijgewerkt.
Retouren
Promise<Widget>
updateWidget(Widget, TeamContext, string, string)
Voer een gedeeltelijke update van de opgegeven widget uit.
function updateWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>Parameters
- widget
- Widget
Beschrijving van de widgetwijzigingen die moeten worden toegepast. Alle niet-null-velden worden vervangen.
- teamContext
- TeamContext
De teamcontext voor de bewerking
- dashboardId
-
string
Id van het dashboard met de widget.
- widgetId
-
string
Id van de widget die moet worden bijgewerkt.
Retouren
Promise<Widget>
Feedback
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor