يمثل خيارات الإشعارات الخاصة بنظام Android والتي يمكن تضمينها في AndroidConfig .
إمضاء:
export interface AndroidNotification
ملكيات
| ملكية | يكتب | وصف |
|---|---|---|
| جسم | خيط | نص إشعار Android. عند توفيره، يتجاوز النص الذي تم تعيينه عبر admin.messaging.Notification . |
| bodyLocArgs | خيط[] | مجموعة من مفاتيح الموارد التي سيتم استخدامها بدلاً من محددات التنسيق في bodyLocKey . |
| bodyLocKey | خيط | مفتاح السلسلة النصية في مورد السلسلة الخاص بالتطبيق لاستخدامه في ترجمة النص الأساسي. |
| معرف القناة | خيط | معرف قناة إشعارات Android (جديد في Android O). يجب أن يقوم التطبيق بإنشاء قناة بمعرف القناة هذا قبل تلقي أي إشعار بمعرف القناة هذا. إذا لم ترسل معرف القناة هذا في الطلب، أو إذا لم يتم إنشاء معرف القناة المقدم بواسطة التطبيق بعد، فستستخدم FCM معرف القناة المحدد في بيان التطبيق. |
| انقر فوق الإجراء | خيط | الإجراء المرتبط بنقر المستخدم على الإشعار. إذا تم تحديده، فسيتم تشغيل نشاط باستخدام مرشح الأغراض المطابق عندما ينقر المستخدم على الإشعار. |
| لون | خيط | لون أيقونة الإشعارات بتنسيق #rrggbb . |
| defaultLightSettings | منطقية | إذا تم التعيين على 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 المحددة من قبل المستخدم. |
| this.eventTimestamp | تاريخ | بالنسبة للإشعارات التي تعلم المستخدمين بالأحداث باستخدام مرجع زمني مطلق، قم بتعيين الوقت الذي وقع فيه الحدث في الإشعار. يتم فرز الإشعارات الموجودة في اللوحة حسب هذا الوقت. |
| أيقونة | خيط | مورد أيقونة لإشعارات Android. |
| رابط الصورة | خيط | عنوان URL للصورة التي سيتم عرضها في الإشعار. |
| إعدادات الضوء | إعدادات الضوء | إعدادات للتحكم في معدل وميض مؤشر LED للإشعار ولونه في حالة توفر مؤشر LED على الجهاز. يتم التحكم في إجمالي وقت الوميض بواسطة نظام التشغيل. |
| محلي فقط | منطقية | يضبط ما إذا كان هذا الإشعار مرتبطًا بالجهاز الحالي فقط أم لا. يمكن توصيل بعض الإشعارات بأجهزة أخرى لعرضها عن بُعد، مثل ساعة Wear OS. يمكن تعيين هذا التلميح للتوصية بعدم سد هذا الإشعار. راجع أدلة Wear OS . |
| notificationCount | رقم | يضبط عدد العناصر التي يمثلها هذا الإشعار. قد يتم عرضها كعدد شارات لمشغلات التشغيل التي تدعم الشارات. راجع شارة الإشعارات . على سبيل المثال، قد يكون هذا مفيدًا إذا كنت تستخدم إشعارًا واحدًا فقط لتمثيل عدة رسائل جديدة ولكنك تريد أن يمثل العدد هنا إجمالي عدد الرسائل الجديدة. إذا كان الرقم صفرًا أو غير محدد، فإن الأنظمة التي تدعم الشارات تستخدم الإعداد الافتراضي، وهو زيادة الرقم المعروض في قائمة الضغط لفترة طويلة في كل مرة يصل فيها إشعار جديد. |
| أولوية | ('الحد الأدنى' | 'المنخفض' | 'الافتراضي' | 'العالي' | 'الحد الأقصى') | يضبط الأولوية النسبية لهذا الإشعار. قد يتم إخفاء الإشعارات ذات الأولوية المنخفضة عن المستخدم في مواقف معينة. لاحظ أن هذه الأولوية تختلف عن AndroidMessagePriority . تتم معالجة هذه الأولوية من قبل العميل بعد تسليم الرسالة. في حين أن AndroidMessagePriority هو مفهوم FCM يتحكم في وقت تسليم الرسالة. |
| صوت | خيط | اسم ملف الصوت الذي سيتم تشغيله عندما يتلقى الجهاز الإشعار. |
| لزج | منطقية | عند التعيين على false أو عدم تعيينه، يتم رفض الإشعار تلقائيًا عندما ينقر عليه المستخدم في اللوحة. عند التعيين على true ، يستمر الإشعار حتى عندما ينقر عليه المستخدم. |
| بطاقة شعار | خيط | علامة الإخطار. هذا هو المعرف المستخدم لاستبدال الإشعارات الموجودة في درج الإشعارات. إذا لم يتم تحديده، يقوم كل طلب بإنشاء إشعار جديد. |
| شريط | خيط | يضبط نص "المؤشر" الذي يتم إرساله إلى خدمات إمكانية الوصول. قبل مستوى واجهة برمجة التطبيقات (API) 21 (Lollipop)، قم بتعيين النص الذي يتم عرضه في شريط الحالة عند وصول الإشعار لأول مرة. |
| عنوان | خيط | عنوان إشعار Android. عند توفيره، يتجاوز العنوان الذي تم تعيينه عبر admin.messaging.Notification . |
| titleLocArgs | خيط[] | مجموعة من مفاتيح الموارد التي سيتم استخدامها بدلاً من محددات التنسيق في titleLocKey . |
| titleLocKey | خيط | مفتاح سلسلة العنوان في مورد سلسلة التطبيق لاستخدامه في ترجمة نص العنوان. |
| vibrateTimingsMillis | رقم[] | يضبط نمط الاهتزاز المطلوب استخدامه. مرر مجموعة من المللي ثانية لتشغيل الهزاز أو إيقاف تشغيله. تشير القيمة الأولى إلى مدة الانتظار قبل تشغيل الهزاز. تشير القيمة التالية إلى مدة إبقاء الهزاز قيد التشغيل. تتناوب القيم اللاحقة بين المدة لإيقاف تشغيل الهزاز وتشغيله. إذا تم تعيين vibrate_timings وتم تعيين default_vibrate_timings على true ، فسيتم استخدام القيمة الافتراضية بدلاً من vibrate_timings التي حددها المستخدم. |
| الرؤية | ("خاص" | "عام" | "سري") | يضبط رؤية الإخطار. ويجب أن تكون private أو public أو secret . إذا لم يتم تحديده، فسيتم تعيينه افتراضيًا على private . |
AndroidNotification.body
نص إشعار Android. عند توفيره، يتجاوز النص الذي تم تعيينه عبر admin.messaging.Notification .
إمضاء:
body?: string;
AndroidNotification.bodyLocArgs
مجموعة من مفاتيح الموارد التي سيتم استخدامها بدلاً من محددات التنسيق في bodyLocKey .
إمضاء:
bodyLocArgs?: string[];
AndroidNotification.bodyLocKey
مفتاح السلسلة النصية في مورد السلسلة الخاص بالتطبيق لاستخدامه في ترجمة النص الأساسي.
إمضاء:
bodyLocKey?: string;
AndroidNotification.channelId
معرف قناة إشعارات Android (جديد في Android O). يجب أن يقوم التطبيق بإنشاء قناة بمعرف القناة هذا قبل تلقي أي إشعار بمعرف القناة هذا. إذا لم ترسل معرف القناة هذا في الطلب، أو إذا لم يتم إنشاء معرف القناة المقدم بواسطة التطبيق بعد، فستستخدم FCM معرف القناة المحدد في بيان التطبيق.
إمضاء:
channelId?: string;
AndroidNotification.clickAction
الإجراء المرتبط بنقر المستخدم على الإشعار. إذا تم تحديده، فسيتم تشغيل نشاط باستخدام مرشح الأغراض المطابق عندما ينقر المستخدم على الإشعار.
إمضاء:
clickAction?: string;
AndroidNotification.color
لون أيقونة الإشعارات بتنسيق #rrggbb .
إمضاء:
color?: string;
AndroidNotification.defaultLightSettings
إذا تم تعيينه على true ، استخدم إعدادات ضوء LED الافتراضية لإطار عمل Android للإشعار. تم تحديد القيم الافتراضية في config.xml . إذا تم تعيين default_light_settings على true وتم تعيين light_settings أيضًا، فسيتم استخدام light_settings المحدد من قبل المستخدم بدلاً من القيمة الافتراضية.
إمضاء:
defaultLightSettings?: boolean;
AndroidNotification.defaultSound
إذا تم تعيينه على true ، استخدم الصوت الافتراضي لإطار عمل Android للإشعار. تم تحديد القيم الافتراضية في config.xml .
إمضاء:
defaultSound?: boolean;
AndroidNotification.defaultVibrateTimings
إذا تم تعيينه على true ، استخدم نمط الاهتزاز الافتراضي لإطار عمل Android للإشعار. تم تحديد القيم الافتراضية في config.xml . إذا تم تعيين default_vibrate_timings على true وتم تعيين vibrate_timings أيضًا، فسيتم استخدام القيمة الافتراضية بدلاً من vibrate_timings المحددة من قبل المستخدم .
إمضاء:
defaultVibrateTimings?: boolean;
AndroidNotification.eventTimestamp
بالنسبة للإشعارات التي تعلم المستخدمين بالأحداث باستخدام مرجع زمني مطلق، قم بتعيين الوقت الذي وقع فيه الحدث في الإشعار. يتم فرز الإشعارات الموجودة في اللوحة حسب هذا الوقت.
إمضاء:
eventTimestamp?: Date;
AndroidNotification.icon
مورد أيقونة لإشعارات Android.
إمضاء:
icon?: string;
AndroidNotification.imageUrl
عنوان URL للصورة التي سيتم عرضها في الإشعار.
إمضاء:
imageUrl?: string;
AndroidNotification.lightSettings
إعدادات للتحكم في معدل وميض مؤشر LED للإشعار ولونه في حالة توفر مؤشر LED على الجهاز. يتم التحكم في إجمالي وقت الوميض بواسطة نظام التشغيل.
إمضاء:
lightSettings?: LightSettings;
AndroidNotification.localOnly
يضبط ما إذا كان هذا الإشعار مرتبطًا بالجهاز الحالي فقط أم لا. يمكن توصيل بعض الإشعارات بأجهزة أخرى لعرضها عن بُعد، مثل ساعة Wear OS. يمكن تعيين هذا التلميح للتوصية بعدم سد هذا الإشعار. راجع أدلة Wear OS .
إمضاء:
localOnly?: boolean;
AndroidNotification.notificationCount
يضبط عدد العناصر التي يمثلها هذا الإشعار. قد يتم عرضها كعدد شارات لمشغلات التشغيل التي تدعم الشارات. راجع شارة الإشعارات . على سبيل المثال، قد يكون هذا مفيدًا إذا كنت تستخدم إشعارًا واحدًا فقط لتمثيل عدة رسائل جديدة ولكنك تريد أن يمثل العدد هنا إجمالي عدد الرسائل الجديدة. إذا كان الرقم صفرًا أو غير محدد، فإن الأنظمة التي تدعم الشارات تستخدم الإعداد الافتراضي، وهو زيادة الرقم المعروض في قائمة الضغط لفترة طويلة في كل مرة يصل فيها إشعار جديد.
إمضاء:
notificationCount?: number;
AndroidNotification.priority
يضبط الأولوية النسبية لهذا الإشعار. قد يتم إخفاء الإشعارات ذات الأولوية المنخفضة عن المستخدم في مواقف معينة. لاحظ أن هذه الأولوية تختلف عن AndroidMessagePriority . تتم معالجة هذه الأولوية من قبل العميل بعد تسليم الرسالة. في حين أن AndroidMessagePriority هو مفهوم FCM يتحكم في وقت تسليم الرسالة.
إمضاء:
priority?: ('min' | 'low' | 'default' | 'high' | 'max');
AndroidNotification.sound
اسم ملف الصوت الذي سيتم تشغيله عندما يتلقى الجهاز الإشعار.
إمضاء:
sound?: string;
AndroidNotification.sticky
عند التعيين على false أو عدم تعيينه، يتم رفض الإشعار تلقائيًا عندما ينقر عليه المستخدم في اللوحة. عند التعيين على true ، يستمر الإشعار حتى عندما ينقر عليه المستخدم.
إمضاء:
sticky?: boolean;
AndroidNotification.tag
علامة الإخطار. هذا هو المعرف المستخدم لاستبدال الإشعارات الموجودة في درج الإشعارات. إذا لم يتم تحديده، يقوم كل طلب بإنشاء إشعار جديد.
إمضاء:
tag?: string;
AndroidNotification.ticker
يضبط نص "المؤشر" الذي يتم إرساله إلى خدمات إمكانية الوصول. قبل مستوى واجهة برمجة التطبيقات (API) 21 (Lollipop)، قم بتعيين النص الذي يتم عرضه في شريط الحالة عند وصول الإشعار لأول مرة.
إمضاء:
ticker?: string;
AndroidNotification.title
عنوان إشعار Android. عند توفيره، يتجاوز العنوان الذي تم تعيينه عبر admin.messaging.Notification .
إمضاء:
title?: string;
AndroidNotification.titleLocArgs
مجموعة من مفاتيح الموارد التي سيتم استخدامها بدلاً من محددات التنسيق في titleLocKey .
إمضاء:
titleLocArgs?: string[];
AndroidNotification.titleLocKey
مفتاح سلسلة العنوان في مورد سلسلة التطبيق لاستخدامه في ترجمة نص العنوان.
إمضاء:
titleLocKey?: string;
AndroidNotification.vibrateTimingsMillis
يضبط نمط الاهتزاز المطلوب استخدامه. مرر مجموعة من المللي ثانية لتشغيل الهزاز أو إيقاف تشغيله. تشير القيمة الأولى إلى مدة الانتظار قبل تشغيل الهزاز. تشير القيمة التالية إلى مدة إبقاء الهزاز قيد التشغيل. تتناوب القيم اللاحقة بين المدة لإيقاف تشغيل الهزاز وتشغيله. إذا تم ضبط vibrate_timings وتم ضبط default_vibrate_timings على true ، يتم استخدام القيمة الافتراضية بدلاً من vibrate_timings المحدد بواسطة المستخدم .
إمضاء:
vibrateTimingsMillis?: number[];
AndroidNotification.visibility
يضبط رؤية الإخطار. يجب أن تكون إما private ، public ، أو secret . إذا لم يتم تحديده، فسيتم تعيينه افتراضيًا على private .
إمضاء:
visibility?: ('private' | 'public' | 'secret');