IHostNavigationService interface

Paket:

azure-devops-extension-api

Tjänst för att interagera med värdfönstrets navigering (URL:er, nya fönster osv.)

Metoder

getHash()	Hämtar den aktuella hashen.
getPageNavigationElements()	Hämtar den uppsättning navigeringselement (t.ex. hubbar och navgrupper) som valts på den aktuella sidan.
getPageRoute()	Hämtar information om den väg som matchades för den aktuella sidan
getQueryParams()	Hämtar den aktuella uppsättningen frågeparametrar i värdsidans URL.
navigate(string)	Navigera på den överordnade sidan till den angivna URL:en
onHashChanged((hash: string) => void)	Lägg till ett återanrop som ska anropas varje gång hash-navigeringen har ändrats
openNewWindow(string, string)	Öppna ett nytt fönster till den angivna URL:en
reload()	Läser in den överordnade ramen på nytt
replaceHash(string)	Ersätt befintlig hash med den angivna hashen från det värdbaserade innehållet.
setDocumentTitle(string)	Uppdatera värddokumentets titel (visas som rubrik på webbläsarfliken).
setHash(string)	Anger den angivna hashen från det värdbaserade innehållet.
setQueryParams({[key: string]: string})	Anger en eller flera frågeparametrar på värdsidan

Metodinformation

getHash()

Hämtar den aktuella hashen.

function getHash(): Promise<string>

Returer

Promise<string>

getPageNavigationElements()

Hämtar den uppsättning navigeringselement (t.ex. hubbar och navgrupper) som valts på den aktuella sidan.

function getPageNavigationElements(): Promise<INavigationElement[]>

Returer

Promise<INavigationElement[]>

getPageRoute()

Hämtar information om den väg som matchades för den aktuella sidan

function getPageRoute(): Promise<IPageRoute>

Returer

Promise<IPageRoute>

getQueryParams()

Hämtar den aktuella uppsättningen frågeparametrar i värdsidans URL.

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

Returer

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

navigate(string)

Navigera på den överordnade sidan till den angivna URL:en

function navigate(url: string)

Parametrar

url

string

Url att navigera till

onHashChanged((hash: string) => void)

Lägg till ett återanrop som ska anropas varje gång hash-navigeringen har ändrats

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

Parametrar

callback

(hash: string) => void

Metod som anropas vid varje ändring av navigeringshash

openNewWindow(string, string)

Öppna ett nytt fönster till den angivna URL:en

function openNewWindow(url: string, features: string)

Parametrar

url

string

Webbadress till det nya fönstret

features

string

Kommaseparerad lista över funktioner/specifikationer som skickas som den 3:e parametern till window.open. Till exempel: "height=400, width=400".

reload()

Läser in den överordnade ramen på nytt

function reload()

replaceHash(string)

Ersätt befintlig hash med den angivna hashen från det värdbaserade innehållet.

function replaceHash(hash: string)

Parametrar

hash

string

setDocumentTitle(string)

Uppdatera värddokumentets titel (visas som rubrik på webbläsarfliken).

function setDocumentTitle(title: string)

Parametrar

title

string

Fönstrets nya titel

setHash(string)

Anger den angivna hashen från det värdbaserade innehållet.

function setHash(hash: string)

Parametrar

hash

string

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

Anger en eller flera frågeparametrar på värdsidan

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

Parametrar

parameters

{[key: string]: string}

Ordlista med frågesträngsparametrar som ska läggas till, uppdateras eller tas bort (skicka ett tomt värde som ska tas bort)