chrome.extension

الوصف

تتضمّن واجهة برمجة التطبيقات chrome.extension أدوات مساعدة يمكن استخدامها في أي صفحة إضافات. وتشمل إتاحة تبادل الرسائل بين إحدى الإضافات والنصوص البرمجية للمحتوى أو بين الإضافات، على النحو الموضّح بالتفصيل في تمرير الرسائل.

الأنواع

ViewType

الإصدار 44 من Chrome أو الإصدارات الأحدث

نوع عرض الإضافة.

Enum

"tab"

"نافذة منبثقة"

أماكن إقامة

inIncognitoContext

صحيح بالنسبة إلى النصوص البرمجية للمحتوى التي تعمل داخل علامات تبويب التصفح المتخفي، ولصفحات الإضافات التي يتم تشغيلها داخل عملية التصفح المتخفي. لا ينطبق الخيار الأخير إلا على الإضافات التي تحتوي على "split" سلوك_التصفح المتخفي.

النوع

منطقي

lastError

≤ MV2 متوقّفة نهائيًا منذ الإصدار 58 من Chrome

يُرجى استخدام runtime.lastError.

يتم ضبط القيمة على مدة معاودة الاتصال إذا أدّت واجهة برمجة تطبيقات إضافة غير مرتبطة إلى حدوث خطأ. إذا لم يحدث أي خطأ، سيكون lastError: undefined.

النوع

كائن

أماكن إقامة

  • رسالة

    سلسلة

    وصف الخطأ الذي حدث.

الطُرق

getBackgroundPage()

واجهة التطبيق فقط 
chrome.extension.getBackgroundPage()

عرض "نافذة" JavaScript لصفحة الخلفية التي يتم تشغيلها داخل الإضافة الحالية. تعرض القيمة فارغة إذا لم يكن للإضافة صفحة خلفية.

المرتجعات

  • النافذة | غير محدّدة

getExtensionTabs()

≤ MV2 واجهة التطبيق فقط تمّت إزالة هذا العمود.
chrome.extension.getExtensionTabs(
  windowId?: number,
)

يُرجى استخدام extension.getViews {type: "tab"}.

عرض مصفوفة من نافذة JavaScript "window" لكل علامة من علامات التبويب الموجودة داخل الإضافة الحالية. في حال تحديد windowId، سيتم عرض "window" فقط. كائنات علامات التبويب المرفقة بالنافذة المحددة.

المعلمات

  • windowId

    الرقم اختياري

المرتجعات

  • النافذة[]

    مصفوفة من عناصر النافذة العامة

getURL()

≤ MV2 متوقّفة نهائيًا منذ الإصدار 58 من Chrome
chrome.extension.getURL(
  path: string,
)

يُرجى استخدام runtime.getURL.

لتحويل مسار نسبي ضمن دليل تثبيت الإضافة إلى عنوان URL مؤهَّل بالكامل.

المعلمات

  • المسار

    سلسلة

    مسار إلى مورد داخل إضافة يتم التعبير عنه بالنسبة إلى دليل التثبيت الخاص به.

المرتجعات

  • سلسلة

    عنوان URL المؤهّل بالكامل للمورد.

getViews()

واجهة التطبيق فقط 
chrome.extension.getViews(
  fetchProperties?: object,
)

عرض مصفوفة من نافذة JavaScript "window" لكل صفحة من الصفحات التي يتم تشغيلها داخل الإضافة الحالية.

المعلمات

  • fetchProperties

    الكائن اختياري

    • tabId

      الرقم اختياري

      الإصدار 54 من Chrome أو الإصدارات الأحدث

      اعثر على طريقة عرض وفقًا لرقم تعريف علامة التبويب. في حال حذف هذا الحقل، سيتم عرض جميع المشاهدات.

    • كتابة

      ViewType اختيارية

      نوع العرض المطلوب الحصول عليه. في حال حذفه، سيتم عرض جميع طرق العرض (بما في ذلك صفحات الخلفية وعلامات التبويب).

    • windowId

      الرقم اختياري

      النافذة المراد تقييد البحث إليها. إذا تم حذفها، يتم عرض جميع المشاهدات.

المرتجعات

  • النافذة[]

    مصفوفة من الكائنات العامة

isAllowedFileSchemeAccess()

وعود 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

استرداد حالة وصول الإضافة إلى "file:// " . ويتوافق هذا مع "السماح بالوصول إلى عناوين URL للملفات" لكل إضافة يتحكم فيها المستخدم الإعدادات التي يمكن الوصول إليها من خلال صفحة chrome://extensions.

المعلمات

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      منطقي

      صحيح إذا كان بإمكان الإضافة الوصول إلى "file:// " ، false في الحالات الأخرى.

المرتجعات

  • Promise<boolean>

    الإصدار 99 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

isAllowedIncognitoAccess()

وعود 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

يسترد حالة وصول الإضافة إلى وضع التصفح المتخفي. وهذا يتوافق مع "مسموح بها في وضع التصفّح المتخفي" لكل إضافة يتحكّم فيها المستخدم الإعدادات التي يمكن الوصول إليها من خلال صفحة chrome://extensions.

المعلمات

  • رد الاتصال

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      منطقي

      صحيح إذا كان للإضافة إمكانية الوصول إلى وضع التصفح المتخفي، وخطأ في الحالات الأخرى.

المرتجعات

  • Promise<boolean>

    الإصدار 99 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

sendRequest()

وعود ≤ MV2 تمّت إزالة هذا العمود.
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

يُرجى استخدام runtime.sendMessage.

يرسل طلبًا واحدًا إلى مستمعين آخرين ضمن الإضافة. يشبهruntime.connect، ولكن يرسل طلبًا واحدًا فقط مع رد اختياري. يتم تنشيط حدث extension.onRequest في كل صفحة من الإضافة.

المعلمات

  • extensionId

    سلسلة اختيارية

    رقم تعريف الإضافة التي تريد الربط بها. إذا تم حذفها، تكون إضافتك التلقائية هي الإضافة الخاصة بك.

  • طلب

    أي واحد

  • رد الاتصال

    الدالة اختيارية

    الإصدار 99 من Chrome أو الإصدارات الأحدث

    تظهر المَعلمة callback على النحو التالي: 

    (response: any) => void

    • رد

      أي واحد

      كائن استجابة JSON الذي أرسله معالج الطلب. إذا حدث خطأ أثناء الاتصال بالإضافة، سيتم استدعاء هذه الدالة بدون وسيطات، وسيتم ضبط runtime.lastError على رسالة الخطأ.

المرتجعات

  • تقديم وعود<any>

    الإصدار 99 من Chrome أو الإصدارات الأحدث

    لا تتوفّر الوعود إلا مع إصدار Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

تُحدِّد قيمة مَعلمة ap CGI المستخدَمة في عنوان URL لتعديل الإضافة. ويتم تجاهل هذه القيمة للإضافات التي تتم استضافتها في معرض إضافات Chrome.

المعلمات

  • البيانات

    سلسلة

فعاليات

onRequest

&amp;leq; MV2 متوقّفة نهائيًا
chrome.extension.onRequest.addListener(
  callback: function,
)

يُرجى استخدام runtime.onMessage.

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

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • طلب

      أي واحد

    • المُرسِل

      runtime.MessageSender

    • sendResponse

      دالة

      تظهر المَعلمة sendResponse على النحو التالي: 

      () => void

onRequestExternal

&amp;leq; MV2 متوقّفة نهائيًا
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

يُرجى استخدام runtime.onMessageExternal.

يتم الإطلاق عند إرسال طلب من إضافة أخرى.

المعلمات

  • رد الاتصال

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • طلب

      أي واحد

    • المُرسِل

      runtime.MessageSender

    • sendResponse

      دالة

      تظهر المَعلمة sendResponse على النحو التالي: 

      () => void