DashboardRestClient class
Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS
- Extends
Costruttori
| Dashboard |
Proprietà
| RESOURCE_AREA_ID |
Metodi
| create |
Creare il dashboard fornito. |
| create |
Creare un widget nel dashboard specificato. |
| delete |
Eliminare un dashboard dato il relativo ID. In questo modo vengono eliminati anche i widget associati a questo dashboard. |
| delete |
Eliminare il widget specificato. |
| get |
Ottenere un dashboard in base all'ID. |
| get |
Ottenere un elenco di dashboard in un progetto. |
| get |
Ottenere lo stato corrente del widget specificato. |
| get |
Ottenere i metadati del widget che soddisfano l'ID contributo specificato. |
| get |
Ottenere tutti i metadati del widget disponibili in ordine alfabetico, inclusi i widget contrassegnati con isVisibleFromCatalog == false. |
| replace |
Sostituire la configurazione per il dashboard specificato. Sostituisce l'elenco dei widget nel dashboard, solo se viene fornita la proprietà. |
| replace |
Aggiornare il nome e la posizione dei dashboard nel gruppo fornito e rimuovere i dashboard omessi. Non modifica il contenuto del dashboard. |
| replace |
Eseguire l'override dello stato del widget specificato. |
| update |
Eseguire un aggiornamento parziale del widget specificato. |
Dettagli costruttore
DashboardRestClient(IVssRestClientOptions)
Dettagli proprietà
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringValore della proprietà
string
Dettagli metodo
createDashboard(Dashboard, TeamContext)
Creare il dashboard fornito.
function createDashboard(dashboard: Dashboard, teamContext: TeamContext): Promise<Dashboard>Parametri
- dashboard
- Dashboard
Stato iniziale del dashboard
- teamContext
- TeamContext
Contesto del team per l'operazione
Restituisce
Promise<Dashboard>
createWidget(Widget, TeamContext, string)
Creare un widget nel dashboard specificato.
function createWidget(widget: Widget, teamContext: TeamContext, dashboardId: string): Promise<Widget>Parametri
- widget
- Widget
Stato del widget da aggiungere
- teamContext
- TeamContext
Contesto del team per l'operazione
- dashboardId
-
string
ID del dashboard a cui verrà aggiunto il widget.
Restituisce
Promise<Widget>
deleteDashboard(TeamContext, string)
Eliminare un dashboard dato il relativo ID. In questo modo vengono eliminati anche i widget associati a questo dashboard.
function deleteDashboard(teamContext: TeamContext, dashboardId: string): Promise<void>Parametri
- teamContext
- TeamContext
Contesto del team per l'operazione
- dashboardId
-
string
ID del dashboard da eliminare.
Restituisce
Promise<void>
deleteWidget(TeamContext, string, string)
Eliminare il widget specificato.
function deleteWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard>Parametri
- teamContext
- TeamContext
Contesto del team per l'operazione
- dashboardId
-
string
ID del dashboard contenente il widget.
- widgetId
-
string
ID del widget da aggiornare.
Restituisce
Promise<Dashboard>
getDashboard(TeamContext, string)
Ottenere un dashboard in base all'ID.
function getDashboard(teamContext: TeamContext, dashboardId: string): Promise<Dashboard>Parametri
- teamContext
- TeamContext
Contesto del team per l'operazione
- dashboardId
-
string
Restituisce
Promise<Dashboard>
getDashboardsByProject(TeamContext)
Ottenere un elenco di dashboard in un progetto.
function getDashboardsByProject(teamContext: TeamContext): Promise<Dashboard[]>Parametri
- teamContext
- TeamContext
Contesto del team per l'operazione
Restituisce
Promise<Dashboard[]>
getWidget(TeamContext, string, string)
Ottenere lo stato corrente del widget specificato.
function getWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>Parametri
- teamContext
- TeamContext
Contesto del team per l'operazione
- dashboardId
-
string
ID del dashboard contenente il widget.
- widgetId
-
string
ID del widget da leggere.
Restituisce
Promise<Widget>
getWidgetMetadata(string, string)
Ottenere i metadati del widget che soddisfano l'ID contributo specificato.
function getWidgetMetadata(contributionId: string, project?: string): Promise<WidgetMetadataResponse>Parametri
- contributionId
-
string
ID del contributo per il widget
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<WidgetMetadataResponse>
getWidgetTypes(WidgetScope, string)
Ottenere tutti i metadati del widget disponibili in ordine alfabetico, inclusi i widget contrassegnati con isVisibleFromCatalog == false.
function getWidgetTypes(scope: WidgetScope, project?: string): Promise<WidgetTypesResponse>Parametri
- scope
- WidgetScope
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<WidgetTypesResponse>
replaceDashboard(Dashboard, TeamContext, string)
Sostituire la configurazione per il dashboard specificato. Sostituisce l'elenco dei widget nel dashboard, solo se viene fornita la proprietà.
function replaceDashboard(dashboard: Dashboard, teamContext: TeamContext, dashboardId: string): Promise<Dashboard>Parametri
- dashboard
- Dashboard
Configurazione del dashboard da sostituire.
- teamContext
- TeamContext
Contesto del team per l'operazione
- dashboardId
-
string
ID del dashboard da sostituire.
Restituisce
Promise<Dashboard>
replaceDashboards(DashboardGroup, TeamContext)
Aggiornare il nome e la posizione dei dashboard nel gruppo fornito e rimuovere i dashboard omessi. Non modifica il contenuto del dashboard.
function replaceDashboards(group: DashboardGroup, teamContext: TeamContext): Promise<DashboardGroup>Parametri
- group
- DashboardGroup
- teamContext
- TeamContext
Contesto del team per l'operazione
Restituisce
Promise<DashboardGroup>
replaceWidget(Widget, TeamContext, string, string)
Eseguire l'override dello stato del widget specificato.
function replaceWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>Parametri
- widget
- Widget
Stato da scrivere per il widget.
- teamContext
- TeamContext
Contesto del team per l'operazione
- dashboardId
-
string
ID del dashboard contenente il widget.
- widgetId
-
string
ID del widget da aggiornare.
Restituisce
Promise<Widget>
updateWidget(Widget, TeamContext, string, string)
Eseguire un aggiornamento parziale del widget specificato.
function updateWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>Parametri
- widget
- Widget
Descrizione della modifica del widget da applicare. Tutti i campi non Null verranno sostituiti.
- teamContext
- TeamContext
Contesto del team per l'operazione
- dashboardId
-
string
ID del dashboard contenente il widget.
- widgetId
-
string
ID del widget da aggiornare.
Restituisce
Promise<Widget>
Commenti e suggerimenti
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedere https://aka.ms/ContentUserFeedback.
Invia e visualizza il feedback per