firebase-admin.messaging package

Firebase Cloud Messaging (FCM).

کارکرد

تابع شرح
دریافت پیام (برنامه) سرویس پیام‌رسانی را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند. admin.messaging() می توان بدون هیچ آرگومان برای دسترسی به سرویس Messaging برنامه پیش فرض یا به عنوان admin.messaging(app) برای دسترسی به سرویس Messaging مرتبط با برنامه خاص فراخوانی کرد.

کلاس ها

کلاس شرح
پیام رسانی سرویس پیام رسانی متصل به برنامه ارائه شده.

رابط ها

رابط شرح
AndroidConfig نمایانگر گزینه‌های مخصوص Android است که می‌توانند در پیام گنجانده شوند .
AndroidFcmOptions گزینه هایی را برای ویژگی های ارائه شده توسط FCM SDK برای Android نشان می دهد.
Android Notification نشان دهنده گزینه های اعلان مخصوص Android است که می توانند در AndroidConfig گنجانده شوند .
ApnsConfig نشان دهنده گزینه های خاص APN است که می تواند در یک پیام گنجانده شود . برای هدرها و فیلدهای باری مختلف که توسط APN ها پشتیبانی می شوند، به اسناد اپل مراجعه کنید.
ApnsFcmOptions گزینه هایی را برای ویژگی های ارائه شده توسط FCM SDK برای iOS نشان می دهد.
ApnsPayload نشان دهنده بار یک پیام APN است. عمدتاً از فرهنگ لغت aps تشکیل شده است. اما ممکن است حاوی کلیدهای سفارشی دلخواه دیگری نیز باشد.
Aps فرهنگ لغت aps را که بخشی از پیام‌های APN است، نشان می‌دهد.
ApsAlert
BaseMessage
BatchResponse رابطی که پاسخ سرور را از متدهای Messaging.sendAll() و Messaging.sendMulticast() نشان می دهد.
پیام شرط
صدای انتقادی یک پیکربندی صدای بحرانی را نشان می دهد که می تواند در فرهنگ لغت aps یک بار APN گنجانده شود.
DataMessagePayload رابطی که یک بار پیام داده API قدیمی FCM را نشان می دهد. پیام‌های داده به توسعه‌دهندگان این امکان را می‌دهند تا حداکثر 4 کیلوبایت جفت کلید-مقدار سفارشی ارسال کنند. کلیدها و مقادیر باید هر دو رشته باشند. کلیدها می توانند هر رشته سفارشی باشند، به جز رشته های رزرو شده زیر:
  • from
  • هر چیزی که با google.
برای نمونه‌های کد و مستندات دقیق، به ساخت درخواست‌های ارسال مراجعه کنید.
FcmOptions گزینه‌های مستقل از پلتفرم را برای ویژگی‌های ارائه شده توسط FCM SDK نشان می‌دهد.
تنظیمات نور نشان دهنده تنظیمات کنترل LED اعلان است که می تواند در AndroidNotification گنجانده شود .
Messaging ConditionResponse رابطی که پاسخ سرور را از روش قدیمی Messaging.sendToCondition () نشان می دهد. برای نمونه کد و مستندات دقیق به ارسال به شرط مراجعه کنید.
MessagingDeviceGroupResponse رابطی که پاسخ سرور را از روش Messaging.sendToDeviceGroup() نشان می دهد. برای نمونه کد و مستندات دقیق، به ارسال پیام به گروه های دستگاه مراجعه کنید.
MessagingDevice Result بار پاسخ وضعیت فردی از دستگاه های منفرد
MessagingDevices Response رابطی که نشان دهنده وضعیت پیامی است که از طریق APIهای قدیمی FCM به یک دستگاه ارسال می شود. برای نمونه کد و مستندات دقیق، به ارسال به دستگاه های جداگانه مراجعه کنید.
گزینه های پیام رسانی رابطی که نشان دهنده گزینه هایی است که هنگام ارسال پیام از طریق APIهای قدیمی FCM ارائه می شود. برای نمونه‌های کد و مستندات دقیق، به ساخت درخواست‌های ارسال مراجعه کنید.
MessagingPayload رابطی که یک بار پیام‌رسانی ابری Firebase را نشان می‌دهد. یک یا هر دو کلید data و notification مورد نیاز است. برای نمونه‌های کد و مستندات دقیق، به ساخت درخواست‌های ارسال مراجعه کنید.
پیام‌رسانی موضوع مدیریت پاسخ رابطی که پاسخ سرور را از متدهای Messaging.subscribeToTopic() و Messaging.unsubscribeFromTopic() نشان می دهد. برای نمونه کد و مستندات دقیق به مدیریت موضوعات از سرور مراجعه کنید.
MessagingTopicResponse رابطی که پاسخ سرور را از روش قدیمی Messaging.sendToTopic () نشان می دهد. برای نمونه کد و مستندات دقیق به ارسال به موضوع مراجعه کنید.
MulticastMessage Payload برای متد Messaging.sendMulticast() . محموله شامل تمام فیلدهای نوع BaseMessage و لیستی از نشانه ها است.
اطلاع اعلانی که می تواند در پیام گنجانده شود .
NotificationMessagePayload واسط نشان دهنده بار پیام اعلان API قدیمی FCM. پیام‌های اعلان به توسعه‌دهندگان اجازه می‌دهد تا 4 کیلوبایت جفت کلید-مقدار از پیش تعریف‌شده را ارسال کنند. کلیدهای پذیرفته شده در زیر مشخص شده است. برای نمونه‌های کد و مستندات دقیق، به ساخت درخواست‌های ارسال مراجعه کنید.
SendResponse رابط نشان دهنده وضعیت یک پیام فردی که به عنوان بخشی از یک درخواست دسته ای ارسال شده است.
پیام توکن
موضوع پیام
WebpushConfig نشان دهنده گزینه های پروتکل WebPush است که می تواند در یک پیام گنجانده شود .
WebpushFcmOptions گزینه هایی را برای ویژگی های ارائه شده توسط FCM SDK برای وب (که بخشی از استاندارد Webpush نیستند) نشان می دهد.
WebpushNotification نشان دهنده گزینه های اعلان خاص WebPush است که می تواند در WebpushConfig گنجانده شود . این از اکثر گزینه های استاندارد همانطور که در مشخصات Web Notification تعریف شده است پشتیبانی می کند .

نام مستعار را تایپ کنید

نام مستعار را تایپ کنید شرح
پیام Payload برای عملیات Messaging.send() محموله شامل تمام فیلدهای نوع BaseMessage و دقیقاً یکی از فیلدها، موضوع یا شرط است.

getMessaging()

سرویس پیام‌رسانی را برای برنامه پیش‌فرض یا یک برنامه خاص دریافت می‌کند.

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);

پیام

Payload برای عملیات Messaging.send() محموله شامل تمام فیلدهای نوع BaseMessage و دقیقاً یکی از فیلدها، موضوع یا شرط است.

امضا:

export type Message = TokenMessage | TopicMessage | ConditionMessage;