IHostNavigationService interface

Pakket:

azure-devops-extension-api

Service voor interactie met de navigatie van het hostvenster (URL's, nieuwe vensters, enz.)

Methoden

getHash()	Hiermee haalt u de huidige hash op.
getPageNavigationElements()	Hiermee haalt u de set navigatie-elementen (zoals hubs en hubgroepen) op die op de huidige pagina is geselecteerd.
getPageRoute()	Haalt informatie op over de route die is gematcht voor de huidige pagina
getQueryParams()	Hiermee haalt u de huidige set queryparameters op in de URL van de hostpagina.
navigate(string)	Navigeer op de bovenliggende pagina naar de opgegeven url
onHashChanged((hash: string) => void)	Voeg een callback toe die moet worden aangeroepen telkens wanneer de hash-navigatie is gewijzigd
openNewWindow(string, string)	Open een nieuw venster naar de opgegeven url
reload()	Herlaadt het bovenliggende frame
replaceHash(string)	Vervang de bestaande hash door de meegeleverde hash van de gehoste inhoud.
setDocumentTitle(string)	Werk de titel van het hostdocument bij (wordt weergegeven als de titel van het browsertabblad).
setHash(string)	Hiermee stelt u de verstrekte hash van de gehoste inhoud in.
setQueryParams({[key: string]: string})	Stelt een of meer queryparameters in op de hostpagina

Methodedetails

getHash()

Hiermee haalt u de huidige hash op.

function getHash(): Promise<string>

Retouren

Promise<string>

getPageNavigationElements()

Hiermee haalt u de set navigatie-elementen (zoals hubs en hubgroepen) op die op de huidige pagina is geselecteerd.

function getPageNavigationElements(): Promise<INavigationElement[]>

Retouren

Promise<INavigationElement[]>

getPageRoute()

Haalt informatie op over de route die is gematcht voor de huidige pagina

function getPageRoute(): Promise<IPageRoute>

Retouren

Promise<IPageRoute>

getQueryParams()

Hiermee haalt u de huidige set queryparameters op in de URL van de hostpagina.

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

Retouren

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

navigate(string)

Navigeer op de bovenliggende pagina naar de opgegeven url

function navigate(url: string)

Parameters

url

string

Url om naar toe te navigeren

onHashChanged((hash: string) => void)

Voeg een callback toe die moet worden aangeroepen telkens wanneer de hash-navigatie is gewijzigd

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

Parameters

callback

(hash: string) => void

Methode die wordt aangeroepen bij elke wijziging van de navigatiehash

openNewWindow(string, string)

Open een nieuw venster naar de opgegeven url

function openNewWindow(url: string, features: string)

Parameters

url

string

Url van het nieuwe venster

features

string

Door komma's gescheiden lijst met functies/specificaties die als de 3e parameter naar window.open worden verzonden. Bijvoorbeeld: "hoogte=400,breedte=400".

reload()

Herlaadt het bovenliggende frame

function reload()

replaceHash(string)

Vervang de bestaande hash door de meegeleverde hash van de gehoste inhoud.

function replaceHash(hash: string)

Parameters

hash

string

setDocumentTitle(string)

Werk de titel van het hostdocument bij (wordt weergegeven als de titel van het browsertabblad).

function setDocumentTitle(title: string)

Parameters

title

string

De nieuwe titel van het venster

setHash(string)

Hiermee stelt u de verstrekte hash van de gehoste inhoud in.

function setHash(hash: string)

Parameters

hash

string

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

Stelt een of meer queryparameters in op de hostpagina

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

Parameters

parameters

{[key: string]: string}

Woordenlijst met queryreeksparameters die moeten worden toegevoegd, bijgewerkt of verwijderd (geef een lege waarde door om te verwijderen)