المراسلة السحابية من Firebase (FCM).
المهام
وظيفة | وصف |
---|---|
الحصول على الرسائل (التطبيق) | يحصل على خدمة المراسلة للتطبيق الافتراضي أو تطبيق معين. يمكن استدعاء admin.messaging() بدون وسائط للوصول إلى خدمة Messaging الخاصة بالتطبيق الافتراضي أو ك admin.messaging(app) للوصول إلى خدمة Messaging المرتبطة بتطبيق معين. |
الطبقات
فصل | وصف |
---|---|
المراسلة | خدمة المراسلة مرتبطة بالتطبيق المقدم. |
واجهات
واجهه المستخدم | وصف |
---|---|
تكوين أندرويد | يمثل الخيارات الخاصة بنظام Android والتي يمكن تضمينها في الرسالة . |
AndroidFcmOptions | يمثل خيارات الميزات التي توفرها FCM SDK لنظام Android. |
AndroidNotification | يمثل خيارات الإشعارات الخاصة بنظام Android والتي يمكن تضمينها في AndroidConfig . |
ApnsConfig | يمثل الخيارات الخاصة بـ APNs والتي يمكن تضمينها في الرسالة . راجع وثائق Apple للتعرف على الرؤوس وحقول الحمولة المتنوعة التي تدعمها شبكات APN. |
ApnsFcmOptions | يمثل خيارات الميزات التي توفرها FCM SDK لنظام التشغيل iOS. |
ApnsPayload | يمثل حمولة رسالة APNs. يتكون بشكل رئيسي من قاموس aps . ولكن قد تحتوي أيضًا على مفاتيح مخصصة تعسفية أخرى. |
أبس | يمثل قاموس aps الذي يعد جزءًا من رسائل APNs. |
تنبيه أبس | |
رسالة أساسية | |
استجابة دفعة | واجهة تمثل استجابة الخادم من طريقتي Messaging.sendAll() و Messaging.sendMulticast() . |
رسالة الحالة | |
الصوت الحرج | يمثل تكوينًا صوتيًا مهمًا يمكن تضمينه في قاموس aps لحمولة APNs. |
DataMessagePayload | واجهة تمثل حمولة رسالة بيانات واجهة برمجة التطبيقات (API) القديمة لـ FCM. تسمح رسائل البيانات للمطورين بإرسال ما يصل إلى 4 كيلو بايت من أزواج القيمة الرئيسية المخصصة. يجب أن تكون المفاتيح والقيم عبارة عن سلاسل. يمكن أن تكون المفاتيح أي سلسلة مخصصة، باستثناء السلاسل المحجوزة التالية:
|
خيارات fcm | يمثل خيارات مستقلة عن النظام الأساسي للميزات التي توفرها مجموعات FCM SDK. |
إعدادات الضوء | يمثل الإعدادات للتحكم في مؤشر LED للإشعارات التي يمكن تضمينها في AndroidNotification . |
MessagingConditionResponse | واجهة تمثل استجابة الخادم من الأسلوب Messaging.sendToCondition() القديم. راجع إرسال إلى شرط للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. |
MessagingDeviceGroupResponse | واجهة تمثل استجابة الخادم من أسلوب Messaging.sendToDeviceGroup() . راجع إرسال رسائل إلى مجموعات الأجهزة للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. |
MessagingDeviceResult | حمولة استجابة الحالة الفردية من الأجهزة الفردية |
استجابة أجهزة المراسلة | واجهة تمثل حالة الرسالة المرسلة إلى جهاز فردي عبر واجهات برمجة تطبيقات FCM القديمة. راجع الإرسال إلى الأجهزة الفردية للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. |
خيارات المراسلة | واجهة تمثل الخيارات التي يمكن توفيرها عند إرسال رسالة عبر واجهات برمجة تطبيقات FCM القديمة. راجع إنشاء طلبات الإرسال للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. |
MessagingPayload | واجهة تمثل حمولة رسالة Firebase Cloud Messaging. يلزم وجود أحد مفاتيح data notification أو كليهما. راجع إنشاء طلبات الإرسال للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. |
المراسلة موضوع إدارة الاستجابة | واجهة تمثل استجابة الخادم من طريقتي Messaging.subscribeToTopic() و Messaging.unsubscribeFromTopic() . راجع إدارة المواضيع من الخادم للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. |
المراسلة موضوع الاستجابة | واجهة تمثل استجابة الخادم من الأسلوب Messaging.sendToTopic() القديم. راجع إرسال إلى موضوع للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. |
رسالة البث المتعدد | الحمولة للأسلوب Messaging.sendMulticast() . تحتوي الحمولة على كافة الحقول في نوع BaseMessage، وقائمة من الرموز المميزة. |
إشعار | إشعار يمكن تضمينه في الرسالة . |
NotificationMessagePayload | واجهة تمثل حمولة رسالة إعلام واجهة برمجة التطبيقات (API) القديمة لـ FCM. تسمح رسائل الإشعارات للمطورين بإرسال ما يصل إلى 4 كيلو بايت من أزواج القيمة والمفتاح المحددة مسبقًا. المفاتيح المقبولة موضحة أدناه. راجع إنشاء طلبات الإرسال للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. |
أرسل جوابا | واجهة تمثل حالة الرسالة الفردية التي تم إرسالها كجزء من طلب دفعة. |
رسالة مميزة | |
رسالة الموضوع | |
WebpushConfig | يمثل خيارات بروتوكول WebPush التي يمكن تضمينها في الرسالة . |
WebpushFcmOptions | يمثل خيارات الميزات التي توفرها FCM SDK للويب (والتي ليست جزءًا من معيار Webpush). |
WebpushNotification | يمثل خيارات الإعلام الخاصة بـ WebPush والتي يمكن تضمينها في WebpushConfig . ويدعم هذا معظم الخيارات القياسية كما هو محدد في مواصفات إشعارات الويب . |
اكتب الأسماء المستعارة
اكتب الاسم المستعار | وصف |
---|---|
رسالة | الحمولة الخاصة بعملية Messaging.send() . تحتوي الحمولة على كافة الحقول الموجودة في نوع BaseMessage، بالإضافة إلى حقل واحد بالضبط من الرمز المميز أو الموضوع أو الشرط. |
الحصول على الرسائل ()
يحصل على خدمة المراسلة للتطبيق الافتراضي أو تطبيق معين.
يمكن استدعاء admin.messaging()
بدون وسائط للوصول إلى خدمة Messaging
الخاصة بالتطبيق الافتراضي أو ك admin.messaging(app)
للوصول إلى خدمة Messaging
المرتبطة بتطبيق معين.
إمضاء:
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، بالإضافة إلى حقل واحد بالضبط من الرمز المميز أو الموضوع أو الشرط.
إمضاء:
export type Message = TokenMessage | TopicMessage | ConditionMessage;