ILocationService interface

Pacote:

azure-devops-extension-api

Serviço para conteúdo externo para obter locais

Métodos

getResourceAreaLocation(string)	Obtém a URL da área de recurso REST fornecida
getServiceLocation(string, TeamFoundationHostType)	Obtém o local de um serviço remoto em um determinado tipo de host.
routeUrl(string, {[key: string]: string}, string)	Attemps para criar uma URL para o modelo de rota e paramaters especificados. A URL incluirá o caminho do host. Por exemplo, se a URL da página for https://dev.azure.com/foo e você tentar criar a URL de configurações de administrador para o projeto "barra", a saída será /foo/bar/_admin. Isso buscará de forma assíncrona uma contribuição de rota se ela não tiver sido incluída nos dados da página.

Detalhes do método

getResourceAreaLocation(string)

Obtém a URL da área de recurso REST fornecida

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

Parâmetros

resourceAreaId

string

ID da área de recurso

Retornos

Promise<string>

getServiceLocation(string, TeamFoundationHostType)

Obtém o local de um serviço remoto em um determinado tipo de host.

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

Parâmetros

serviceInstanceType

string

O GUID do tipo de instância de serviço a ser pesquisada

hostType

TeamFoundationHostType

O tipo de host a ser pesquisado (padrão para o tipo de host dos dados da página atual)

Retornos

Promise<string>

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

Attemps para criar uma URL para o modelo de rota e paramaters especificados. A URL incluirá o caminho do host. Por exemplo, se a URL da página for https://dev.azure.com/foo e você tentar criar a URL de configurações de administrador para o projeto "barra", a saída será /foo/bar/_admin.

Isso buscará de forma assíncrona uma contribuição de rota se ela não tiver sido incluída nos dados da página.

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

Parâmetros

routeId

string

Id da contribuição de rota

routeValues

{[key: string]: string}

Substituições de valor de rota

hostPath

string

Caminho do host opcional a ser usado em vez do caminho de host padrão para a página.

Retornos

Promise<string>