Compartir a través de

IHostNavigationService interface

Paquete:
azure-devops-extension-api

Servicio para interactuar con la navegación de la ventana host (direcciones URL, nuevas ventanas, etc.)

Métodos

getHash()

Obtiene el hash actual.
getPageNavigationElements()

Obtiene el conjunto de elementos de navegación (como centros y grupos de concentradores) seleccionados en la página actual.
getPageRoute()

Obtiene información sobre la ruta que se ha emparejado para la página actual
getQueryParams()

Obtiene el conjunto actual de parámetros de consulta en la dirección URL de la página host.
navigate(string)

Navegue por la página principal hasta la URL especificada
onHashChanged((hash: string) => void)

Agregue una devolución de llamada para que se invoque cada vez que cambie la navegación hash
openNewWindow(string, string)

Abrir una nueva ventana a la URL especificada
reload()

Vuelve a cargar el marco principal
replaceHash(string)

Reemplace el hash existente por el hash proporcionado del contenido hospedado.
setDocumentTitle(string)

Actualice el título del documento host (aparece como el título de la pestaña del navegador).
setHash(string)

Establece el hash proporcionado del contenido hospedado.
setQueryParams({[key: string]: string})

Establece uno o varios parámetros de consulta en la página host

Detalles del método

getHash()

Obtiene el hash actual.

function getHash(): Promise<string>

Devoluciones

Promise<string>

getPageNavigationElements()

Obtiene el conjunto de elementos de navegación (como centros y grupos de concentradores) seleccionados en la página actual.

function getPageNavigationElements(): Promise<INavigationElement[]>

Devoluciones

Promise<INavigationElement[]>

getPageRoute()

Obtiene información sobre la ruta que se ha emparejado para la página actual

function getPageRoute(): Promise<IPageRoute>

Devoluciones

Promise<IPageRoute>

getQueryParams()

Obtiene el conjunto actual de parámetros de consulta en la dirección URL de la página host.

function getQueryParams(): Promise<{[key: string]: string}>

Devoluciones

Promise<{[key: string]: string}>

navigate(string)

Navegue por la página principal hasta la URL especificada

function navigate(url: string)

Parámetros

url

string

URL a la que navegar

onHashChanged((hash: string) => void)

Agregue una devolución de llamada para que se invoque cada vez que cambie la navegación hash

function onHashChanged(callback: (hash: string) => void)

Parámetros

callback

(hash: string) => void

Método invocado en cada cambio de hash de navegación

openNewWindow(string, string)

Abrir una nueva ventana a la URL especificada

function openNewWindow(url: string, features: string)

Parámetros

url

string

URL de la nueva ventana

features

string

Lista separada por comas de características/especificaciones enviada como el 3er parámetro a window.open. Por ejemplo: "height=400,width=400".

reload()

Vuelve a cargar el marco principal

function reload()

replaceHash(string)

Reemplace el hash existente por el hash proporcionado del contenido hospedado.

function replaceHash(hash: string)

Parámetros

hash

string

setDocumentTitle(string)

Actualice el título del documento host (aparece como el título de la pestaña del navegador).

function setDocumentTitle(title: string)

Parámetros

title

string

El nuevo título de la ventana

setHash(string)

Establece el hash proporcionado del contenido hospedado.

function setHash(hash: string)

Parámetros

hash

string

setQueryParams({[key: string]: string})

Establece uno o varios parámetros de consulta en la página host

function setQueryParams(parameters: {[key: string]: string})

Parámetros

parameters

{[key: string]: string}

Diccionario de parámetros de cadena de consulta para agregar, actualizar o quitar (pasar un valor vacío para quitar)