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

以逗號分隔的功能/規格清單，傳送為 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}

要新增、更新或移除的查詢字串參數位典（傳遞要移除的空白值）