firebase-admin.messaging package

خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" (FCM).

الدوال

دالة	الوصف
getMessaging(app)	يحصل على خدمة المراسلة للتطبيق التلقائي أو لتطبيق معيّن.ويمكن استدعاء admin.messaging() بدون وسيطات للوصول إلى خدمة Messaging للتطبيق التلقائي أو كملف admin.messaging(app) للوصول إلى خدمة Messaging المرتبطة بتطبيق معيّن.

صفوف

الفئة	الوصف
خطأ مراسلة Firebase	بنية رمز خطأ "مراسلة Firebase". يؤدي ذلك إلى تمديد PrefixedFirebaseError.
المراسلة	خدمة المراسلة المرتبطة بالتطبيق المقدّم
MessagingClientErrorCode	رموز الخطأ في برنامج المراسلة ورسائلها التلقائية

واجهات

الواجهة	الوصف
إعداد Android	وتمثِّل الخيارات الخاصة بنظام التشغيل Android التي يمكن تضمينها في رسالة.
AndroidFcmOptions	يمثّل هذا الإعداد خيارات الميزات التي توفّرها حزمة تطوير البرامج لخدمة "المراسلة عبر السحابة الإلكترونية من Firebase" لنظام التشغيل Android.
AndroidNotification	يمثّل هذا الإعداد خيارات الإشعارات الخاصة بنظام Android التي يمكن تضمينها في AndroidConfig.
ApnsConfig	تُمثل الخيارات الخاصة بأسماء نقاط الوصول (APN) التي يمكن تضمينها في رسالة. يُرجى الرجوع إلى مستندات Apple للاطّلاع على العناوين وحقول الحمولة المختلفة التي تتيحها أسماء نقاط الوصول.
ApnsFcmOptions	يمثّل هذا الإعداد خيارات الميزات التي توفّرها حزمة تطوير البرامج لخدمة "المراسلة عبر السحابة الإلكترونية من Firebase" لنظام التشغيل iOS.
ApnsPayload	يمثل حمولة رسالة أسماء نقاط الوصول (APN). يتكوّن بشكل أساسي من قاموس aps. وقد يحتوي أيضًا على مفاتيح مخصّصة عشوائية أخرى.
تطبيقات	يمثل قاموس تطبيقات Google الذي يُعد جزءًا من رسائل أسماء نقاط الوصول (APN).
ApsAlert
BaseMessage
BatchResponse	واجهة تمثِّل استجابة الخادم من الطريقتَين Messaging.sendAll() وMessaging.sendMulticast().
ConditionMessage
CriticalSound	تُمثِّل هذه الإعدادات إعدادات الصوت المهمة التي يمكن تضمينها في قاموس aps الخاص بحمولة أسماء نقاط الوصول (APN).
DataMessagePayload	واجهة تمثّل حمولة رسائل بيانات واجهة برمجة التطبيقات القديمة في خدمة "المراسلة عبر السحابة الإلكترونية من Firebase". تتيح رسائل البيانات للمطوّرين إرسال ما يصل إلى 4 كيلوبايت من أزواج المفتاح/القيمة المخصّصة. يجب أن تكون كل من المفاتيح والقيم سلسلتين. يمكن أن تكون المفاتيح أي سلسلة مخصصة، باستثناء السلاسل المحجوزة التالية: from أي قيمة تبدأ بـ google. راجِع إنشاء طلبات الإرسال لعيّنات التعليمات البرمجية والمستندات التفصيلية.
FcmOptions	يمثّل هذا الخيار خيارات مستقلة عن النظام الأساسي للميزات التي توفّرها حِزم تطوير البرامج (SDK) لخدمة "المراسلة عبر السحابة الإلكترونية من Firebase".
إعدادات LightSettings	يمثّل هذا الإعداد إعدادات التحكُّم في مصباح LED للإشعارات التي يمكن تضمينها في AndroidNotification.
MessagingConditionResponse	واجهة تمثِّل استجابة الخادم من طريقة Messaging.sendToCondition() القديمة.يمكنك الاطّلاع على الإرسال إلى شرط للحصول على عيّنات من الرموز البرمجية والمستندات التفصيلية.
MessagingDeviceGroupResponse	واجهة تمثِّل استجابة الخادم من طريقة Messaging.sendToDeviceGroup().يمكنك الاطّلاع على إرسال رسائل إلى مجموعات الأجهزة للاطّلاع على عيّنات من الرموز البرمجية والمستندات التفصيلية.
MessagingDeviceResult	حمولة الاستجابة للحالة الفردية من أجهزة فردية
MessagingDevicesResponse	واجهة تمثّل حالة رسالة مُرسَلة إلى جهاز فردي من خلال واجهات برمجة التطبيقات القديمة في خدمة "المراسلة عبر السحابة الإلكترونية من Firebase".يمكنك الاطّلاع على الإرسال إلى أجهزة فردية للاطّلاع على عيّنات من الرموز البرمجية والمستندات التفصيلية.
MessagingOptions	واجهة تمثّل الخيارات التي يمكن توفيرها عند إرسال رسالة عبر واجهات برمجة التطبيقات القديمة للمراسلة عبر السحابة الإلكترونية من Firebase.يُرجى الاطّلاع على إنشاء طلبات الإرسال لعينات التعليمات البرمجية والمستندات التفصيلية.
MessagingPayload	واجهة تمثّل حمولة رسائل "المراسلة عبر السحابة الإلكترونية من Firebase" يجب إدخال أحد المفتاحَين data وnotification أو كليهما.راجِع إنشاء طلبات الإرسال لنماذج الرموز والمستندات التفصيلية.
MessagingTopicManagementResponse	واجهة تمثِّل استجابة الخادم من الطريقتَين Messaging.UnsubscribeToTopic() وMessaging.unsubscribeFromTopic().يمكنك الاطّلاع على إدارة المواضيع من الخادم للاطّلاع على عيّنات من الرموز البرمجية والمستندات التفصيلية.
MessagingTopicResponse	واجهة تمثِّل استجابة الخادم من طريقة Messaging.sendToTopic() القديمة.يمكنك الاطّلاع على الإرسال إلى موضوع للحصول على عيّنات من الرموز البرمجية والمستندات التفصيلية.
رسالة البث المتعدد	الحمولة لطريقة Messaging.sendMulticast(). تحتوي الحمولة على جميع الحقول في نوع BaseMessage، بالإضافة إلى قائمة بالرموز المميّزة.
إشعار	إشعار يمكن تضمينه في رسالة
NotificationMessagePayload	واجهة تمثّل حمولة رسائل إشعارات واجهة برمجة التطبيقات القديمة في خدمة "المراسلة عبر السحابة الإلكترونية من Firebase". تتيح رسائل الإشعارات للمطوّرين إرسال ما يصل إلى 4 كيلوبايت من أزواج المفتاح/القيمة المحدّدة مسبقًا. في ما يلي توضيح المفاتيح المقبولة.راجِع إنشاء طلبات إرسال لعيّنات التعليمات البرمجية والمستندات التفصيلية.
SendResponse	واجهة تمثّل حالة رسالة فردية تم إرسالها كجزء من طلب مجمّع.
TokenMessage
رسالة موضوع
WebpushConfig	تمثِّل هذه السمة خيارات بروتوكول WebPush التي يمكن تضمينها في Message.
WebpushFcmOptions	يمثّل هذا النوع خيارات الميزات التي توفّرها "حزمة تطوير البرامج (SDK) لخدمة "المراسلة عبر السحابة الإلكترونية من Firebase" للويب (والتي ليست جزءًا من معيار Webpush).
WebpushNotification	وتمثِّل هذه السمة خيارات الإشعارات الخاصة بـ WebPush التي يمكن تضمينها في WebpushConfig. يوفّر ذلك معظم الخيارات العادية على النحو المحدّد في مواصفات إشعارات الويب.

كتابة العناوين البديلة للبريد الإلكتروني

اكتب العنوان البديل للبريد الإلكتروني	الوصف
رسالة	حمولة عملية Messaging.send(). تحتوي الحمولة على جميع الحقول في نوع BaseMessage، بالإضافة إلى حقل واحد فقط من الرمز المميّز أو الموضوع أو الشرط.

getMessaging(app)

يحصل على خدمة المراسلة للتطبيق التلقائي أو تطبيق معيَّن.

يمكن استدعاء admin.messaging() بدون أي وسيطات للوصول إلى خدمة Messaging للتطبيق التلقائي أو باستخدام admin.messaging(app) للوصول إلى خدمة Messaging المرتبطة بتطبيق مُحدّد.

Signature:

export declare function getMessaging(app?: App): Messaging;

المَعلمات

المعلمة	النوع	الوصف
التطبيق	التطبيق	تطبيق اختياري مطلوب إرجاع خدمة Messaging إليه. وفي حال عدم توفّره، سيتم عرض خدمة "Messaging" التلقائية.

المرتجعات:

المراسلة

خدمة Messaging التلقائية في حال عدم توفير أي تطبيق أو خدمة Messaging المرتبطة بالتطبيق المقدَّم.

مثال 1

// Get the Messaging service for the default app
const defaultMessaging = getMessaging();

مثال 2

// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);

الرسالة

حمولة عملية Messaging.send(). تحتوي الحمولة على جميع الحقول في نوع BaseMessage، بالإضافة إلى حقل واحد فقط من الرمز المميّز أو الموضوع أو الشرط.

Signature:

export type Message = TokenMessage | TopicMessage | ConditionMessage;