AndroidNotification interface

يمثّل هذا الإعداد خيارات الإشعارات الخاصة بنظام Android التي يمكن تضمينها في AndroidConfig.

Signature:

export interface AndroidNotification 

أماكن إقامة

الموقع النوع الوصف
النص السلسلة نص إشعار Android عند توفير هذه السمة، يتم إلغاء النص الأساسي الذي تم ضبطه من خلال admin.messaging.Notification.
bodyLocArgs سلسلة[] تمثّل هذه السمة مصفوفة من مفاتيح الموارد التي سيتم استخدامها بدلاً من محددات التنسيق في bodyLocKey.
bodyLocKey السلسلة مفتاح السلسلة الأساسية في مورد السلسلة للتطبيق المطلوب استخدامه لترجمة النص الأساسي.
channelId السلسلة معرّف قناة إشعارات Android (الجديد في Android O) يجب أن ينشئ التطبيق قناة باستخدام معرّف القناة هذا لكي نتمكّن من تلقّي أي إشعار يتضمّن معرّف القناة هذا. إذا لم ترسِل معرّف القناة هذا في الطلب، أو إذا لم ينشئ التطبيق معرّف القناة الذي قدّمته بعد، ستستخدم خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" معرّف القناة المحدّد في بيان التطبيق.
clickAction السلسلة إجراء مرتبط بنقرة مستخدم على الإشعار. وفي حالة تحديد هذا الخيار، يتم تشغيل نشاط يحتوي على فلتر أهداف مطابق عندما ينقر المستخدم على الإشعار.
color (اللون) السلسلة لون رمز الإشعار بتنسيق #rrggbb.
إعدادات LightLightSettings التلقائية قيمة منطقية في حال ضبط السياسة على true، يمكنك استخدام إعدادات مصباح LED التلقائية في إطار عمل Android لإرسال الإشعار. يتم تحديد القيم التلقائية في config.xml. في حال ضبط default_light_settings على true وlight_settings أيضًا، يتم استخدام light_settings التي يحدّدها المستخدم بدلاً من القيمة التلقائية.
defaultSound قيمة منطقية في حال ضبط هذه السياسة على true، استخدِم الصوت التلقائي للإشعار في إطار عمل Android. يتم تحديد القيم التلقائية في config.xml.
defaultVibrateTimings قيمة منطقية في حال ضبط السياسة على true، استخدِم نقش الاهتزاز التلقائي لإطار عمل Android للإشعار. يتم تحديد القيم التلقائية في config.xml. إذا تم ضبط default_vibrate_timings على true وتم ضبط vibrate_timings أيضًا، يتم استخدام القيمة التلقائية بدلاً من vibrate_timings التي حدّدها المستخدم.
eventTimestamp التاريخ بالنسبة إلى الإشعارات التي تُعلِم المستخدمين بالأحداث التي تتضمّن مرجعًا زمنيًا مطلقًا، يتم تحديد وقت وقوع الحدث في الإشعار. يتم ترتيب الإشعارات في اللوحة حسب هذا الوقت.
السلسلة مرجع الرمز الخاص بإشعارات Android
imageUrl السلسلة عنوان URL للصورة التي سيتم عرضها في الإشعار.
lightSettings إعدادات LightSettings إعدادات للتحكّم في معدل وميض مصباح LED في الإشعار ولونه في حال توفّر مصباح LED على الجهاز يتحكم نظام التشغيل في إجمالي مدة الوميض.
localOnly قيمة منطقية تحدد ما إذا كان هذا الإشعار ذا صلة بالجهاز الحالي فقط أم لا. يمكن إرسال بعض الإشعارات إلى الأجهزة الأخرى لعرضها عن بُعد، مثل ساعة Wear OS. يمكن ضبط هذا التلميح لاقتراح عدم تلقّي إشعارات بشأن هذا الإشعار. يمكنك الاطّلاع على أدلة Wear OS.
NotificationCount رقم يتم تحديد عدد العناصر التي يمثّلها هذا الإشعار. قد يتم عرضه كعدد شارات لـ "مشغّلات التطبيقات" التي تتيح الشارات. راجع NotificationBadge. على سبيل المثال، قد يكون ذلك مفيدًا إذا كنت تستخدم إشعارًا واحدًا فقط لتمثيل عدة رسائل جديدة، ولكنك تريد أن يمثل العدد هنا إجمالي عدد الرسائل الجديدة. في حال كانت القيمة صفرًا أو غير محدّدة، تستخدم الأنظمة التي تتيح الشارات الإعدادات التلقائية، وهو زيادة رقم معروض في قائمة الضغط المطوّل في كل مرة يصل فيها إشعار جديد.
الأولوية ('min' | 'low' | 'default' | 'high' | 'max') لضبط الأولوية النسبية لهذا الإشعار. قد يتم إخفاء الإشعارات ذات الأولوية المنخفضة عن المستخدم في حالات معيّنة. يُرجى العِلم أنّ هذه الأولوية تختلف عن AndroidMessagePriority. ويعالج العميل هذه الأولوية بعد تسليم الرسالة. بينما AndroidMessagePriority هو مفهوم "المراسلة عبر السحابة الإلكترونية من Firebase" الذي يتحكّم في وقت تسليم الرسالة.
الصوت السلسلة اسم ملف الصوت الذي سيتم تشغيله عندما يتلقّى الجهاز الإشعار.
ثابت قيمة منطقية عند ضبط هذه السياسة على false أو تركها بدون ضبط، يتم إغلاق الإشعار تلقائيًا عندما ينقر المستخدم عليه في اللوحة. عند ضبط هذه السياسة على "true"، يستمر ظهور الإشعار حتى عندما ينقر المستخدم عليه.
علامة السلسلة علامة الإشعار معرّف يُستخدَم لاستبدال الإشعارات الحالية في درج الإشعارات في حال عدم تحديد قيمة، سينشئ كل طلب إشعارًا جديدًا.
شريط أخبار السلسلة تعيين "المؤشر" النص الذي يتم إرساله إلى خدمات إمكانية الوصول. قبل المستوى 21 من واجهة برمجة التطبيقات (Lollipop)، يعمل على ضبط النص المعروض في شريط الحالة عند وصول الإشعار لأول مرة.
title السلسلة عنوان إشعار Android عند توفير هذه السمة، يتم إلغاء العنوان الذي تم ضبطه من خلال admin.messaging.Notification.
titleLocArgs سلسلة[] تمثّل هذه السمة مصفوفة من مفاتيح الموارد التي سيتم استخدامها بدلاً من محددات التنسيق في titleLocKey.
titleLocKey السلسلة مفتاح سلسلة العنوان في مورد السلسلة للتطبيق المطلوب استخدامه لترجمة نص العنوان.
vibrateTimingsMillis رقم[] يحدد نمط الاهتزاز لاستخدامه. ومرّت مجموعة من المللي ثانية لتشغيل الهزّاز أو إيقافه. تشير القيمة الأولى إلى مدة الانتظار قبل تشغيل الهزّاز. تشير القيمة التالية إلى مدة تشغيل الهزّاز. وتتناوب القيم اللاحقة بين المدة لإيقاف الهزّاز وتشغيل الهزّاز. في حال ضبط vibrate_timings وضبط default_vibrate_timings على true، يتم استخدام القيمة التلقائية بدلاً من قيمة vibrate_timings التي حدّدها المستخدم.
visibility ("خاص" | "عام" | "سري") لضبط مستوى رؤية الإشعار. يجب أن تكون القيمة private أو public أو secret. وفي حال عدم تحديد قيمة هذه السمة، يتم ضبط القيمة التلقائية على private.

.AndroidNotification.body

نص إشعار Android عند توفير هذه السمة، يتم إلغاء النص الأساسي الذي تم ضبطه من خلال admin.messaging.Notification.

Signature:

body?: string;

AndroidNotification.bodyLocArgs

تمثّل هذه السمة مصفوفة من مفاتيح الموارد التي سيتم استخدامها بدلاً من محددات التنسيق في bodyLocKey.

Signature:

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

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

Signature:

bodyLocKey?: string;

AndroidNotification.channelId

معرّف قناة إشعارات Android (الجديد في Android O) يجب أن ينشئ التطبيق قناة باستخدام معرّف القناة هذا لكي نتمكّن من تلقّي أي إشعار يتضمّن معرّف القناة هذا. إذا لم ترسِل معرّف القناة هذا في الطلب، أو إذا لم ينشئ التطبيق معرّف القناة الذي قدّمته بعد، ستستخدم خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" معرّف القناة المحدّد في بيان التطبيق.

Signature:

channelId?: string;

AndroidNotification.clickAction

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

Signature:

clickAction?: string;

AndroidNotification.color

لون رمز الإشعار بتنسيق #rrggbb.

Signature:

color?: string;

AndroidNotification.defaultLightSettings

في حال ضبط السياسة على true، يمكنك استخدام إعدادات مصباح LED التلقائية في إطار عمل Android لإرسال الإشعارات. يتم تحديد القيم التلقائية في config.xml. في حال ضبط default_light_settings على true وlight_settings أيضًا، يتم استخدام light_settings التي يحدّدها المستخدم بدلاً من القيمة التلقائية.

Signature:

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

في حال ضبط السياسة على true، استخدِم الصوت التلقائي للإشعار في إطار عمل Android. يتم تحديد القيم التلقائية في config.xml.

Signature:

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimings

في حال ضبط السياسة على true، يمكنك استخدام نقش الاهتزاز التلقائي في إطار عمل Android للإشعار. يتم تحديد القيم التلقائية في config.xml. إذا تم ضبط default_vibrate_timings على true وتم ضبط vibrate_timings أيضًا، يتم استخدام القيمة التلقائية بدلاً من قيمة vibrate_timings التي يحدّدها المستخدم.

Signature:

defaultVibrateTimings?: boolean;

AndroidNotification.eventTimestamp

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

Signature:

eventTimestamp?: Date;

رمز AndroidNotification.icon

مرجع الرمز الخاص بإشعارات Android

Signature:

icon?: string;

AndroidNotification.imageUrl

عنوان URL للصورة التي سيتم عرضها في الإشعار.

Signature:

imageUrl?: string;

AndroidNotification.lightSettings

إعدادات للتحكّم في معدل وميض مصباح LED في الإشعار ولونه في حال توفّر مصباح LED على الجهاز يتحكم نظام التشغيل في إجمالي مدة الوميض.

Signature:

lightSettings?: LightSettings;

AndroidNotification.localOnly

تحدد ما إذا كان هذا الإشعار ذا صلة بالجهاز الحالي فقط أم لا. يمكن إرسال بعض الإشعارات إلى الأجهزة الأخرى لعرضها عن بُعد، مثل ساعة Wear OS. يمكن ضبط هذا التلميح لاقتراح عدم تلقّي إشعارات بشأن هذا الإشعار. يمكنك الاطّلاع على أدلة Wear OS.

Signature:

localOnly?: boolean;

AndroidNotification.NotificationCount

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

Signature:

notificationCount?: number;

AndroidNotification.priority

لضبط الأولوية النسبية لهذا الإشعار. قد يتم إخفاء الإشعارات ذات الأولوية المنخفضة عن المستخدم في حالات معيّنة. يُرجى العِلم أنّ هذه الأولوية تختلف عن AndroidMessagePriority. ويعالج العميل هذه الأولوية بعد تسليم الرسالة. بينما AndroidMessagePriority هو مفهوم "المراسلة عبر السحابة الإلكترونية من Firebase" الذي يتحكّم في وقت تسليم الرسالة.

Signature:

priority?: ('min' | 'low' | 'default' | 'high' | 'max');

AndroidNotification.sound

اسم ملف الصوت الذي سيتم تشغيله عندما يتلقّى الجهاز الإشعار.

Signature:

sound?: string;

AndroidNotification.sticky

عند ضبط هذه السياسة على false أو تركها بدون ضبط، يتم إغلاق الإشعار تلقائيًا عندما ينقر المستخدم عليه في اللوحة. عند ضبط هذه السياسة على true، يستمر ظهور الإشعار حتى عندما ينقر المستخدم عليه.

Signature:

sticky?: boolean;

علامة AndroidNotification.tag

علامة الإشعار معرّف يُستخدَم لاستبدال الإشعارات الحالية في درج الإشعارات في حال عدم تحديد قيمة، سينشئ كل طلب إشعارًا جديدًا.

Signature:

tag?: string;

شريط الإشعارات Android

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

Signature:

ticker?: string;

AndroidNotification.title

عنوان إشعار Android عند توفير هذه السمة، يتم إلغاء العنوان الذي تم ضبطه من خلال admin.messaging.Notification.

Signature:

title?: string;

AndroidNotification.titleLocArgs

تمثّل هذه السمة مصفوفة من مفاتيح الموارد التي سيتم استخدامها بدلاً من محددات التنسيق في titleLocKey.

Signature:

titleLocArgs?: string[];

AndroidNotification.titleLocKey

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

Signature:

titleLocKey?: string;

AndroidNotification.vibrateTimingsMillis

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

Signature:

vibrateTimingsMillis?: number[];

AndroidNotification.visibility

لضبط مستوى رؤية الإشعار. يجب أن تكون إما private أو public أو secret. وفي حال عدم تحديد قيمة هذه السمة، يتم ضبط القيمة التلقائية على private.

Signature:

visibility?: ('private' | 'public' | 'secret');