@firebase/messaging/sw

المهام

وظيفة وصف
وظيفة (التطبيق، ...)
الحصول على الرسائل (التطبيق) يسترد مثيل Firebase Cloud Messaging.
وظيفة (الرسائل، ...)
التجريبيةSetDeliveryMetricsExportedToBigQueryEnabled (المراسلة، تمكين) تمكين أو تعطيل تصدير مقاييس تسليم رسائل Firebase Cloud Messaging إلى BigQuery. افتراضيًا، لا يتم تصدير مقاييس تسليم الرسائل إلى BigQuery. استخدم هذه الطريقة لتمكين أو تعطيل التصدير في وقت التشغيل.
onBackgroundMessage (المراسلة، nextOrObserver) يتم الاتصال به عند تلقي رسالة أثناء وجود التطبيق في الخلفية. يعتبر التطبيق موجودًا في الخلفية إذا لم يتم عرض نافذة نشطة.
وظيفة()
مدعوم() يتحقق مما إذا كانت جميع واجهات برمجة التطبيقات المطلوبة موجودة ضمن سياق SW

واجهات

واجهه المستخدم وصف
خيارات fcm خيارات الميزات التي توفرها FCM SDK للويب. راجع WebpushFcmOptions .
GetTokenOptions خيارات getToken() .
رسالةPayload حمولة الرسالة التي تحتوي على حمولة الإشعارات التي يتم تمثيلها مع NotificationPayload وحمولة البيانات التي تحتوي على عدد عشوائي من أزواج القيمة الرئيسية المرسلة من قبل المطورين من خلال Send API .
المراسلة الواجهة العامة لـ Firebase Cloud Messaging SDK.
NotificationPayload عرض تفاصيل الإخطار. يتم إرسال التفاصيل من خلال Send API .

وظيفة (التطبيق، ...)

الحصول على الرسائل (التطبيق)

يسترد مثيل Firebase Cloud Messaging.

إمضاء:

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

حدود

معامل يكتب وصف
برنامج FirebaseApp

عائدات:

المراسلة

مثيل Firebase Cloud Messaging المرتبط بتطبيق firebase المقدم.

وظيفة (الرسائل، ...)

التجريبيةSetDeliveryMetricsExportedToBigQueryEnabled (المراسلة، تمكين)

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

إمضاء:

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

حدود

معامل يكتب وصف
المراسلة المراسلة مثيل FirebaseMessaging .
يُمكَِن منطقية ما إذا كان يجب على Firebase Cloud Messaging تصدير مقاييس تسليم الرسائل إلى BigQuery.

عائدات:

فارغ

onBackgroundMessage (المراسلة، nextOrObserver)

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

إمضاء:

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

حدود

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

عائدات:

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

لإيقاف الاستماع للرسائل، قم بتنفيذ هذه الوظيفة التي تم إرجاعها

وظيفة()

مدعوم()

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

إمضاء:

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

عائدات:

وعد <منطقي>

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