chrome.permissions

الوصف

استخدِم واجهة برمجة التطبيقات chrome.permissions لطلب الأذونات الاختيارية المعلَن عنها في وقت التشغيل بدلاً من وقت التثبيت، حتى يفهم المستخدمون سبب الحاجة إلى الأذونات ويمنحوا الأذونات الضرورية فقط.

نظرة عامة

تتوفّر تحذيرات الأذونات لوصف الإمكانات التي تمنحها واجهة برمجة التطبيقات، ولكن قد لا تكون بعض هذه التحذيرات واضحة. تسمح واجهة Permissions API للمطوّرين بتوضيح تحذيرات الأذونات وتقديم ميزات جديدة تدريجيًا، ما يتيح للمستخدمين التعرّف على الإضافة بدون أي مخاطر. بهذه الطريقة، يمكن للمستخدمين تحديد مستوى الوصول الذي يريدون منحه والميزات التي يريدون تفعيلها.

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

زر الإضافة الذي يتيح ميزات إضافية

يتطلّب عرض أهم المواقع الإلكترونية للمستخدم الحصول على إذن topSites الذي يتضمّن التحذير التالي.

تحذير بشأن إضافة topSites API

تنفيذ الأذونات الاختيارية

الخطوة 1: تحديد الأذونات المطلوبة والأذونات الاختيارية

يمكن للإضافة تحديد الأذونات المطلوبة والاختيارية. بشكل عام، عليك إجراء ما يلي:

  • استخدِم الأذونات المطلوبة عندما تكون ضرورية للوظائف الأساسية للإضافة.
  • استخدِم الأذونات الاختيارية عندما تكون مطلوبة للميزات الاختيارية في الإضافة.

مزايا الأذونات الإلزامية:

  • عدد أقل من الطلبات: يمكن أن يطلب أحد الإضافات من المستخدم مرة واحدة قبول جميع الأذونات.
  • تطوير أبسط: يتم ضمان توفّر الأذونات المطلوبة.

مزايا الأذونات الاختيارية:

  • أمان أفضل: تعمل الإضافات بأذونات أقل لأنّ المستخدمين يفعّلون الأذونات المطلوبة فقط.
  • معلومات أفضل للمستخدمين: يمكن لإحدى الإضافات أن توضّح سبب حاجتها إلى إذن معيّن عندما يفعّل المستخدم الميزة ذات الصلة.
  • ترقيات أسهل: عند ترقية الإضافة، لن يوقف Chrome الإضافة للمستخدمين إذا أضافت الترقية أذونات اختيارية بدلاً من الأذونات المطلوبة.

الخطوة 2: تضمين الأذونات الاختيارية في ملف البيان

يمكنك تضمين الأذونات الاختيارية في بيان الإضافة باستخدام المفتاح optional_permissions، مع استخدام التنسيق نفسه المستخدَم في الحقل الأذونات:

{   "name": "My extension",   ...   "optional_permissions": ["tabs"],   "optional_host_permissions": ["https://www.google.com/"],   ... } 

إذا كنت تريد طلب مضيفين لا يتم اكتشافهم إلا في وقت التشغيل، أدرِج "https://*/*" في حقل optional_host_permissions الخاص بالإضافة. يتيح لك ذلك تحديد أي مصدر في Permissions.origins طالما أنّه يتضمّن مخططًا مطابقًا.

الأذونات التي لا يمكن تحديدها على أنّها اختيارية

يمكن تحديد معظم أذونات إضافات Chrome على أنّها اختيارية، باستثناء ما يلي.

الإذن الوصف
"debugger" تعمل واجهة برمجة التطبيقات chrome.debugger كبديل لنقل بروتوكول تصحيح الأخطاء عن بُعد في Chrome.
"declarativeNetRequest" يمنح الإضافة إذن الوصول إلى واجهة برمجة التطبيقات chrome.declarativeNetRequest.
"devtools" تسمح هذه السمة للإضافة بتوسيع وظائف أدوات مطوّري البرامج في Chrome.
"experimental" إصدار Canary وقناة الإصدار التجريبي فقط. يمنح الإضافة إذن الوصول إلى واجهات برمجة التطبيقات chrome.experimental.
"geolocation" تسمح هذه السمة للإضافة باستخدام واجهة برمجة التطبيقات لتحديد الموقع الجغرافي في HTML5.
"mdns" يمنح الإضافة إذن الوصول إلى واجهة برمجة التطبيقات chrome.mdns.
"proxy" يمنح هذا الإذن الإضافة إمكانية الوصول إلى واجهة برمجة التطبيقات chrome.proxy لإدارة إعدادات الخادم الوكيل في Chrome.
"tts" تتيح واجهة برمجة التطبيقات chrome.tts تشغيل النص المحوّل إلى كلام (TTS).
"ttsEngine" تنفّذ واجهة برمجة التطبيقات chrome.ttsEngine محركًا لتحويل النص إلى كلام (TTS) باستخدام إضافة.
"wallpaper" على أجهزة ChromeOS فقط استخدِم واجهة برمجة التطبيقات chrome.wallpaper لتغيير خلفية ChromeOS.

يمكنك الاطّلاع على الإفصاح عن الأذونات وتحذير المستخدمين للحصول على مزيد من المعلومات حول الأذونات المتاحة والتحذيرات المتعلقة بها.

الخطوة 3: طلب أذونات اختيارية

اطلب الأذونات من داخل إيماءة مستخدم باستخدام permissions.request():

document.querySelector('#my-button').addEventListener('click', (event) => {   // Permissions must be requested from inside a user gesture, like a button's   // click handler.   chrome.permissions.request({     permissions: ['tabs'],     origins: ['https://www.google.com/']   }, (granted) => {     // The callback argument will be true if the user granted the permissions.     if (granted) {       doSomething();     } else {       doSomethingElse();     }   }); }); 

يطلب Chrome من المستخدم الموافقة إذا كان منح الأذونات يؤدي إلى ظهور رسائل تحذير مختلفة عن الرسائل التي سبق أن شاهدها المستخدم ووافق عليها. على سبيل المثال، قد يؤدي الرمز السابق إلى ظهور طلب على النحو التالي:

مثال على رسالة تأكيد الإذن

الخطوة 4: التحقّق من الأذونات الحالية للإضافة

للتحقّق مما إذا كانت الإضافة تتضمّن إذنًا أو مجموعة أذونات محدّدة، استخدِم permission.contains():

chrome.permissions.contains({   permissions: ['tabs'],   origins: ['https://www.google.com/'] }, (result) => {   if (result) {     // The extension has the permissions.   } else {     // The extension doesn't have the permissions.   } }); 

الخطوة 5: إزالة الأذونات

عليك إزالة الأذونات عند الاستغناء عنها. بعد إزالة أحد الأذونات، يؤدي استدعاء permissions.request() عادةً إلى إعادة إضافة الإذن بدون مطالبة المستخدم بذلك.

chrome.permissions.remove({   permissions: ['tabs'],   origins: ['https://www.google.com/'] }, (removed) => {   if (removed) {     // The permissions have been removed.   } else {     // The permissions have not been removed (e.g., you tried to remove     // required permissions).   } }); 

الأنواع

Permissions

الخصائص

  • المصادر

    string[] اختياري

    قائمة بأذونات المضيف، بما في ذلك تلك المحدّدة في المفتاحَين optional_permissions أو permissions في ملف البيان، وتلك المرتبطة ببرامج نصية خاصة بالمحتوى

  • أذونات

    string[] اختياري

    قائمة بالأذونات المسماة (لا تشمل المضيفين أو المصادر)

الطُرق

contains()

الوعد
chrome.permissions.contains(
  permissions: Permissions,
  callback?: function,
)
: Promise<boolean>

تتحقّق هذه الطريقة مما إذا كان للإضافة الأذونات المحدّدة.

المعلمات

  • أذونات
  • callback

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

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

    (result: boolean) => void

    • نتيجة

      قيمة منطقية

      تكون القيمة "صحيح" إذا كانت الإضافة تتضمّن الأذونات المحدّدة. إذا تم تحديد مصدر على أنّه إذن اختياري ونمط مطابق لبرنامج نصي للمحتوى، سيؤدي ذلك إلى عرض false ما لم يتم منح كلا الإذنين.

المرتجعات

  • Promise<boolean>

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

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

getAll()

الوعد
chrome.permissions.getAll(
  callback?: function,
)
: Promise<Permissions>

تعرض هذه السمة مجموعة الأذونات الحالية للإضافة.

المعلمات

  • callback

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

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

    (permissions: Permissions) => void

    • أذونات

      أذونات الإضافة النشطة يُرجى العِلم أنّ السمة origins ستتضمّن المصادر الممنوحة من تلك المحدّدة في المفتاحَين permissions وoptional_permissions في ملف البيان وتلك المرتبطة ببرامج النصوص الخاصة بالمحتوى.

المرتجعات

  • Promise<Permissions>

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

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

remove()

الوعد
chrome.permissions.remove(
  permissions: Permissions,
  callback?: function,
)
: Promise<boolean>

تزيل هذه الطريقة إذن الوصول إلى الأذونات المحدّدة. في حال حدوث أي مشاكل أثناء إزالة الأذونات، سيتم ضبط runtime.lastError.

المعلمات

  • أذونات
  • callback

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

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

    (removed: boolean) => void

    • تمت الإزالة

      قيمة منطقية

      تكون القيمة صحيحة إذا تمت إزالة الأذونات.

المرتجعات

  • Promise<boolean>

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

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

request()

الوعد
chrome.permissions.request(
  permissions: Permissions,
  callback?: function,
)
: Promise<boolean>

يطلب الوصول إلى الأذونات المحدّدة، ويعرض رسالة للمستخدم إذا لزم الأمر. يجب تحديد هذه الأذونات في الحقل optional_permissions في ملف البيان أو أن تكون أذونات مطلوبة حجبها المستخدم. سيتم تجاهل المسارات في أنماط المصدر. يمكنك طلب مجموعات فرعية من أذونات المصدر الاختيارية. على سبيل المثال، إذا حدّدت *://*\/* في القسم optional_permissions من ملف البيان، يمكنك طلب http://example.com/. في حال حدوث أي مشاكل في طلب الأذونات، سيتم ضبط قيمة runtime.lastError.

المعلمات

  • أذونات
  • callback

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

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

    (granted: boolean) => void

    • تم منح الموافقة

      قيمة منطقية

      تعرض هذه السمة القيمة "صحيح" إذا منح المستخدم الأذونات المحدّدة.

المرتجعات

  • Promise<boolean>

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

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

الفعاليات

onAdded

chrome.permissions.onAdded.addListener(
  callback: function,
)

يتم تنشيط هذا الحدث عندما تحصل الإضافة على أذونات جديدة.

المعلمات

  • callback

    دالة

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

    (permissions: Permissions) => void

onRemoved

chrome.permissions.onRemoved.addListener(
  callback: function,
)

يتم تنشيط هذا الحدث عندما تتم إزالة إذن الوصول إلى الأذونات من الإضافة.

المعلمات

  • callback

    دالة

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

    (permissions: Permissions) => void