Partager via

IHostNavigationService interface

Paquet:
azure-devops-extension-api

Service pour interagir avec la navigation de la fenêtre hôte (URL, nouvelles fenêtres, etc.)

Méthodes

getHash()

Obtient le hachage actuel.
getPageNavigationElements()

Obtient l’ensemble des éléments de navigation (tels que les hubs et les groupes de hubs) sélectionnés sur la page actuelle.
getPageRoute()

Obtient des informations sur l’itinéraire qui a été mis en correspondance pour la page actuelle
getQueryParams()

Obtient l’ensemble actuel des paramètres de requête dans l’URL de la page hôte.
navigate(string)

Naviguez dans la page parent jusqu’à l’URL spécifiée
onHashChanged((hash: string) => void)

Ajouter un rappel à appeler chaque fois que la navigation par hachage a changé
openNewWindow(string, string)

Ouvrir une nouvelle fenêtre vers l’URL spécifiée
reload()

Recharge l’image parent
replaceHash(string)

Remplacez le hachage existant par le hachage fourni à partir du contenu hébergé.
setDocumentTitle(string)

Mettez à jour le titre du document hôte (qui s’affiche sous la forme du titre de l’onglet du navigateur).
setHash(string)

Définit le hachage fourni à partir du contenu hébergé.
setQueryParams({[key: string]: string})

Définit un ou plusieurs paramètres de requête sur la page hôte

Détails de la méthode

getHash()

Obtient le hachage actuel.

function getHash(): Promise<string>

Retours

Promise<string>

getPageNavigationElements()

Obtient l’ensemble des éléments de navigation (tels que les hubs et les groupes de hubs) sélectionnés sur la page actuelle.

function getPageNavigationElements(): Promise<INavigationElement[]>

Retours

Promise<INavigationElement[]>

getPageRoute()

Obtient des informations sur l’itinéraire qui a été mis en correspondance pour la page actuelle

function getPageRoute(): Promise<IPageRoute>

Retours

Promise<IPageRoute>

getQueryParams()

Obtient l’ensemble actuel des paramètres de requête dans l’URL de la page hôte.

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

Retours

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

navigate(string)

Naviguez dans la page parent jusqu’à l’URL spécifiée

function navigate(url: string)

Paramètres

url

string

URL vers laquelle naviguer

onHashChanged((hash: string) => void)

Ajouter un rappel à appeler chaque fois que la navigation par hachage a changé

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

Paramètres

callback

(hash: string) => void

Méthode invoquée à chaque modification de hachage de navigation

openNewWindow(string, string)

Ouvrir une nouvelle fenêtre vers l’URL spécifiée

function openNewWindow(url: string, features: string)

Paramètres

url

string

Url de la nouvelle fenêtre

features

string

Liste de fonctionnalités/spécifications séparées par des virgules envoyée en tant que 3ème paramètre à window.open. Par exemple : « hauteur=400,largeur=400 ».

reload()

Recharge l’image parent

function reload()

replaceHash(string)

Remplacez le hachage existant par le hachage fourni à partir du contenu hébergé.

function replaceHash(hash: string)

Paramètres

hash

string

setDocumentTitle(string)

Mettez à jour le titre du document hôte (qui s’affiche sous la forme du titre de l’onglet du navigateur).

function setDocumentTitle(title: string)

Paramètres

title

string

Le nouveau titre de la fenêtre

setHash(string)

Définit le hachage fourni à partir du contenu hébergé.

function setHash(hash: string)

Paramètres

hash

string

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

Définit un ou plusieurs paramètres de requête sur la page hôte

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

Paramètres

parameters

{[key: string]: string}

Dictionnaire des paramètres de chaîne de requête à ajouter, mettre à jour ou supprimer (passer une valeur vide à supprimer)