IHostNavigationService interface

Пакет:

azure-devops-extension-api

Служба для взаимодействия с навигацией окна узла (URL-адреса, новые окна и т. д.)

Методы

getHash()	Возвращает текущий хэш.
getPageNavigationElements()	Возвращает набор элементов навигации (например, концентраторов и групп концентраторов), выбранных на текущей странице.
getPageRoute()	Возвращает сведения о маршруте, который был сопоставлен для текущей страницы
getQueryParams()	Возвращает текущий набор параметров запроса в URL-адресе страницы узла.
navigate(string)	Переход на родительскую страницу по указанному URL-адресу
onHashChanged((hash: string) => void)	Добавление обратного вызова для вызова при каждом изменении хэш-навигации
openNewWindow(string, string)	Открытие нового окна для указанного URL-адреса
reload()	Перезагрузит родительский кадр
replaceHash(string)	Замените существующий хэш предоставленным хэшом из размещенного содержимого.
setDocumentTitle(string)	Обновите заголовок документа узла (отображается в качестве заголовка вкладки браузера).
setHash(string)	Задает предоставленный хэш из размещенного содержимого.
setQueryParams({[key: string]: string})	Задает один или несколько параметров запроса на странице узла

Сведения о методе

getHash()

Возвращает текущий хэш.

function getHash(): Promise<string>

Возвращаемое значение

Promise<string>

getPageNavigationElements()

Возвращает набор элементов навигации (например, концентраторов и групп концентраторов), выбранных на текущей странице.

function getPageNavigationElements(): Promise<INavigationElement[]>

Возвращаемое значение

Promise<INavigationElement[]>

getPageRoute()

Возвращает сведения о маршруте, который был сопоставлен для текущей страницы

function getPageRoute(): Promise<IPageRoute>

Возвращаемое значение

Promise<IPageRoute>

getQueryParams()

Возвращает текущий набор параметров запроса в URL-адресе страницы узла.

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

Возвращаемое значение

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

navigate(string)

Переход на родительскую страницу по указанному URL-адресу

function navigate(url: string)

Параметры

url

string

URL-адрес для перехода к

onHashChanged((hash: string) => void)

Добавление обратного вызова для вызова при каждом изменении хэш-навигации

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

Параметры

callback

(hash: string) => void

Метод, вызываемый при каждом изменении хэша навигации

openNewWindow(string, string)

Открытие нового окна для указанного URL-адреса

function openNewWindow(url: string, features: string)

Параметры

url

string

URL-адрес нового окна

features

string

Разделенный запятыми список функций и спецификаций, отправленных в качестве 3-го параметра в window.open. Например: "height=400,width=400".

reload()

Перезагрузит родительский кадр

function reload()

replaceHash(string)

Замените существующий хэш предоставленным хэшом из размещенного содержимого.

function replaceHash(hash: string)

Параметры

hash

string

setDocumentTitle(string)

Обновите заголовок документа узла (отображается в качестве заголовка вкладки браузера).

function setDocumentTitle(title: string)

Параметры

title

string

Новое название окна

setHash(string)

Задает предоставленный хэш из размещенного содержимого.

function setHash(hash: string)

Параметры

hash

string

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

Задает один или несколько параметров запроса на странице узла

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

Параметры

parameters

{[key: string]: string}

Словарь параметров строки запроса для добавления, обновления или удаления (передачи пустого значения для удаления)