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