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

قائمة مفصولة بفواصل من الميزات / المواصفات المرسلة كمعلمة 3rd إلى 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})

تعيين معلمة استعلام واحدة أو أكثر على الصفحة المضيفة

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

المعلمات

parameters

{[key: string]: string}

قاموس معلمات سلسلة الاستعلام لإضافة أو تحديث أو إزالة (تمرير قيمة فارغة لإزالتها)