ILocationService interface

Пакет:

azure-devops-extension-api

Служба для получения расположений для внешнего содержимого

Методы

getResourceAreaLocation(string)	Возвращает URL-адрес для заданной области ресурсов REST.
getServiceLocation(string, TeamFoundationHostType)	Возвращает расположение удаленной службы в заданном типе узла.
routeUrl(string, {[key: string]: string}, string)	Attemps для создания URL-адреса для указанного шаблона маршрута и параметров. URL-адрес будет содержать путь к узлу. Например, если url-адрес страницы — https://dev.azure.com/foo и вы пытаетесь создать URL-адрес параметров администратора для проекта "bar", выходными данными будет /foo/bar/_admin. При этом будет асинхронно получить вклад маршрута, если он не был включен в данные страницы.

Сведения о методе

getResourceAreaLocation(string)

Возвращает URL-адрес для заданной области ресурсов REST.

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

Параметры

resourceAreaId

string

Идентификатор области ресурсов

Возвращаемое значение

Promise<string>

getServiceLocation(string, TeamFoundationHostType)

Возвращает расположение удаленной службы в заданном типе узла.

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

Параметры

serviceInstanceType

string

GUID типа экземпляра службы для поиска

hostType

TeamFoundationHostType

Тип узла для поиска (по умолчанию используется тип узла данных текущей страницы).

Возвращаемое значение

Promise<string>

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

Attemps для создания URL-адреса для указанного шаблона маршрута и параметров. URL-адрес будет содержать путь к узлу. Например, если url-адрес страницы — https://dev.azure.com/foo и вы пытаетесь создать URL-адрес параметров администратора для проекта "bar", выходными данными будет /foo/bar/_admin.

При этом будет асинхронно получить вклад маршрута, если он не был включен в данные страницы.

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

Параметры

routeId

string

Идентификатор вклада маршрута

routeValues

{[key: string]: string}

Замена значений маршрута

hostPath

string

Необязательный путь к узлу, используемый вместо пути узла по умолчанию для страницы.

Возвращаемое значение

Promise<string>