IHostNavigationService interface

Paket:

azure-devops-extension-api

Layanan untuk berinteraksi dengan navigasi jendela host (URL, jendela baru, dll.)

Metode

getHash()	Mendapatkan hash saat ini.
getPageNavigationElements()	Mendapatkan kumpulan elemen navigasi (seperti hub dan grup hub) yang dipilih di halaman saat ini.
getPageRoute()	Mendapatkan informasi tentang rute yang cocok untuk halaman saat ini
getQueryParams()	Mendapatkan kumpulan parameter kueri saat ini di URL halaman host.
navigate(string)	Navigasi halaman induk ke url yang ditentukan
onHashChanged((hash: string) => void)	Tambahkan callback untuk dipanggil setiap kali navigasi hash berubah
openNewWindow(string, string)	Buka jendela baru ke url yang ditentukan
reload()	Muat ulang bingkai induk
replaceHash(string)	Ganti hash yang ada dengan hash yang disediakan dari konten yang dihosting.
setDocumentTitle(string)	Perbarui judul dokumen host (muncul sebagai judul tab browser).
setHash(string)	Mengatur hash yang disediakan dari konten yang dihosting.
setQueryParams({[key: string]: string})	Menetapkan satu atau beberapa parameter kueri di halaman host

Detail Metode

getHash()

Mendapatkan hash saat ini.

function getHash(): Promise<string>

Mengembalikan

Promise<string>

getPageNavigationElements()

Mendapatkan kumpulan elemen navigasi (seperti hub dan grup hub) yang dipilih di halaman saat ini.

function getPageNavigationElements(): Promise<INavigationElement[]>

Mengembalikan

Promise<INavigationElement[]>

getPageRoute()

Mendapatkan informasi tentang rute yang cocok untuk halaman saat ini

function getPageRoute(): Promise<IPageRoute>

Mengembalikan

Promise<IPageRoute>

getQueryParams()

Mendapatkan kumpulan parameter kueri saat ini di URL halaman host.

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

Mengembalikan

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

navigate(string)

Navigasi halaman induk ke url yang ditentukan

function navigate(url: string)

Parameter

url

string

URL untuk menavigasi

onHashChanged((hash: string) => void)

Tambahkan callback untuk dipanggil setiap kali navigasi hash berubah

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

Parameter

callback

(hash: string) => void

Metode yang dipanggil pada setiap perubahan hash navigasi

openNewWindow(string, string)

Buka jendela baru ke url yang ditentukan

function openNewWindow(url: string, features: string)

Parameter

url

string

Url jendela baru

features

string

Daftar fitur/spesifikasi yang dipisahkan koma yang dikirim sebagai parameter ke-3 ke window.open. Misalnya: "tinggi=400,lebar=400".

reload()

Muat ulang bingkai induk

function reload()

replaceHash(string)

Ganti hash yang ada dengan hash yang disediakan dari konten yang dihosting.

function replaceHash(hash: string)

Parameter

hash

string

setDocumentTitle(string)

Perbarui judul dokumen host (muncul sebagai judul tab browser).

function setDocumentTitle(title: string)

Parameter

title

string

Judul baru jendela

setHash(string)

Mengatur hash yang disediakan dari konten yang dihosting.

function setHash(hash: string)

Parameter

hash

string

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

Menetapkan satu atau beberapa parameter kueri di halaman host

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

Parameter

parameters

{[key: string]: string}

Kamus parameter string kueri untuk ditambahkan, diperbarui, atau dihapus (meneruskan nilai kosong untuk dihapus)