واجهة تمثّل حمولة رسائل إشعارات واجهة برمجة التطبيقات القديمة في خدمة "المراسلة عبر السحابة الإلكترونية من Firebase". تتيح رسائل الإشعارات للمطوّرين إرسال ما يصل إلى 4 كيلوبايت من أزواج المفتاح/القيمة المحدّدة مسبقًا. في ما يلي توضيح للمفاتيح المقبولة.
راجِع إنشاء طلبات الإرسال للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية.
Signature:
export interface NotificationMessagePayload
أماكن إقامة
| الموقع | النوع | الوصف |
|---|---|---|
| شارة | السلسلة | قيمة الشارة في رمز تطبيق الشاشة الرئيسيةلا تتغيّر الشارة في حال عدم تحديدها.عند ضبط القيمة على 0، تتم إزالة الشارة.**المنصات:** iOS |
| النص | السلسلة | النص الأساسي للإشعار.**الأنظمة الأساسية:** iOS وAndroid والويب |
| bodyLocArgs | السلسلة | قيم سلسلة متغيرة يتم استخدامها بدلاً من محددات التنسيق في body_loc_key بغرض أقلمة النص الأساسي وفقًا للترجمة الحالية للمستخدم.يجب أن تكون القيمة مصفوفة JSON تم تحويلها إلى سلسلة.**iOS:** تتوافق مع loc-args في حمولة أسماء نقاط الوصول. لمزيد من المعلومات، يمكنك الاطّلاع على مرجع مفتاح Payload وأقلمة محتوى الإشعارات عن بُعد للحصول على مزيد من المعلومات.**Android:** يمكنك الاطّلاع على التنسيق والنمط للحصول على مزيد من المعلومات.**الأنظمة الأساسية:** iOS وAndroid |
| bodyLocKey | السلسلة | مفتاح سلسلة النص الأساسي في مصادر سلسلة التطبيق لاستخدامه في أقلمة النص الأساسي وفقًا للأقلمة الحالية للمستخدم.**iOS:** يتوافق مع loc-key في حمولة أسماء نقاط الوصول (APN). يمكنك الاطّلاع على مرجع مفتاح Payload وأقلمة محتوى الإشعارات عن بُعد للحصول على مزيد من المعلومات.**Android:** يمكنك الاطّلاع على موارد السلسلة للحصول على مزيد من المعلومات.**الأنظمة الأساسية:** iOS وAndroid |
| clickAction | السلسلة | إجراء مرتبط بنقرة مستخدم على الإشعار. وفي حالة تحديد هذا الخيار، يتم تشغيل نشاط يحتوي على فلتر أهداف مطابق عندما ينقر المستخدم على الإشعار.* **الأنظمة الأساسية:** Android |
| color (اللون) | السلسلة | لون رمز الإشعار، ويتم التعبير عنه بتنسيق #rrggbb.**الأنظمة الأساسية:** Android |
| السلسلة | رمز الإشعار.**Android:** يؤدي ذلك إلى ضبط رمز الإشعار على myicon للمورد القابل للرسم myicon. في حال عدم إرسال هذا المفتاح في الطلب، ستعرض خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" رمز مشغّل التطبيقات المحدّد في بيان التطبيق.**الويب:** عنوان URL المطلوب استخدامه لرمز الإشعار.**الأنظمة الأساسية:** Android، الويب |
|
| الصوت | السلسلة | الصوت الذي سيتم تشغيله عندما يتلقّى الجهاز إشعارًا. يتوافق مع "الخيار التلقائي". للتعرّف على الصوت التلقائي لإشعارات الجهاز أو اسم ملف المصدر الصوتي المجمَّع في التطبيق يجب أن تتوفّر الملفات الصوتية في /res/raw/.**الأنظمة الأساسية:** Android |
| علامة | السلسلة | يتم استخدام المعرّف لاستبدال الإشعارات الحالية في درج الإشعارات.إذا لم يتم تحديده، ينشئ كل طلب إشعارًا جديدًا.إذا تم تحديده وكان يتم عرض إشعار بالعلامة نفسها، سيحل الإشعار الجديد محل الإشعار الحالي في درج الإشعارات.**الأنظمة الأساسية:** Android |
| title | السلسلة | عنوان الإشعار.**الأنظمة الأساسية:** iOS وAndroid والويب |
| titleLocArgs | السلسلة | قيم سلسلة متغيرة يتم استخدامها بدلاً من محددات التنسيق في title_loc_key بغرض أقلمة نص العنوان حسب الترجمة الحالية للمستخدم.يجب أن تكون القيمة مصفوفة JSON تم تحويلها إلى سلسلة.**iOS:** تتوافق مع title-loc-args في حمولة أسماء نقاط الوصول. لمزيد من المعلومات، يمكنك الاطّلاع على مرجع مفتاح Payload وأقلمة محتوى الإشعارات عن بُعد للحصول على مزيد من المعلومات.**Android:** يمكنك الاطّلاع على التنسيق والنمط للحصول على مزيد من المعلومات.**الأنظمة الأساسية:** iOS وAndroid |
| titleLocKey | السلسلة | تمثّل هذه السمة مفتاح سلسلة العنوان في موارد سلسلة التطبيق والمطلوب استخدامها لترجمة نص العنوان حسب الترجمة الحالية للمستخدم.**iOS:** تتوافق مع title-loc-key في حمولة أسماء نقاط الوصول (APN). يمكنك الاطّلاع على مرجع مفتاح Payload وأقلمة محتوى الإشعارات عن بُعد للحصول على مزيد من المعلومات.**Android:** يمكنك الاطّلاع على موارد السلسلة للحصول على مزيد من المعلومات.**الأنظمة الأساسية:** iOS وAndroid |
NotificationMessagePayload.badge
قيمة الشارة التي تظهر على رمز تطبيق الشاشة الرئيسية.
وفي حال عدم تحديد هذه السمة، لن تتغيّر الشارة.
وإذا تم ضبط الشارة على 0، ستتم إزالة الشارة.
**الأنظمة الأساسية:** iOS
Signature:
badge?: string;
NotificationMessagePayload.body
النص الأساسي للإشعار.
**الأنظمة الأساسية:** iOS وAndroid والويب
Signature:
body?: string;
NotificationMessagePayload.bodyLocArgs
قيم سلسلة المتغيّرات التي سيتم استخدامها بدلاً من محدّدات التنسيق في body_loc_key من أجل استخدام ترجمة النص الأساسي بما يناسب الأقلمة الحالية للمستخدم
يجب أن تكون القيمة مصفوفة JSON تم تحويلها إلى سلسلة.
**iOS:** يتوافق مع القيمة loc-args في البيانات الأساسية لأسماء نقاط الوصول (APN). لمزيد من المعلومات، يُرجى الاطّلاع على مرجع مفتاح حمولة البيانات وترجمة محتوى الإشعارات عن بُعد.
**Android:** يمكنك الاطّلاع على التنسيق والنمط للحصول على مزيد من المعلومات.
**الأنظمة الأساسية:** لأجهزة iOS وAndroid
Signature:
bodyLocArgs?: string;
NotificationMessagePayload.bodyLocKey
تمثّل هذه السمة مفتاح السلسلة الأساسية في موارد سلسلة التطبيق المطلوب استخدامها لترجمة النص الأساسي إلى أقلمة المستخدم الحالية.
**iOS:** يتوافق مع القيمة loc-key في البيانات الأساسية لأسماء نقاط الوصول (APN). لمزيد من المعلومات، يُرجى الاطّلاع على مرجع مفتاح حمولة البيانات وترجمة محتوى الإشعارات عن بُعد.
**Android:** يُرجى الاطّلاع على موارد السلسلة للحصول على مزيد من المعلومات.
**الأنظمة الأساسية:** لأجهزة iOS وAndroid
Signature:
bodyLocKey?: string;
NotificationMessagePayload.clickAction
إجراء مرتبط بنقرة مستخدم على الإشعار. وفي حالة تحديد هذا الخيار، يتم تشغيل نشاط يحتوي على فلتر أهداف مطابق عندما ينقر المستخدم على الإشعار.
* **الأنظمة الأساسية:** Android
Signature:
clickAction?: string;
NotificationMessagePayload.color
لون رمز الإشعار، ويتم التعبير عنه بتنسيق #rrggbb.
**الأنظمة الأساسية:** Android
Signature:
color?: string;
رمز NotificationMessagePayload.icon
رمز الإشعار.
**Android:** يتم ضبط رمز الإشعار على myicon للمورد القابل للرسم myicon. إذا لم ترسل هذا المفتاح في الطلب، ستعرض خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" رمز مشغّل التطبيقات المحدّد في بيان التطبيق.
**الويب:** عنوان URL لاستخدامه لرمز الإشعار.
**الأنظمة الأساسية:** Android، والويب
Signature:
icon?: string;
NotificationMessagePayload.sound
الصوت الذي سيتم تشغيله عندما يتلقّى الجهاز إشعارًا. يتوافق مع "الخيار التلقائي". للتعرّف على الصوت التلقائي لإشعارات الجهاز أو اسم ملف المصدر الصوتي المجمَّع في التطبيق يجب أن تتوفّر الملفات الصوتية في /res/raw/.
**الأنظمة الأساسية:** Android
Signature:
sound?: string;
علامة NotificationMessagePayload.tag
المعرّف المستخدَم لاستبدال الإشعارات الحالية في درج الإشعارات
في حال عدم تحديد قيمة، سينشئ كل طلب إشعارًا جديدًا.
إذا تم تحديده وكان يتم عرض إشعار بالعلامة نفسها، سيحل الإشعار الجديد محل الإشعار الحالي في درج الإشعارات.
**الأنظمة الأساسية:** Android
Signature:
tag?: string;
NotificationMessagePayload.title
عنوان الإشعار.
**الأنظمة الأساسية:** iOS وAndroid والويب
Signature:
title?: string;
NotificationMessagePayload.titleLocArgs
قيم سلسلة المتغيّرات التي سيتم استخدامها بدلاً من محدّدات التنسيق في title_loc_key من أجل استخدامها لترجمة نص العنوان حسب الترجمة الحالية للمستخدم
يجب أن تكون القيمة مصفوفة JSON تم تحويلها إلى سلسلة.
**iOS:** يتوافق مع القيمة title-loc-args في البيانات الأساسية لأسماء نقاط الوصول (APN). لمزيد من المعلومات، يُرجى الاطّلاع على مرجع مفتاح حمولة البيانات وترجمة محتوى الإشعارات عن بُعد.
**Android:** يمكنك الاطّلاع على التنسيق والنمط للحصول على مزيد من المعلومات.
**الأنظمة الأساسية:** لأجهزة iOS وAndroid
Signature:
titleLocArgs?: string;
NotificationMessagePayload.titleLocKey
تمثّل هذه السمة مفتاح سلسلة العنوان في موارد سلسلة التطبيق والمطلوب استخدامها لترجمة نص العنوان حسب الترجمة الحالية للمستخدم.
**iOS:** يتوافق مع القيمة title-loc-key في البيانات الأساسية لأسماء نقاط الوصول (APN). لمزيد من المعلومات، يُرجى الاطّلاع على مرجع مفتاح حمولة البيانات وترجمة محتوى الإشعارات عن بُعد.
**Android:** يُرجى الاطّلاع على موارد السلسلة للحصول على مزيد من المعلومات.
**الأنظمة الأساسية:** لأجهزة iOS وAndroid
Signature:
titleLocKey?: string;