Compartir a través de

ILocationService interface

  • Referencia
Paquete:
azure-devops-extension-api

Servicio para contenido externo para obtener ubicaciones

Métodos

getResourceAreaLocation(string)

Obtiene la dirección URL del área de recursos REST especificada.
getServiceLocation(string, TeamFoundationHostType)

Obtiene la ubicación de un servicio remoto en un tipo de host determinado.
routeUrl(string, {[key: string]: string}, string)

Attemps para crear una dirección URL para la plantilla de ruta y los parámetros especificados. La dirección URL incluirá la ruta de acceso del host. Por ejemplo, si la dirección URL de la página es https://dev.azure.com/foo e intenta crear la dirección URL de configuración de administración para el proyecto "bar", la salida será /foo/bar/_admin.

Esto capturará de forma asincrónica una contribución de ruta si no se ha incluido en los datos de la página.

Detalles del método

getResourceAreaLocation(string)

Obtiene la dirección URL del área de recursos REST especificada.

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

Parámetros

resourceAreaId

string

Identificador del área de recursos

Devoluciones

Promise<string>

getServiceLocation(string, TeamFoundationHostType)

Obtiene la ubicación de un servicio remoto en un tipo de host determinado.

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

Parámetros

serviceInstanceType

string

GUID del tipo de instancia de servicio que se va a buscar.

hostType
TeamFoundationHostType

Tipo de host que se va a buscar (el valor predeterminado es el tipo de host de los datos de página actuales).

Devoluciones

Promise<string>

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

Attemps para crear una dirección URL para la plantilla de ruta y los parámetros especificados. La dirección URL incluirá la ruta de acceso del host. Por ejemplo, si la dirección URL de la página es https://dev.azure.com/foo e intenta crear la dirección URL de configuración de administración para el proyecto "bar", la salida será /foo/bar/_admin.

Esto capturará de forma asincrónica una contribución de ruta si no se ha incluido en los datos de la página.

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

Parámetros

routeId

string

Identificador de la contribución de ruta

routeValues

{[key: string]: string}

Reemplazos de valores de ruta

hostPath

string

Ruta de acceso de host opcional que se va a usar en lugar de la ruta de acceso de host predeterminada para la página.

Devoluciones

Promise<string>