IHostNavigationService interface

Pakiet:

azure-devops-extension-api

Usługa do interakcji z nawigacją okna hosta (adresy URL, nowe okna itp.)

Metody

getHash()	Pobiera bieżący skrót.
getPageNavigationElements()	Pobiera zestaw elementów nawigacji (takich jak centra i grupy koncentratora) wybranych na bieżącej stronie.
getPageRoute()	Pobiera informacje o trasie, która została dopasowana dla bieżącej strony
getQueryParams()	Pobiera bieżący zestaw parametrów zapytania w adresie URL strony hosta.
navigate(string)	Nawigowanie po stronie nadrzędnej do określonego adresu URL
onHashChanged((hash: string) => void)	Dodawanie wywołania zwrotnego do wywołania za każdym razem, gdy nawigacja skrótu uległa zmianie
openNewWindow(string, string)	Otwórz nowe okno do określonego adresu URL
reload()	Ponownie ładuje ramkę nadrzędną
replaceHash(string)	Zastąp istniejący skrót podany skrótem z hostowanej zawartości.
setDocumentTitle(string)	Zaktualizuj tytuł dokumentu hosta (jest wyświetlany jako tytuł karty przeglądarki).
setHash(string)	Ustawia podany skrót z hostowanej zawartości.
setQueryParams({[key: string]: string})	Ustawia co najmniej jeden parametr zapytania na stronie hosta

Szczegóły metody

getHash()

Pobiera bieżący skrót.

function getHash(): Promise<string>

Zwraca

Promise<string>

getPageNavigationElements()

Pobiera zestaw elementów nawigacji (takich jak centra i grupy koncentratora) wybranych na bieżącej stronie.

function getPageNavigationElements(): Promise<INavigationElement[]>

Zwraca

Promise<INavigationElement[]>

getPageRoute()

Pobiera informacje o trasie, która została dopasowana dla bieżącej strony

function getPageRoute(): Promise<IPageRoute>

Zwraca

Promise<IPageRoute>

getQueryParams()

Pobiera bieżący zestaw parametrów zapytania w adresie URL strony hosta.

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

Zwraca

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

navigate(string)

Nawigowanie po stronie nadrzędnej do określonego adresu URL

function navigate(url: string)

Parametry

url

string

Adres URL do przejścia do

onHashChanged((hash: string) => void)

Dodawanie wywołania zwrotnego do wywołania za każdym razem, gdy nawigacja skrótu uległa zmianie

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

Parametry

callback

(hash: string) => void

Metoda wywoływana dla każdej zmiany skrótu nawigacji

openNewWindow(string, string)

Otwórz nowe okno do określonego adresu URL

function openNewWindow(url: string, features: string)

Parametry

url

string

Adres URL nowego okna

features

string

Rozdzielona przecinkami lista funkcji/specyfikacji wysłanych jako trzeci parametr do pliku window.open. Na przykład: "height=400,width=400".

reload()

Ponownie ładuje ramkę nadrzędną

function reload()

replaceHash(string)

Zastąp istniejący skrót podany skrótem z hostowanej zawartości.

function replaceHash(hash: string)

Parametry

hash

string

setDocumentTitle(string)

Zaktualizuj tytuł dokumentu hosta (jest wyświetlany jako tytuł karty przeglądarki).

function setDocumentTitle(title: string)

Parametry

title

string

Nowy tytuł okna

setHash(string)

Ustawia podany skrót z hostowanej zawartości.

function setHash(hash: string)

Parametry

hash

string

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

Ustawia co najmniej jeden parametr zapytania na stronie hosta

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

Parametry

parameters

{[key: string]: string}

Słownik parametrów ciągu zapytania do dodawania, aktualizowania lub usuwania (przekaż pustą wartość do usunięcia)