Udostępnij za pośrednictwem

ILocationService interface

  • Odwołanie
Pakiet:
azure-devops-extension-api

Usługa pobierania lokalizacji dla zawartości zewnętrznej

Metody

getResourceAreaLocation(string)

Pobiera adres URL dla danego obszaru zasobów REST
getServiceLocation(string, TeamFoundationHostType)

Pobiera lokalizację usługi zdalnej w danym typie hosta.
routeUrl(string, {[key: string]: string}, string)

Attemps, aby utworzyć adres URL dla określonego szablonu trasy i parametrów. Adres URL będzie zawierać ścieżkę hosta. Jeśli na przykład adres URL strony to https://dev.azure.com/foo i próbujesz utworzyć adres URL ustawień administratora dla projektu "bar", dane wyjściowe będą mieć wartość /foo/bar/_admin.

Spowoduje to asynchroniczne pobranie udziału trasy, jeśli nie zostało ono uwzględnione w danych strony.

Szczegóły metody

getResourceAreaLocation(string)

Pobiera adres URL dla danego obszaru zasobów REST

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

Parametry

resourceAreaId

string

Identyfikator obszaru zasobów

Zwraca

Promise<string>

getServiceLocation(string, TeamFoundationHostType)

Pobiera lokalizację usługi zdalnej w danym typie hosta.

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

Parametry

serviceInstanceType

string

Identyfikator GUID typu wystąpienia usługi do wyszukania

hostType
TeamFoundationHostType

Typ hosta do wyszukania (domyślnie jest to typ hosta bieżących danych strony)

Zwraca

Promise<string>

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

Attemps, aby utworzyć adres URL dla określonego szablonu trasy i parametrów. Adres URL będzie zawierać ścieżkę hosta. Jeśli na przykład adres URL strony to https://dev.azure.com/foo i próbujesz utworzyć adres URL ustawień administratora dla projektu "bar", dane wyjściowe będą mieć wartość /foo/bar/_admin.

Spowoduje to asynchroniczne pobranie udziału trasy, jeśli nie zostało ono uwzględnione w danych strony.

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

Parametry

routeId

string

Identyfikator udziału trasy

routeValues

{[key: string]: string}

Zamiany wartości trasy

hostPath

string

Opcjonalna ścieżka hosta do użycia, a nie domyślna ścieżka hosta dla strony.

Zwraca

Promise<string>