کارکرد
| تابع | شرح |
|---|---|
| عملکرد (برنامه، ...) | |
| دریافت پیام (برنامه) | نمونه ای از Firebase Cloud Messaging را بازیابی می کند. |
| عملکرد (پیام، ...) | |
| حذف توکن (پیام) | رمز ثبت نام مرتبط با این نمونه پیام‌رسانی را حذف می‌کند و اشتراک نمونه پیام‌رسانی را از اشتراک push لغو می‌کند. |
| getToken (پیام، گزینه‌ها) | برای ارسال اعلان‌ها مشترک پیام‌رسانی می‌شود. یک نشانه ثبت نام Firebase Cloud Messaging را برمی‌گرداند که می‌تواند برای ارسال پیام‌های فشار به آن نمونه پیام‌رسانی استفاده شود. اگر مجوز اعلان قبلاً داده نشده باشد، این روش از کاربر اجازه می خواهد. اگر کاربر به برنامه اجازه نمایش اعلان‌ها را ندهد، قول برگشتی رد می‌شود. |
| onMessage (پیام، nextOrObserver) | هنگامی که یک پیام فشار دریافت می شود و کاربر در حال حاضر در صفحه ای برای مبدا شما است، پیام به صفحه ارسال می شود و یک رویداد onMessage() همراه با بار پیام فشار ارسال می شود. |
| تابع() | |
| isSupported() | بررسی می کند که آیا همه API های مورد نیاز در مرورگر وجود دارند یا خیر. |
رابط ها
| رابط | شرح |
|---|---|
| FcmOptions | گزینه هایی برای ویژگی های ارائه شده توسط FCM SDK برای وب. WebpushFcmOptions را ببینید . |
| GetTokenOptions | گزینه هایی برای getToken() . |
| MessagePayload | محموله پیام حاوی بار اعلان که با NotificationPayload نشان داده شده است و محموله داده که حاوی تعداد دلخواه جفت کلید-مقدار است که توسط توسعه دهندگان از طریق Send API ارسال شده است. . |
| پیام رسانی | رابط عمومی Firebase Cloud Messaging SDK. |
| NotificationPayload | نمایش جزئیات اعلان جزئیات از طریق Send API ارسال می شود . |
عملکرد (برنامه، ...)
دریافت پیام (برنامه)
نمونه ای از Firebase Cloud Messaging را بازیابی می کند.
امضا:
export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| برنامه | Firebase App |
برمی گرداند:
نمونه Firebase Cloud Messaging مرتبط با برنامه firebase ارائه شده.
عملکرد (پیام، ...)
حذف توکن (پیام)
رمز ثبت نام مرتبط با این نمونه پیام‌رسانی را حذف می‌کند و اشتراک نمونه پیام‌رسانی را از اشتراک push لغو می‌کند.
امضا:
export declare function deleteToken(messaging: Messaging): Promise<boolean>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| پیام رسانی | پیام رسانی | نمونه پیام . |
برمی گرداند:
وعده<boolean>
زمانی که توکن با موفقیت حذف شد، وعده حل می شود.
getToken (پیام، گزینه‌ها)
برای ارسال اعلان‌ها مشترک پیام‌رسانی می‌شود. یک نشانه ثبت نام Firebase Cloud Messaging را برمی‌گرداند که می‌تواند برای ارسال پیام‌های فشار به آن نمونه پیام‌رسانی استفاده شود.
اگر مجوز اعلان قبلاً داده نشده باشد، این روش از کاربر اجازه می خواهد. اگر کاربر به برنامه اجازه نمایش اعلان‌ها را ندهد، قول برگشتی رد می‌شود.
امضا:
export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| پیام رسانی | پیام رسانی | نمونه پیام . |
| گزینه ها | GetTokenOptions | یک کلید خالی اختیاری و یک ثبت نام کارگر اختیاری ارائه می دهد. |
برمی گرداند:
قول<رشته>
این قول با یک توکن ثبت FCM حل می شود.
onMessage (پیام، nextOrObserver)
هنگامی که یک پیام فشار دریافت می شود و کاربر در حال حاضر در صفحه ای برای مبدا شما است، پیام به صفحه ارسال می شود و یک رویداد onMessage() همراه با بار پیام فشار ارسال می شود.
امضا:
export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| پیام رسانی | پیام رسانی | نمونه پیام . |
| nextOrObserver | NextFn < MessagePayload > | مشاهده کننده < MessagePayload > | این تابع یا شی ناظر با تعریف next زمانی فراخوانی می شود که پیامی دریافت شود و کاربر در حال مشاهده صفحه شما باشد. |
برمی گرداند:
برای متوقف کردن گوش دادن به پیام ها، این تابع برگشتی را اجرا کنید.
تابع()
isSupported()
بررسی می کند که آیا همه API های مورد نیاز در مرورگر وجود دارند یا خیر.
امضا:
export declare function isWindowSupported(): Promise<boolean>;
برمی گرداند:
وعده<boolean>
قولی که به یک بولی حل می شود.