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})	ホスト ページで 1 つ以上のクエリ パラメーターを設定します

メソッドの詳細

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に送信された機能/仕様のコンマ区切りリスト。 たとえば、「高さ=400,幅=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})

ホスト ページで 1 つ以上のクエリ パラメーターを設定します

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

パラメーター

parameters

{[key: string]: string}

追加、更新、または削除するクエリ文字列パラメーターのディクショナリ (削除する空の値を渡す)