IHostNavigationService interface

Pacote:

azure-devops-extension-api

Serviço para interagir com a navegação da janela do host (URLs, novas janelas, etc.)

Métodos

getHash()	Obtém o hash atual.
getPageNavigationElements()	Obtém o conjunto de elementos de navegação (como hubs e grupos de hubs) selecionado na página atual.
getPageRoute()	Obtém informações sobre a rota que foi correspondida para a página atual
getQueryParams()	Obtém o conjunto atual de parâmetros de consulta na URL da página host.
navigate(string)	Navegue pela página pai até o url especificado
onHashChanged((hash: string) => void)	Adicionar um retorno de chamada a ser invocado sempre que a navegação por hash for alterada
openNewWindow(string, string)	Abrir uma nova janela para o url especificado
reload()	Recarrega o quadro pai
replaceHash(string)	Substitua o hash existente pelo hash fornecido do conteúdo hospedado.
setDocumentTitle(string)	Atualize o título do documento do host (aparece como o título da guia do navegador).
setHash(string)	Define o hash fornecido do conteúdo hospedado.
setQueryParams({[key: string]: string})	Define um ou mais parâmetros de consulta na página do host

Detalhes de Método

getHash()

Obtém o hash atual.

function getHash(): Promise<string>

Devoluções

Promise<string>

getPageNavigationElements()

Obtém o conjunto de elementos de navegação (como hubs e grupos de hubs) selecionado na página atual.

function getPageNavigationElements(): Promise<INavigationElement[]>

Devoluções

Promise<INavigationElement[]>

getPageRoute()

Obtém informações sobre a rota que foi correspondida para a página atual

function getPageRoute(): Promise<IPageRoute>

Devoluções

Promise<IPageRoute>

getQueryParams()

Obtém o conjunto atual de parâmetros de consulta na URL da página host.

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

Devoluções

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

navigate(string)

Navegue pela página pai até o url especificado

function navigate(url: string)

Parâmetros

url

string

Url para navegar

onHashChanged((hash: string) => void)

Adicionar um retorno de chamada a ser invocado sempre que a navegação por hash for alterada

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

Parâmetros

callback

(hash: string) => void

Método invocado em cada alteração de hash de navegação

openNewWindow(string, string)

Abrir uma nova janela para o url especificado

function openNewWindow(url: string, features: string)

Parâmetros

url

string

URL da nova janela

features

string

Lista separada por vírgulas de recursos/especificações enviados como o 3º parâmetro para window.open. Por exemplo: "height=400,width=400".

reload()

Recarrega o quadro pai

function reload()

replaceHash(string)

Substitua o hash existente pelo hash fornecido do conteúdo hospedado.

function replaceHash(hash: string)

Parâmetros

hash

string

setDocumentTitle(string)

Atualize o título do documento do host (aparece como o título da guia do navegador).

function setDocumentTitle(title: string)

Parâmetros

title

string

O novo título da janela

setHash(string)

Define o hash fornecido do conteúdo hospedado.

function setHash(hash: string)

Parâmetros

hash

string

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

Define um ou mais parâmetros de consulta na página do host

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

Parâmetros

parameters

{[key: string]: string}

Dicionário de parâmetros de cadeia de caracteres de consulta para adicionar, atualizar ou remover (passar um valor vazio para remover)