azure-devops-extension-sdk package

تطبيق متغيرات النسق على المستند الحالي

function applyTheme(themeData: {[varName: string]: string})

المعلمات

يعطل جسر مصادقة التطبيقات المتداخلة. بعد هذا الاتصال، ستتلقى أي طلبات رمز MSAL خطأ BridgeDisabled . يبقى كائن الجسر على الوضع window.nestedAppAuthBridge حتى لا يفقد مستمعو MSAL الحاليون أيامتهم. اتصل enableNestedAppAuth() لإعادة التفعيل.

function disableNestedAppAuth()

فعل مصادقة التطبيقات المتداخلة (NAA) لهذه الإضافة.

إعداد window.nestedAppAuthBridge بحيث يمكن لأجهزة createNestablePublicClientApplication MSAL تفويض اكتساب الرموز إلى إطار استضافة Azure DevOps. هذا يتجنب مشاكل قناة البث عبر المصادر التي تمنع المصادقة القائمة على النوافذ المنبثقة في إطارات iframes.

اتصل بهذا بعد init() وقبل إنشاء نسخة MSAL. يتطلب دعم NAA من المضيف.

مثال

await SDK.init();
await SDK.enableNestedAppAuth();
const pca = await createNestablePublicClientApplication({
    auth: { clientId: "your-entra-client-id" }
});

function enableNestedAppAuth(): Promise<void>

المرتجعات

وعد يحل عندما يكون الجسر جاهزا، أو يرفض إذا لم يدعم المضيف NAA.

إحضار رمز مميز للوصول الذي سيسمح بإجراء مكالمات إلى خدمات DevOps الأخرى

function getAccessToken(): Promise<string>

المرتجعات

إحضار رمز مميز يمكن استخدامه لتعريف المستخدم الحالي

function getAppToken(): Promise<string>

المرتجعات

الحصول على بيانات التكوين التي تم تمريرها في تأكيد الاتصال الأولي من الإطار الأصل

function getConfiguration(): {[key: string]: any}

المرتجعات

الحصول على معلومات حول المساهمة التي تسببت أولا في تحميل هذا الملحق.

function getContributionId(): string

المرتجعات

الحصول على سياق حول الملحق الذي يمتلك المحتوى الذي تتم استضافته

function getExtensionContext(): IExtensionContext

المرتجعات

الحصول على معلومات حول المضيف (أي مؤسسة Azure DevOps) التي تستهدفها الصفحة

function getHost(): IHostContext

المرتجعات

الحصول على السياق حول صفحة المضيف

function getPageContext(): IPageContext

المرتجعات

احصل على المساهمة بمعرف المساهمة المحدد. تحتوي المساهمة التي تم إرجاعها على طريقة للحصول على عنصر مسجل ضمن تلك المساهمة.

function getService<T>(contributionId: string): Promise<T>

المعلمات

المرتجعات

الحصول على معلومات حول الفريق الذي تستهدفه الصفحة

function getTeamContext(): ITeamContext

المرتجعات

الحصول على معلومات حول المستخدم الحالي

function getUser(): IUserContext

المرتجعات

الحصول على السياق حول الويب

function getWebContext(): IWebContext

المرتجعات

بدء تأكيد الاتصال مع نافذة المضيف.

function init(options?: IExtensionInitOptions): Promise<void>

المعلمات

المرتجعات

إعلام المضيف بفشل تحميل الملحق

function notifyLoadFailed(e: string | Error): Promise<void>

المعلمات

المرتجعات

إعلام المضيف بأن الملحق تم تحميله بنجاح (توقف عن إظهار مؤشر التحميل)

function notifyLoadSucceeded(): Promise<void>

المرتجعات

تسجيل رد اتصال يتم استدعاؤه بمجرد اكتمال الإعداد/تأكيد الاتصال الأولي. إذا اكتمل الإعداد الأولي بالفعل، يتم استدعاء رد الاتصال في نهاية مكدس الاستدعاءات الحالي.

function ready(): Promise<void>

المرتجعات

تسجيل كائن (مثيل أو أسلوب مصنع) يعرضه هذا الملحق لإطار المضيف.

function register<T>(instanceId: string, instance: T)

المعلمات

يطلب من النافذة الأصل تغيير حجم الحاوية لهذا الملحق استنادا إلى حجم الملحق الحالي.

function resize(width?: number, height?: number)

المعلمات

إزالة كائن يعرضه هذا الملحق لإطار المضيف.

function unregister(instanceId: string)

المعلمات

رقم إصدار Web SDK. يمكن تحديده في مجموعة متطلبات الامتداد مثل: vss-sdk-version/4.2

sdkVersion: 5

النوع