@firebase/messaging/sw

الدوال

دالة الوصف
الدالّة(app, ...)
getMessaging(app) يسترد مثيل "المراسلة عبر السحابة الإلكترونية من Firebase".
الدالّة(الرسائل، ...)
experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging, enable) تفعيل أو إيقاف تصدير مقاييس تسليم رسائل خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" إلى BigQuery لا يتم تصدير مقاييس تسليم الرسائل إلى BigQuery تلقائيًا. يمكنك استخدام هذه الطريقة لتفعيل التصدير أو إيقافه في وقت التشغيل.
onBackgroundMessage(messaging, nextOrObserver) يتم الاتصال عند تلقّي رسالة أثناء تشغيل التطبيق في الخلفية. يُعتبر التطبيق تطبيقًا يعمل في الخلفية إذا لم يتم عرض أي نافذة نشطة.
دالّة()
issupported() للتحقّق مما إذا كانت جميع واجهات برمجة التطبيقات المطلوبة متوفّرة ضمن سياق SW

واجهات

الواجهة الوصف
FcmOptions خيارات الميزات التي توفّرها "حزمة تطوير البرامج (SDK) لخدمة "المراسلة عبر السحابة الإلكترونية من Firebase" للويب. راجِع WebpushFcmOptions.
GetTokenOptions خيارات getToken().
MessagePayload حمولة الرسائل التي تحتوي على حمولة الإشعارات التي يتم تمثيلها في NotificationPayload وحمولة البيانات التي تحتوي على عدد عشوائي من أزواج المفتاح/القيمة التي أرسلها المطوّرون من خلال Send API
المراسلة الواجهة العامة لحزمة تطوير البرامج (SDK) لخدمة "المراسلة عبر السحابة الإلكترونية من Firebase".
NotificationPayload عرض تفاصيل الإشعار يتم إرسال التفاصيل من خلال Send API.

function(app, ...)

getMessaging(app)

يسترد مثيل "المراسلة عبر السحابة الإلكترونية من Firebase".

Signature:

export declare function getMessagingInSw(app?: FirebaseApp): Messaging;

المَعلمات

المعلمة النوع الوصف
التطبيق تطبيق Firebase

المرتجعات:

المراسلة

مثيل "المراسلة عبر السحابة الإلكترونية من Firebase" المرتبط بتطبيق firebase المقدَّم.

الدالة(الرسائل، ...)

testSetDeliveryMetricsExportedToBigQueryEnabled(mesaging, enable)

تفعيل أو إيقاف تصدير مقاييس تسليم رسائل خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" إلى BigQuery لا يتم تصدير مقاييس تسليم الرسائل إلى BigQuery تلقائيًا. يمكنك استخدام هذه الطريقة لتفعيل التصدير أو إيقافه في وقت التشغيل.

Signature:

export declare function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;

المَعلمات

المعلمة النوع الوصف
المراسلة المراسلة المثيل FirebaseMessaging
تفعيل قيمة منطقية ما إذا كان يجب على خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" تصدير مقاييس تسليم الرسائل إلى BigQuery

المرتجعات:

فراغ

onBackgroundMessage(messaging, nextOrObserver)

يتم الاتصال عند تلقّي رسالة أثناء تشغيل التطبيق في الخلفية. يُعتبر التطبيق تطبيقًا يعمل في الخلفية إذا لم يتم عرض أي نافذة نشطة.

Signature:

export declare function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

المَعلمات

المعلمة النوع الوصف
المراسلة المراسلة مثيل المراسلة.
NextOrObserver NextFn<MessagePayload> | المراقب<MessagePayload> يتم استدعاء هذه الدالة أو كائن المراقب مع تحديد next عند استلام رسالة ويكون التطبيق في الخلفية حاليًا.

المرتجعات:

إلغاء الاشتراك

لإيقاف الاستماع إلى الرسائل، نفِّذ هذه الدالة التي تم إرجاعها.

الدالة()

issupported()

للتحقّق مما إذا كانت جميع واجهات برمجة التطبيقات المطلوبة متوفّرة ضمن سياق SW

Signature:

export declare function isSwSupported(): Promise<boolean>;

المرتجعات:

Promise&lt;boolean&gt;

وعد يتحول إلى قيمة منطقية.