ILocationService interface

Pacchetto:

azure-devops-extension-api

Servizio per contenuti esterni per ottenere le posizioni

Metodi

getResourceAreaLocation(string)	Ottiene l'URL per l'area di risorse REST specificata
getServiceLocation(string, TeamFoundationHostType)	Ottiene la posizione di un servizio remoto in un determinato tipo di host.
routeUrl(string, {[key: string]: string}, string)	Tenta di creare un URL per il modello di percorso e i parametri specificati. L'URL includerà il percorso dell'host. Ad esempio, se l'URL della pagina è https://dev.azure.com/foo e si tenta di creare l'URL delle impostazioni di amministrazione per la "barra" del progetto, l'output sarà /foo/bar/_admin. In questo modo verrà recuperato in modo asincrono un contributo di route se non è stato incluso nei dati della pagina.

Dettagli metodo

getResourceAreaLocation(string)

Ottiene l'URL per l'area di risorse REST specificata

function getResourceAreaLocation(resourceAreaId: string): Promise<string>

Parametri

resourceAreaId

string

ID dell'area delle risorse

Restituisce

Promise<string>

getServiceLocation(string, TeamFoundationHostType)

Ottiene la posizione di un servizio remoto in un determinato tipo di host.

function getServiceLocation(serviceInstanceType?: string, hostType?: TeamFoundationHostType): Promise<string>

Parametri

serviceInstanceType

string

GUID del tipo di istanza del servizio da cercare

hostType

TeamFoundationHostType

Il tipo di host da cercare (per impostazione predefinita viene utilizzato il tipo di host dei dati della pagina corrente)

Restituisce

Promise<string>

routeUrl(string, {[key: string]: string}, string)

Tenta di creare un URL per il modello di percorso e i parametri specificati. L'URL includerà il percorso dell'host. Ad esempio, se l'URL della pagina è https://dev.azure.com/foo e si tenta di creare l'URL delle impostazioni di amministrazione per la "barra" del progetto, l'output sarà /foo/bar/_admin.

In questo modo verrà recuperato in modo asincrono un contributo di route se non è stato incluso nei dati della pagina.

function routeUrl(routeId: string, routeValues?: {[key: string]: string}, hostPath?: string): Promise<string>

Parametri

routeId

string

ID del contributo di percorso

routeValues

{[key: string]: string}

Sostituzioni dei valori di route

hostPath

string

Percorso host facoltativo da utilizzare anziché il percorso host predefinito per la pagina.

Restituisce

Promise<string>