@firebase/messaging/sw

کارکرد

تابع شرح
عملکرد (برنامه، ...)
دریافت پیام (برنامه) نمونه ای از Firebase Cloud Messaging را بازیابی می کند.
عملکرد (پیام، ...)
ExperimentalSetDeliveryMetricsExportedToBigQueryEnabled(پیام رسانی، فعال کردن) صادرات سنجه‌های تحویل پیام Firebase Cloud Messaging به BigQuery را فعال یا غیرفعال می‌کند. به‌طور پیش‌فرض، معیارهای تحویل پیام به BigQuery صادر نمی‌شوند. از این روش برای فعال یا غیرفعال کردن صادرات در زمان اجرا استفاده کنید.
onBackgroundMessage (پیام، nextOrObserver) زمانی که برنامه در پس‌زمینه است، پیامی دریافت می‌شود. اگر پنجره فعالی نمایش داده نشود، یک برنامه در پس زمینه در نظر گرفته می شود.
تابع()
isSupported() بررسی می کند که آیا همه API های مورد نیاز در SW Context وجود دارند یا خیر

رابط ها

رابط شرح
FcmOptions گزینه هایی برای ویژگی های ارائه شده توسط FCM SDK برای وب. WebpushFcmOptions را ببینید .
GetTokenOptions گزینه هایی برای getToken() .
MessagePayload محموله پیام حاوی بار اعلان که با NotificationPayload نشان داده شده است و محموله داده که حاوی تعداد دلخواه جفت کلید-مقدار است که توسط توسعه دهندگان از طریق Send API ارسال شده است. .
پیام رسانی رابط عمومی Firebase Cloud Messaging SDK.
NotificationPayload نمایش جزئیات اعلان جزئیات از طریق Send API ارسال می شود .

عملکرد (برنامه، ...)

دریافت پیام (برنامه)

نمونه ای از Firebase Cloud Messaging را بازیابی می کند.

امضا:

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

مولفه های

پارامتر تایپ کنید شرح
برنامه Firebase App

برمی گرداند:

پیام رسانی

نمونه Firebase Cloud Messaging مرتبط با برنامه firebase ارائه شده.

عملکرد (پیام، ...)

ExperimentalSetDeliveryMetricsExportedToBigQueryEnabled(پیام رسانی، فعال کردن)

صادرات سنجه‌های تحویل پیام 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 NextFn < MessagePayload > | مشاهده کننده < MessagePayload > این تابع یا شی ناظر با تعریف next ، زمانی فراخوانی می شود که پیامی دریافت شود و برنامه در حال حاضر در پس زمینه باشد.

برمی گرداند:

لغو اشتراک

برای متوقف کردن گوش دادن به پیام ها، این تابع برگشتی را اجرا کنید

تابع()

isSupported()

بررسی می کند که آیا همه API های مورد نیاز در SW Context وجود دارند یا خیر

امضا:

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

برمی گرداند:

وعده<boolean>

قولی که به یک بولی حل می شود.