chrome.notifications

الوصف

يمكنك استخدام واجهة برمجة تطبيقات chrome.notifications لإنشاء إشعارات تفاعلية باستخدام النماذج وعرض هذه الإشعارات للمستخدمين في لوحة النظام.

الأذونات

notifications

الأنواع

NotificationBitmap

NotificationButton

أماكن إقامة

  • iconUrl

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

    متوقف منذ الإصدار 59 من Chrome

    رموز الأزرار غير مرئية لمستخدمي نظام التشغيل Mac OS X.

  • title

    سلسلة

NotificationItem

أماكن إقامة

  • رسالة

    سلسلة

    تفاصيل إضافية حول هذا العنصر

  • title

    سلسلة

    عنوان عنصر واحد في إشعار القائمة.

NotificationOptions

أماكن إقامة

  • appIconMaskUrl

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

    متوقف منذ الإصدار 59 من Chrome

    لا يظهر قناع رمز التطبيق لمستخدمي نظام التشغيل Mac OS X.

    عنوان URL لقناع رمز التطبيق تخضع عناوين URL للقيود نفسها المفروضة على iconUrl.

    يجب أن يكون قناع رمز التطبيق في قناة ألفا، حيث سيتم أخذ قناة ألفا للصورة فقط في الاعتبار.

  • أزرار

    NotificationButton[] اختياري

    نصوص ورموز لما يصل إلى زرَّي إجراءات للإشعارات.

  • contextMessage

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

    محتوى الإشعارات البديل بخط صغير الحجم

  • eventTime

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

    طابع زمني مرتبط بالإشعار، بالملي ثانية بعد انتهاء الفترة الزمنية (مثل Date.now() + n)

  • iconUrl

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

    عنوان URL للصورة الرمزية للمُرسِل أو رمز التطبيق أو صورة مصغّرة لإشعارات الصور

    يمكن أن تكون عناوين URL عنوان URL للبيانات أو عنوان URL لـ blob أو عنوان URL ذي صلة بمورد داخل ملف crx .لهذه الإضافة

    **ملاحظة:**هذه القيمة مطلوبة لطريقة notifications.create().

  • imageUrl

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

    متوقف منذ الإصدار 59 من Chrome

    لا تظهر الصورة لمستخدمي نظام التشغيل Mac OS X.

    عنوان URL للصورة المصغّرة من نوع الإشعارات المتعلّقة بالصور تخضع عناوين URL للقيود نفسها المفروضة على iconUrl.

  • isClickable

    قيمة منطقية اختيارية

    متوقّف منذ إصدار Chrome 67

    يتم تجاهل تلميح واجهة المستخدم هذا اعتبارًا من الإصدار Chrome 67

  • items

    NotificationItem[] اختياري

    عناصر الإشعارات المتعددة العناصر. يرى مستخدمو نظام التشغيل Mac OS X العنصر الأول فقط.

  • رسالة

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

    محتوى الإشعارات الرئيسي

    **ملاحظة:**هذه القيمة مطلوبة لطريقة notifications.create().

  • الحملة

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

    وتتراوح الأولوية من -2 إلى 2. -2 هي أدنى أولوية. 2 هو الأعلى. القيمة التلقائية هي الصفر. على الأنظمة الأساسية التي لا تدعم مركز الإشعارات (أنظمة التشغيل Windows وLinux وMac)، تؤدي -2 و-1 إلى حدوث خطأ، حيث لن تظهر الإشعارات التي لها هذه الأولويات على الإطلاق.

  • التقدم

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

    يتراوح مستوى التقدّم الحالي بين 0 و100.

  • requireInteraction

    قيمة منطقية اختيارية

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

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

  • الوضع الصامت

    قيمة منطقية اختيارية

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

    يشير إلى عدم إصدار أي أصوات أو اهتزازات عند عرض الإشعار. وتكون القيمة التلقائية هي "خطأ".

  • title

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

    عنوان الإشعار (على سبيل المثال، اسم المرسل لرسالة إلكترونية).

    **ملاحظة:**هذه القيمة مطلوبة لطريقة notifications.create().

  • كتابة

    TemplateType اختياري

    نوع الإشعار الذي سيتم عرضه. مطلوبة لطريقة notifications.create

PermissionLevel

Enum

"granted"
يحدِّد هذا الحقل أنّ المستخدم قد اختار عرض الإشعارات من التطبيق أو الإضافة. هذا هو الإعداد التلقائي أثناء التثبيت.

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

TemplateType

Enum

"أساسي"
يحتوي على رمز وعنوان ورسالة ورسالة موسّعة وما يصل إلى زرَين.

"الصورة"
تحتوي على رمز وعنوان ورسالة ورسالة موسّعة وصورة وما يصل إلى زرَين.

"القائمة"
تحتوي على رمز وعنوان ورسالة وعناصر وما يصل إلى زرين. ويمكن لمستخدمي نظام التشغيل Mac OS X رؤية العنصر الأول فقط.

"التقدّم"
يحتوي على رمز وعنوان ورسالة ومستوى تقدّم، وما يصل إلى زرَّين.

الطُرق

clear()

وعود 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

يؤدي هذا الإجراء إلى محو الإشعار المحدّد.

المعلمات

  • notificationId

    سلسلة

    رقم تعريف الإشعار المطلوب محوه. يتم عرض ذلك باستخدام الطريقة notifications.create.

  • رد الاتصال

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

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

    (wasCleared: boolean) => void

    • wasCleared

      منطقي

المرتجعات

  • Promise<boolean>

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

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

create()

وعود 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
)

إنشاء إشعار وعرضه

المعلمات

  • notificationId

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

    مُعرّف الإشعار. وإذا لم يتم ضبط السياسة أو كانت فارغة، سيتم إنشاء رقم تعريف تلقائيًا. وفي حال تطابقت مع إشعار حالي، يتم أولاً محو هذا الإشعار قبل متابعة عملية الإنشاء. لا يمكن أن يتجاوز المعرّف 500 حرف.

    المعلمة notificationId مطلوبة قبل الإصدار 42 من Chrome.

  • الخيارات

    NotificationOptions

    محتوى الإشعار

  • رد الاتصال

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

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

    (notificationId: string) => void

    • notificationId

      سلسلة

المرتجعات

  • وعود<string>

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

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

getAll()

وعود 
chrome.notifications.getAll(
  callback?: function,
)

لاسترداد جميع الإشعارات الخاصة بهذا التطبيق أو هذه الإضافة

المعلمات

  • رد الاتصال

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

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

    (notifications: object) => void

    • الإشعارات

      كائن

المرتجعات

  • Promise&lt;object&gt;

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

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

getPermissionLevel()

وعود 
chrome.notifications.getPermissionLevel(
  callback?: function,
)

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

المعلمات

  • رد الاتصال

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

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

    (level: PermissionLevel) => void

المرتجعات

  • Promise&lt;PermissionLevel&gt;

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

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

update()

وعود 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
)

لتعديل إشعار حالي.

المعلمات

  • notificationId

    سلسلة

    رقم تعريف الإشعار الذي سيتم تعديله يتم عرض ذلك باستخدام الطريقة notifications.create.

  • الخيارات

    NotificationOptions

    محتوى الإشعار الذي سيتم التعديل إليه

  • رد الاتصال

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

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

    (wasUpdated: boolean) => void

    • wasUpdated

      منطقي

المرتجعات

  • Promise&lt;boolean&gt;

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

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

فعاليات

onButtonClicked

chrome.notifications.onButtonClicked.addListener(
  callback: function,
)

ضغط المستخدم على زر في الإشعار.

المعلمات

  • رد الاتصال

    دالة

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

    (notificationId: string, buttonIndex: number) => void

    • notificationId

      سلسلة

    • buttonIndex

      الرقم

onClicked

chrome.notifications.onClicked.addListener(
  callback: function,
)

نقر المستخدم في منطقة الإشعار، التي لا تحتوي على أزرار.

المعلمات

  • رد الاتصال

    دالة

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

    (notificationId: string) => void

    • notificationId

      سلسلة

onClosed

chrome.notifications.onClosed.addListener(
  callback: function,
)

تم إغلاق الإشعار، إما من خلال النظام أو من خلال إجراء من جانب المستخدم.

المعلمات

  • رد الاتصال

    دالة

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

    (notificationId: string, byUser: boolean) => void

    • notificationId

      سلسلة

    • byUser

      منطقي

onPermissionLevelChanged

chrome.notifications.onPermissionLevelChanged.addListener(
  callback: function,
)

يغيّر المستخدم مستوى الإذن. اعتبارًا من Chrome 47، أصبح نظام التشغيل ChromeOS فقط لديه واجهة مستخدم ترسل هذا الحدث.

المعلمات

  • رد الاتصال

    دالة

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

    (level: PermissionLevel) => void

onShowSettings

متوقّفة منذ إصدار Chrome 65
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

لم يعُد زر إعدادات الإشعارات المخصّصة متاحًا.

نقر المستخدم على رابط لإعدادات الإشعارات في التطبيق. اعتبارًا من Chrome 47، أصبح نظام التشغيل ChromeOS فقط لديه واجهة مستخدم ترسل هذا الحدث. اعتبارًا من الإصدار 65 من Chrome، تمت إزالة واجهة المستخدم هذه من نظام التشغيل ChromeOS أيضًا.

المعلمات

  • رد الاتصال

    دالة

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

    () => void