chrome.management

الوصف

توفّر واجهة برمجة التطبيقات chrome.management طرقًا لإدارة التطبيقات والإضافات المثبَّتة.

الأذونات

management

البيان

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

{
  "name": "My extension",
  ...
  "permissions": [
    "management"
  ],
  ...
}

لا تتطلّب management.getPermissionWarningsByManifest وmanagement.uninstallSelf وmanagement.getSelf إذن الإدارة.

الأنواع

ExtensionDisabledReason

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

سبب إيقاف العنصر

Enum

"unknown"

"permissions_increase"

ExtensionInfo

معلومات عن إضافة أو تطبيق أو مظهر مثبَّت

الخصائص

  • appLaunchUrl

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

    عنوان URL الخاص بالإطلاق (يظهر للتطبيقات فقط)

  • availableLaunchTypes

    LaunchType[] اختياري

    أنواع الإطلاق المتاحة حاليًا (تظهر للتطبيقات فقط)

  • الوصف

    سلسلة

    وصف هذه الإضافة أو التطبيق أو المظهر

  • disabledReason

    ExtensionDisabledReason اختيارية

    سبب إيقاف العنصر

  • مفعّلة

    قيمة منطقية

    تحديد ما إذا كان الخيار مفعّلاً أو غير مفعّل حاليًا

  • homepageUrl

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

    عنوان URL الخاص بالصفحة الرئيسية لهذه الإضافة أو التطبيق أو المظهر

  • hostPermissions

    string[]

    تعرض هذه السمة قائمة بالأذونات المستندة إلى المضيف.

  • الرموز

    ‫IconInfo[] اختيارية

    قائمة بمعلومات الرموز يُرجى العِلم أنّ هذا يعكس فقط ما تم تحديده في ملف البيان، وقد تكون الصورة الفعلية في عنوان URL هذا أكبر أو أصغر من الحجم الذي تم تحديده، لذا ننصحك باستخدام سمات العرض والارتفاع الصريحة في علامات img التي تشير إلى هذه الصور. لمزيد من التفاصيل، يُرجى الاطّلاع على مستندات بيان التطبيق حول الرموز.

  • id

    سلسلة

    المعرّف الفريد للإضافة.

  • installType

    ExtensionInstallType

    طريقة تثبيت الإضافة

  • isApp

    قيمة منطقية

    تم إيقافها نهائيًا

    يُرجى استخدام management.ExtensionInfo.type.

    تكون القيمة صحيحة إذا كان هذا العنصر تطبيقًا.

  • launchType

    LaunchType اختياري

    نوع تشغيل التطبيق (يظهر للتطبيقات فقط)

  • mayDisable

    قيمة منطقية

    تحدّد هذه السمة ما إذا كان بإمكان المستخدم إيقاف هذه الإضافة أو إلغاء تثبيتها.

  • mayEnable

    boolean اختياري

    Chrome 62 والإصدارات الأحدث

    تحدّد هذه السمة ما إذا كان بإمكان المستخدم تفعيل هذه الإضافة. لا يتم عرض هذه السمة إلا للإضافات غير المفعّلة.

  • الاسم

    سلسلة

    اسم هذه الإضافة أو التطبيق أو المظهر

  • offlineEnabled

    قيمة منطقية

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

  • optionsUrl

    سلسلة

    تمثّل هذه السمة عنوان URL لصفحة خيارات المنتج، إذا كان يتضمّن خيارات.

  • أذونات

    string[]

    تعرِض هذه السمة قائمة بالأذونات المستندة إلى واجهة برمجة التطبيقات.

  • shortName

    سلسلة

    نسخة مختصرة من اسم هذه الإضافة أو التطبيق أو المظهر

  • النوع

    ExtensionType

    نوع هذه الإضافة أو التطبيق أو المظهر

  • updateUrl

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

    عنوان URL الخاص بتحديث هذه الإضافة أو التطبيق أو المظهر

  • إصدار

    سلسلة

    الإصدار من هذه الإضافة أو التطبيق أو المظهر

  • versionName

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

    Chrome 50 والإصدارات الأحدث

    اسم الإصدار لهذه الإضافة أو التطبيق أو المظهر، إذا كان البيان يحدّد إصدارًا

ExtensionInstallType

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

طريقة تثبيت الإضافة أحد الأسباب التالية admin: تم تثبيت الإضافة بسبب سياسة إدارية، development: تم تحميل الإضافة بدون حزم في وضع المطوّرين، normal: تم تثبيت الإضافة بشكل عادي من خلال ملف ‎ .crx، sideload: تم تثبيت الإضافة بواسطة برامج أخرى على الجهاز، other: تم تثبيت الإضافة بواسطة وسائل أخرى.

Enum

"admin"

"development"

"normal"

"sideload"

"other"

ExtensionType

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

نوع هذه الإضافة أو التطبيق أو المظهر

Enum

"extension"

"hosted_app"

"packaged_app"

"legacy_packaged_app"

"theme"

"login_screen_extension"

IconInfo

معلومات حول رمز ينتمي إلى إضافة أو تطبيق أو مظهر

الخصائص

  • الحجم

    الرقم

    رقم يمثّل عرض الرمز وارتفاعه. تشمل القيم المحتملة (على سبيل المثال لا الحصر) 128 و48 و24 و16.

  • url

    سلسلة

    تمثّل هذه السمة عنوان URL لصورة الرمز. لعرض نسخة بتدرّج الرمادي من الرمز (للإشارة إلى أنّ الإضافة غير مفعّلة، مثلاً)، أضِف ?grayscale=true إلى عنوان URL.

LaunchType

في ما يلي جميع أنواع تشغيل التطبيقات الممكنة.

Enum

"OPEN_AS_REGULAR_TAB"

"OPEN_AS_PINNED_TAB"

"OPEN_AS_WINDOW"

"OPEN_FULL_SCREEN"

UninstallOptions

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

خيارات كيفية التعامل مع إلغاء تثبيت الإضافة

الخصائص

  • showConfirmDialog

    boolean اختياري

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

الطُرق

createAppShortcut()

الوعد 
chrome.management.createAppShortcut(
  id: string,
  callback?: function,
): Promise<void>

عرض خيارات لإنشاء اختصارات لتطبيق معيّن، علمًا بأنّه لا يمكن إنشاء سوى اختصارات للتطبيقات المجمّعة على أجهزة Mac

المعلمات

  • id

    سلسلة

    يجب أن يكون هذا هو المعرّف من عنصر تطبيق من management.ExtensionInfo.

  • callback

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

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

    () => void

المرتجعات

  • Promise<void>

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

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

الوعد 
chrome.management.generateAppForLink(
  url: string,
  title: string,
  callback?: function,
): Promise<ExtensionInfo>

إنشاء تطبيق لعنوان URL تعرض هذه السمة تطبيق الإشارة المرجعية الذي تم إنشاؤه.

المعلمات

  • url

    سلسلة

    تمثّل هذه السمة عنوان URL لصفحة ويب. يمكن أن يكون مخطط عنوان URL هو "http" أو "https" فقط.

  • title

    سلسلة

    تمثّل هذه السمة عنوان التطبيق الذي تم إنشاؤه.

  • callback

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

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

    (result: ExtensionInfo) => void

المرتجعات

  • Promise<ExtensionInfo>

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

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

get()

الوعد 
chrome.management.get(
  id: string,
  callback?: function,
): Promise<ExtensionInfo>

تعرض هذه الطريقة معلومات عن الإضافة أو التطبيق أو المظهر المثبَّت الذي يحمل رقم التعريف المحدّد.

المعلمات

المرتجعات

  • Promise<ExtensionInfo>

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

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

getAll()

الوعد 
chrome.management.getAll(
  callback?: function,
): Promise<ExtensionInfo[]>

تعرض هذه الطريقة قائمة بمعلومات حول الإضافات والتطبيقات المثبَّتة.

المعلمات

  • callback

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

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

    (result: ExtensionInfo[]) => void

المرتجعات

  • Promise<ExtensionInfo[]>

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

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

getPermissionWarningsById()

الوعد 
chrome.management.getPermissionWarningsById(
  id: string,
  callback?: function,
): Promise<string[]>

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

المعلمات

  • id

    سلسلة

    رقم تعريف إضافة سبق أن تم تثبيتها

  • callback

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

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

    (permissionWarnings: string[]) => void

    • permissionWarnings

      string[]

المرتجعات

  • Promise<string[]>

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

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

getPermissionWarningsByManifest()

الوعد 
chrome.management.getPermissionWarningsByManifest(
  manifestStr: string,
  callback?: function,
): Promise<string[]>

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

المعلمات

  • manifestStr

    سلسلة

    سلسلة JSON لبيان الإضافة

  • callback

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

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

    (permissionWarnings: string[]) => void

    • permissionWarnings

      string[]

المرتجعات

  • Promise<string[]>

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

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

getSelf()

الوعد 
chrome.management.getSelf(
  callback?: function,
): Promise<ExtensionInfo>

تعرض هذه السمة معلومات عن الإضافة أو التطبيق أو المظهر الذي تم استدعاؤه. ملاحظة: يمكن استخدام هذه الدالة بدون طلب إذن "الإدارة" في ملف البيان.

المعلمات

  • callback

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

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

    (result: ExtensionInfo) => void

المرتجعات

  • Promise<ExtensionInfo>

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

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

installReplacementWebApp()

Promise Chrome 77 والإصدارات الأحدث 
chrome.management.installReplacementWebApp(
  callback?: function,
): Promise<void>

يتم تشغيل replacement_web_app المحدّد في البيان. يطلب من المستخدم تثبيت التطبيق إذا لم يكن مثبّتًا.

المعلمات

  • callback

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

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

    () => void

المرتجعات

  • Promise<void>

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

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

launchApp()

الوعد 
chrome.management.launchApp(
  id: string,
  callback?: function,
): Promise<void>

تشغيل تطبيق

المعلمات

  • id

    سلسلة

    معرّف إضافة التطبيق.

  • callback

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

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

    () => void

المرتجعات

  • Promise<void>

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

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

setEnabled()

الوعد 
chrome.management.setEnabled(
  id: string,
  enabled: boolean,
  callback?: function,
): Promise<void>

تفعيل تطبيق أو إضافة أو إيقافهما في معظم الحالات، يجب استدعاء هذه الدالة في سياق إيماءة مستخدم (مثل معالج onclick لزر)، وقد تعرض للمستخدم واجهة مستخدم تأكيد أصلية كوسيلة لمنع إساءة الاستخدام.

المعلمات

  • id

    سلسلة

    يجب أن يكون هذا المعرّف من عنصر management.ExtensionInfo.

  • مفعّلة

    قيمة منطقية

    تحديد ما إذا كان يجب تفعيل هذا العنصر أو إيقافه

  • callback

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

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

    () => void

المرتجعات

  • Promise<void>

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

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

setLaunchType()

الوعد 
chrome.management.setLaunchType(
  id: string,
  launchType: LaunchType,
  callback?: function,
): Promise<void>

ضبط نوع تشغيل أحد التطبيقات

المعلمات

  • id

    سلسلة

    يجب أن يكون هذا هو المعرّف من عنصر تطبيق من management.ExtensionInfo.

  • launchType

    LaunchType

    نوع التشغيل المستهدَف. احرص دائمًا على التحقّق من أنّ نوع التشغيل هذا متوفّر في ExtensionInfo.availableLaunchTypes، لأنّ أنواع التشغيل المتاحة تختلف على المنصات والإعدادات المختلفة.

  • callback

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

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

    () => void

المرتجعات

  • Promise<void>

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

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

uninstall()

الوعد 
chrome.management.uninstall(
  id: string,
  options?: UninstallOptions,
  callback?: function,
): Promise<void>

يلغي هذا الأمر تثبيت تطبيق أو إضافة مثبّتَين حاليًا. ملاحظة: لا تعمل هذه الدالة في البيئات المُدارة عندما لا يُسمح للمستخدم بإلغاء تثبيت الإضافة أو التطبيق المحدّدَين. وفي حال تعذّر إلغاء التثبيت (على سبيل المثال، إذا ألغى المستخدم مربّع الحوار)، سيتم رفض الوعد أو سيتم استدعاء دالة الرجوع مع ضبط runtime.lastError.

المعلمات

  • id

    سلسلة

    يجب أن يكون هذا المعرّف من عنصر management.ExtensionInfo.

  • الخيارات

    UninstallOptions اختيارية

  • callback

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

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

    () => void

المرتجعات

  • Promise<void>

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

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

uninstallSelf()

الوعد 
chrome.management.uninstallSelf(
  options?: UninstallOptions,
  callback?: function,
): Promise<void>

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

المعلمات

  • الخيارات

    UninstallOptions اختيارية

  • callback

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

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

    () => void

المرتجعات

  • Promise<void>

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

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

الفعاليات

onDisabled

chrome.management.onDisabled.addListener(
  callback: function,
)

يتم إطلاق هذا الحدث عند إيقاف تطبيق أو إضافة.

المعلمات

  • callback

    دالة

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

    (info: ExtensionInfo) => void

onEnabled

chrome.management.onEnabled.addListener(
  callback: function,
)

يتم إطلاقه عند تفعيل تطبيق أو إضافة.

المعلمات

  • callback

    دالة

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

    (info: ExtensionInfo) => void

onInstalled

chrome.management.onInstalled.addListener(
  callback: function,
)

يتم إطلاقه عند تثبيت تطبيق أو إضافة.

المعلمات

  • callback

    دالة

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

    (info: ExtensionInfo) => void

onUninstalled

chrome.management.onUninstalled.addListener(
  callback: function,
)

يتم تنشيط هذا الحدث عند إلغاء تثبيت تطبيق أو إضافة.

المعلمات

  • callback

    دالة

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

    (id: string) => void

    • id

      سلسلة