IHostNavigationService interface

Paket:

azure-devops-extension-api

Dienst für die Interaktion mit der Navigation des Hostfensters (URLs, neue Fenster usw.)

Methoden

getHash()	Ruft den aktuellen Hash ab.
getPageNavigationElements()	Ruft die auf der aktuellen Seite ausgewählten Navigationselemente (z. B. Hubs und Hub-Gruppen) ab.
getPageRoute()	Ruft Informationen über die Route ab, die für die aktuelle Seite abgeglichen wurde
getQueryParams()	Ruft den aktuellen Satz von Abfrageparametern in der URL der Hostseite ab.
navigate(string)	Navigieren Sie auf der übergeordneten Seite zur angegebenen URL
onHashChanged((hash: string) => void)	Fügen Sie einen Callback hinzu, der jedes Mal aufgerufen wird, wenn sich die Hashnavigation geändert hat
openNewWindow(string, string)	Öffnen Sie ein neues Fenster zur angegebenen URL
reload()	Lädt den übergeordneten Rahmen neu
replaceHash(string)	Ersetzen Sie den vorhandenen Hash durch den bereitgestellten Hash aus dem gehosteten Inhalt.
setDocumentTitle(string)	Aktualisieren Sie den Titel des Hostdokuments (wird als Titel der Browserregisterkarte angezeigt).
setHash(string)	Legt den bereitgestellten Hash aus dem gehosteten Inhalt fest.
setQueryParams({[key: string]: string})	Legt einen oder mehrere Abfrageparameter auf der Hostseite fest.

Details zur Methode

getHash()

Ruft den aktuellen Hash ab.

function getHash(): Promise<string>

Gibt zurück

Promise<string>

getPageNavigationElements()

Ruft die auf der aktuellen Seite ausgewählten Navigationselemente (z. B. Hubs und Hub-Gruppen) ab.

function getPageNavigationElements(): Promise<INavigationElement[]>

Gibt zurück

Promise<INavigationElement[]>

getPageRoute()

Ruft Informationen über die Route ab, die für die aktuelle Seite abgeglichen wurde

function getPageRoute(): Promise<IPageRoute>

Gibt zurück

Promise<IPageRoute>

getQueryParams()

Ruft den aktuellen Satz von Abfrageparametern in der URL der Hostseite ab.

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

Gibt zurück

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

navigate(string)

Navigieren Sie auf der übergeordneten Seite zur angegebenen URL

function navigate(url: string)

Parameter

url

string

URL, zu der navigiert werden soll

onHashChanged((hash: string) => void)

Fügen Sie einen Callback hinzu, der jedes Mal aufgerufen wird, wenn sich die Hashnavigation geändert hat

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

Parameter

callback

(hash: string) => void

Methode, die bei jeder Änderung des Navigationshashs aufgerufen wird

openNewWindow(string, string)

Öffnen Sie ein neues Fenster zur angegebenen URL

function openNewWindow(url: string, features: string)

Parameter

url

string

URL des neuen Fensters

features

string

Kommagetrennte Liste von Funktionen/Spezifikationen, die als 3. Parameter an window.open gesendet werden. Zum Beispiel: "height=400,width=400".

reload()

Lädt den übergeordneten Rahmen neu

function reload()

replaceHash(string)

Ersetzen Sie den vorhandenen Hash durch den bereitgestellten Hash aus dem gehosteten Inhalt.

function replaceHash(hash: string)

Parameter

hash

string

setDocumentTitle(string)

Aktualisieren Sie den Titel des Hostdokuments (wird als Titel der Browserregisterkarte angezeigt).

function setDocumentTitle(title: string)

Parameter

title

string

Der neue Titel des Fensters

setHash(string)

Legt den bereitgestellten Hash aus dem gehosteten Inhalt fest.

function setHash(hash: string)

Parameter

hash

string

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

Legt einen oder mehrere Abfrageparameter auf der Hostseite fest.

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

Parameter

parameters

{[key: string]: string}

Wörterbuch der Abfragezeichenfolgenparameter, die hinzugefügt, aktualisiert oder entfernt werden sollen (Übergeben eines leeren Werts zum Entfernen)