IHostNavigationService interface

Pacchetto:

azure-devops-extension-api

Servizio per interagire con lo spostamento della finestra host (URL, nuove finestre e così via)

Metodi

getHash()	Ottiene l'hash corrente.
getPageNavigationElements()	Ottiene il set di elementi di navigazione (ad esempio hub e gruppi di hub) selezionati nella pagina corrente.
getPageRoute()	Ottiene informazioni sul percorso corrispondente per la pagina corrente
getQueryParams()	Ottiene l'insieme corrente di parametri di query nell'URL della pagina host.
navigate(string)	Naviga nella pagina principale fino all'URL specificato
onHashChanged((hash: string) => void)	Aggiungere un callback da richiamare ogni volta che la navigazione hash viene modificata
openNewWindow(string, string)	Apri una nuova finestra all'URL specificato
reload()	Ricarica il fotogramma principale
replaceHash(string)	Sostituire l'hash esistente con l'hash fornito dal contenuto ospitato.
setDocumentTitle(string)	Aggiornare il titolo del documento host (viene visualizzato come titolo della scheda del browser).
setHash(string)	Imposta l'hash fornito dal contenuto ospitato.
setQueryParams({[key: string]: string})	Imposta uno o più parametri di query nella pagina host

Dettagli metodo

getHash()

Ottiene l'hash corrente.

function getHash(): Promise<string>

Restituisce

Promise<string>

getPageNavigationElements()

Ottiene il set di elementi di navigazione (ad esempio hub e gruppi di hub) selezionati nella pagina corrente.

function getPageNavigationElements(): Promise<INavigationElement[]>

Restituisce

Promise<INavigationElement[]>

getPageRoute()

Ottiene informazioni sul percorso corrispondente per la pagina corrente

function getPageRoute(): Promise<IPageRoute>

Restituisce

Promise<IPageRoute>

getQueryParams()

Ottiene l'insieme corrente di parametri di query nell'URL della pagina host.

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

Restituisce

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

navigate(string)

Naviga nella pagina principale fino all'URL specificato

function navigate(url: string)

Parametri

url

string

URL a cui navigare

onHashChanged((hash: string) => void)

Aggiungere un callback da richiamare ogni volta che la navigazione hash viene modificata

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

Parametri

callback

(hash: string) => void

Metodo richiamato a ogni modifica dell'hash di navigazione

openNewWindow(string, string)

Apri una nuova finestra all'URL specificato

function openNewWindow(url: string, features: string)

Parametri

url

string

Url della nuova finestra

features

string

Elenco separato da virgole di funzionalità/specifiche inviate come 3° parametro a window.open. Ad esempio: "altezza=400,larghezza=400".

reload()

Ricarica il fotogramma principale

function reload()

replaceHash(string)

Sostituire l'hash esistente con l'hash fornito dal contenuto ospitato.

function replaceHash(hash: string)

Parametri

hash

string

setDocumentTitle(string)

Aggiornare il titolo del documento host (viene visualizzato come titolo della scheda del browser).

function setDocumentTitle(title: string)

Parametri

title

string

Il nuovo titolo della finestra

setHash(string)

Imposta l'hash fornito dal contenuto ospitato.

function setHash(hash: string)

Parametri

hash

string

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

Imposta uno o più parametri di query nella pagina host

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

Parametri

parameters

{[key: string]: string}

Dizionario dei parametri della stringa di query da aggiungere, aggiornare o rimuovere (passare un valore vuoto da rimuovere)