firebase-admin.messaging package

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

الوظائف

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

صفوف

الفئة	الوصف
المراسلة	خدمة المراسلة المرتبطة بالتطبيق المتوفر.

الواجهات

الواجهة	الوصف
إعداد Android	تُمثِّل هذه السمة الخيارات الخاصة بنظام التشغيل Android التي يمكن تضمينها في رسالة.
AndroidFcmOptions	لتمثيل خيارات الميزات التي توفّرها حزمة تطوير البرامج (SDK) لخدمة "المراسلة عبر السحابة الإلكترونية من Firebase" لنظام التشغيل Android.
AndroidNotification	ويمثِّل ذلك خيارات الإشعارات الخاصة بنظام التشغيل Android التي يمكن تضمينها في AndroidConfig.
ApnsConfig	يُمثِّل ذلك الخيارات الخاصة بأسماء نقاط الوصول (APN) التي يمكن تضمينها في رسالة. يمكنك الرجوع إلى وثائق Apple للتعرّف على العديد من العناوين وحقول الحمولة المتوافقة مع أسماء نقاط الوصول (APN).
ApnsFcmOptions	لتمثيل خيارات الميزات التي توفّرها حزمة تطوير البرامج (SDK) لخدمة "المراسلة عبر السحابة الإلكترونية من Firebase" لنظام التشغيل iOS.
ApnsPayload	تمثل حمولة رسالة أسماء نقاط الوصول (APN). يتكون بشكل رئيسي من قاموس aps. وقد تحتوي أيضًا على مفاتيح أخرى مخصّصة عشوائية.
التطبيقات	يمثله قاموس aps الذي يُعد جزءًا من رسائل أسماء نقاط الوصول (APN).
ApsAlert
BaseMessage
BatchResponse	واجهة تمثّل استجابة الخادم من الطريقتَين Messaging.sendAll() وMessaging.sendMulticast()
ConditionMessage
CriticalSound	ويمثِّل إعدادًا صوتيًا مهمًا يمكن تضمينه في قاموس aps لحمولة أسماء نقاط الوصول (APN).
DataMessagePayload	واجهة تمثّل حمولة بيانات رسالة واجهة برمجة التطبيقات القديمة لخدمة "المراسلة عبر السحابة الإلكترونية من Firebase". تتيح رسائل البيانات للمطوّرين إرسال ما يصل إلى 4 كيلوبايت من أزواج المفتاح/القيمة المخصّصة. يجب أن تكون كل من المفاتيح والقيم سلاسل. يمكن أن تكون المفاتيح أي سلسلة مخصّصة، باستثناء السلاسل المحجوزة التالية: from أي عناصر يبدأ بـ google. راجِع إنشاء طلبات الإرسال لعيّنات التعليمات البرمجية والمستندات التفصيلية.
FCMOptions	تُمثِّل هذه السمة خيارات مستقلة عن النظام الأساسي للميزات التي توفّرها حِزم تطوير البرامج (SDK) لخدمة "المراسلة عبر السحابة الإلكترونية من Firebase".
LightSettings (إعدادات Light)	يمثل ذلك الإعدادات للتحكّم في مصباح LED الخاص بالإشعارات التي يمكن تضمينها في AndroidNotification.
MessagingConditionResponse	واجهة تمثِّل استجابة الخادم من طريقة Messaging.sendToCondition() القديمة.يمكنك الاطّلاع على الإرسال إلى شرط لنماذج الرموز البرمجية والمستندات التفصيلية.
MessagingDeviceGroupResponse	واجهة تمثِّل استجابة الخادم من طريقة Messaging.sendToDeviceGroup()يمكنك الاطّلاع على إرسال رسائل إلى مجموعات الأجهزة للتعرُّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.
MessagingDeviceResult	حمولة الاستجابة للحالة الفردية من الأجهزة الفردية
MessagingDevicesResponse	واجهة تمثِّل حالة رسالة تم إرسالها إلى جهاز فردي من خلال واجهات برمجة التطبيقات القديمة للمراسلة عبر السحابة الإلكترونية من Firebase.يمكنك الاطّلاع على الإرسال إلى أجهزة فردية للتعرُّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.
خيارات المراسلة	واجهة تمثل الخيارات التي يمكن تقديمها عند إرسال رسالة عبر واجهات برمجة التطبيقات القديمة لخدمة "المراسلة عبر السحابة الإلكترونية من Firebase".يمكنك الاطّلاع على إنشاء طلبات الإرسال لعيّنات التعليمات البرمجية والمستندات التفصيلية.
حمولة الرسائل	واجهة تمثِّل حمولة رسالة "المراسلة عبر السحابة الإلكترونية من Firebase" يجب استخدام أحد المفتاحَين data وnotification أو كليهما.يُرجى الاطّلاع على إنشاء طلبات الإرسال لنماذج الرموز والمستندات التفصيلية.
MessagingTopicManagementResponse	واجهة تمثل استجابة الخادم من طريقةَي Messaging.subscribeToTopic() وMessaging.unsubscribeFromTopic().يُرجى الاطّلاع على إدارة المواضيع من الخادم للحصول على عيّنات من الرموز البرمجية والمستندات التفصيلية.
MessagingTopicResponse	واجهة تمثِّل استجابة الخادم من طريقة Messaging.sendToTopic() القديمة.يُرجى الاطّلاع على الإرسال إلى موضوع للتعرُّف على عيّنات التعليمات البرمجية والمستندات التفصيلية.
MulticastMessage	الحمولة لطريقة Messaging.sendMulticast(). تحتوي حمولة البيانات على جميع الحقول في النوع BaseMessage، بالإضافة إلى قائمة بالرموز المميّزة.
الإشعار	إشعار يمكن تضمينه في رسالة.
NotificationMessagePayload	واجهة تمثِّل حمولة رسالة إشعار واجهة برمجة التطبيقات القديمة لخدمة FCM تتيح رسائل الإشعارات للمطوّرين إرسال ما يصل إلى 4 كيلوبايت من أزواج المفتاح/القيمة المحدَّدة مسبقًا. يمكنك الاطّلاع أدناه على المفاتيح المقبولة.يمكنك الاطّلاع على إنشاء طلبات الإرسال لنماذج الرموز البرمجية والمستندات التفصيلية.
SendResponse	واجهة تمثِّل حالة رسالة فردية تم إرسالها كجزء من طلب مجمّع
TokenMessage
TopicMessage
WebpushConfig	يمثل خيارات بروتوكول WebPush التي يمكن تضمينها في رسالة.
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;

المَعلمات

المَعلمة	Type	الوصف
التطبيق	التطبيق	التطبيق الاختياري الذي سيتم إرجاع خدمة 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;