IHostNavigationService interface

Balíček:

azure-devops-extension-api

Služba pro interakci s navigačním oknem hostitele (adresy URL, nová okna atd.)

Metody

getHash()	Získá aktuální hodnotu hash.
getPageNavigationElements()	Získá sadu navigačních prvků (jako jsou rozbočovače a skupiny rozbočovačů) vybraných na aktuální stránce.
getPageRoute()	Získá informace o trase, která byla spárována pro aktuální stránku.
getQueryParams()	Získá aktuální sadu parametrů dotazu v adrese URL hostitelské stránky.
navigate(string)	Přechod na nadřazenou stránku na zadanou adresu URL
onHashChanged((hash: string) => void)	Přidání zpětného volání, které se má vyvolat při každé změně navigace hash
openNewWindow(string, string)	Otevření nového okna se zadanou adresou URL
reload()	Znovu načte nadřazený rámec.
replaceHash(string)	Nahraďte existující hodnotu hash zadanou hodnotou hash z hostovaného obsahu.
setDocumentTitle(string)	Aktualizujte název hostitelského dokumentu (zobrazí se jako název karty prohlížeče).
setHash(string)	Nastaví zadanou hodnotu hash z hostovaného obsahu.
setQueryParams({[key: string]: string})	Nastaví jeden nebo více parametrů dotazu na stránce hostitele.

Podrobnosti metody

getHash()

Získá aktuální hodnotu hash.

function getHash(): Promise<string>

Návraty

Promise<string>

getPageNavigationElements()

Získá sadu navigačních prvků (jako jsou rozbočovače a skupiny rozbočovačů) vybraných na aktuální stránce.

function getPageNavigationElements(): Promise<INavigationElement[]>

Návraty

Promise<INavigationElement[]>

getPageRoute()

Získá informace o trase, která byla spárována pro aktuální stránku.

function getPageRoute(): Promise<IPageRoute>

Návraty

Promise<IPageRoute>

getQueryParams()

Získá aktuální sadu parametrů dotazu v adrese URL hostitelské stránky.

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

Návraty

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

navigate(string)

Přechod na nadřazenou stránku na zadanou adresu URL

function navigate(url: string)

Parametry

url

string

Adresa URL pro přechod na

onHashChanged((hash: string) => void)

Přidání zpětného volání, které se má vyvolat při každé změně navigace hash

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

Parametry

callback

(hash: string) => void

Metoda vyvolaná při každé změně hodnoty hash navigace

openNewWindow(string, string)

Otevření nového okna se zadanou adresou URL

function openNewWindow(url: string, features: string)

Parametry

url

string

Adresa URL nového okna

features

string

Čárkami oddělený seznam funkcí/specifikací odeslaných jako třetí parametr do window.open. Příklad: "height=400,width=400".

reload()

Znovu načte nadřazený rámec.

function reload()

replaceHash(string)

Nahraďte existující hodnotu hash zadanou hodnotou hash z hostovaného obsahu.

function replaceHash(hash: string)

Parametry

hash

string

setDocumentTitle(string)

Aktualizujte název hostitelského dokumentu (zobrazí se jako název karty prohlížeče).

function setDocumentTitle(title: string)

Parametry

title

string

Nový název okna

setHash(string)

Nastaví zadanou hodnotu hash z hostovaného obsahu.

function setHash(hash: string)

Parametry

hash

string

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

Nastaví jeden nebo více parametrů dotazu na stránce hostitele.

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

Parametry

parameters

{[key: string]: string}

Slovník parametrů řetězce dotazu pro přidání, aktualizaci nebo odebrání (předání prázdné hodnoty k odebrání)