سرویس پیام رسانی متصل به برنامه ارائه شده.
امضا:
export declare class Messaging
خواص
| ویژگی | اصلاح کننده ها | تایپ کنید | شرح |
|---|---|---|---|
| برنامه | برنامه | برنامه مرتبط با نمونه سرویس Messaging فعلی. |
مواد و روش ها
| روش | اصلاح کننده ها | شرح |
|---|---|---|
| ارسال (پیام، اجرا خشک) | پیام داده شده را از طریق FCM ارسال می کند. | |
| sendAll (پیام ها، dryRun) | تمام پیام های موجود در آرایه داده شده را از طریق Firebase Cloud Messaging ارسال می کند. از دسته بندی برای ارسال کل لیست به عنوان یک تماس RPC استفاده می کند. در مقایسه با روش send() ، این روش روش بسیار کارآمدتری برای ارسال چند پیام است. لیست پاسخ های بدست آمده از مقدار بازگشتی با ترتیب توکن ها در MulticastMessage مطابقت دارد. خطای این روش نشان دهنده یک شکست کامل است، به این معنی که هیچ یک از پیام های لیست ارسال نمی شود. خرابی های جزئی با یک مقدار بازگشتی BatchResponse نشان داده می شوند. | |
| sendEach (پیام ها، dryRun) | هر پیام را در آرایه داده شده از طریق Firebase Cloud Messaging ارسال می کند. برخلاف Messaging.sendAll() ، این روش یک تماس RPC برای هر پیام در آرایه داده شده ایجاد می کند. لیست پاسخ های به دست آمده از مقدار بازگشتی با ترتیب messages مطابقت دارد. یک خطا از این روش یا یک BatchResponse با همه خرابی ها نشان دهنده یک شکست کامل است، به این معنی که هیچ یک از پیام های لیست ارسال نمی شود. خرابی جزئی یا عدم وجود خرابی فقط با یک مقدار بازگشتی BatchResponse نشان داده می شود. | |
| sendEachForMulticast (پیام، اجرا خشک) | پیام چندپخشی داده شده را به تمام نشانه های ثبت FCM مشخص شده در آن ارسال می کند. این روش از Messaging.sendEach() API در زیر هود استفاده می کند تا پیام داده شده را به تمام گیرندگان هدف ارسال کند. لیست پاسخ های بدست آمده از مقدار بازگشتی با ترتیب توکن ها در MulticastMessage مطابقت دارد. یک خطا از این روش یا یک BatchResponse با همه خرابی ها نشان دهنده یک شکست کامل است، به این معنی که پیام های موجود در لیست می توانند ارسال شوند. خرابی یا شکست جزئی فقط با یک مقدار بازگشتی BatchResponse نشان داده می شود. | |
| sendMulticast (پیام، اجرا خشک) | پیام چندپخشی داده شده را به تمام نشانه های ثبت FCM مشخص شده در آن ارسال می کند. این روش از sendAll() API در زیر هود استفاده می کند تا پیام داده شده را به تمام گیرندگان هدف ارسال کند. لیست پاسخ های بدست آمده از مقدار بازگشتی با ترتیب توکن ها در MulticastMessage مطابقت دارد. خطای این روش نشان دهنده شکست کامل است، به این معنی که پیام به هیچ یک از نشانه های لیست ارسال نشده است. خرابی های جزئی با یک مقدار بازگشتی BatchResponse نشان داده می شوند. | |
| sendToCondition (شرایط، محموله، گزینه‌ها) | یک پیام FCM به یک شرط ارسال می کند. برای نمونه کد و مستندات دقیق به ارسال به شرط مراجعه کنید. | |
| sendToDevice (registrationTokenOrTokens، payload، گزینه‌ها) | یک پیام FCM را به یک دستگاه منفرد مربوط به رمز ثبت نام ارائه شده ارسال می کند. برای نمونه کد و مستندات دقیق، به ارسال به دستگاه های جداگانه مراجعه کنید. یا یک registrationToken برای ارسال به یک دستگاه واحد یا یک پارامتر registrationTokens حاوی آرایه ای از نشانه ها برای ارسال به چندین دستگاه می گیرد. | |
| sendToDeviceGroup (کلید اطلاع رسانی، بارگذاری، گزینه ها) | یک پیام FCM را به گروه دستگاه مربوط به کلید اعلان ارائه شده ارسال می کند. برای نمونه کد و مستندات دقیق به ارسال به گروه دستگاه مراجعه کنید. | |
| sendToTopic (موضوع، محموله، گزینه‌ها) | یک پیام FCM به یک موضوع ارسال می کند. برای نمونه کد و مستندات دقیق به ارسال به موضوع مراجعه کنید. | |
| subscribeToTopic (registrationTokenOrTokens، موضوع) | یک دستگاه را در یک موضوع FCM مشترک می کند. برای نمونه کد و مستندات دقیق ، اشتراک در یک موضوع را ببینید. به صورت اختیاری، می‌توانید آرایه‌ای از نشانه‌ها را برای اشتراک چندین دستگاه ارائه کنید. | |
| لغو اشتراک از مبحث (registrationTokenOrTokens، موضوع) | اشتراک دستگاه را از موضوع FCM لغو می کند. برای نمونه کد و مستندات دقیق ، لغو اشتراک از یک موضوع را ببینید. به صورت اختیاری، می‌توانید مجموعه‌ای از نشانه‌ها را برای لغو اشتراک چندین دستگاه ارائه کنید. |
Messaging.app
برنامه مرتبط با نمونه سرویس Messaging فعلی.
امضا:
get app(): App;
مثال
var app = messaging.app;
Messaging.send()
پیام داده شده را از طریق FCM ارسال می کند.
امضا:
send(message: Message, dryRun?: boolean): Promise<string>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| پیام | پیام | محموله پیام |
| dryRun | بولی | ارسال پیام در حالت خشک (فقط اعتبارسنجی). |
برمی گرداند:
قول<رشته>
وعده ای که با یک رشته شناسه پیام منحصر به فرد پس از تحویل موفقیت آمیز پیام به سرویس FCM برای تحویل انجام شد.
Messaging.sendAll()
به جای آن از Messaging.sendEach() استفاده کنید.
تمام پیام های موجود در آرایه داده شده را از طریق Firebase Cloud Messaging ارسال می کند. از دسته بندی برای ارسال کل لیست به عنوان یک تماس RPC استفاده می کند. در مقایسه با روش send() ، این روش روش بسیار کارآمدتری برای ارسال چند پیام است.
لیست پاسخ های به دست آمده از مقدار بازگشتی با ترتیب توکن ها در MulticastMessage مطابقت دارد . خطای این روش نشان دهنده یک شکست کامل است، به این معنی که هیچ یک از پیام های لیست ارسال نمی شود. خرابی های جزئی با یک مقدار بازگشتی BatchResponse نشان داده می شوند.
امضا:
sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| پیام ها | پیام [] | یک آرایه غیر خالی که حداکثر 500 پیام دارد. |
| dryRun | بولی | ارسال پیام ها در حالت خشک (فقط اعتبارسنجی). |
برمی گرداند:
Promise< BatchResponse >
وعده ای که با یک شی که نتیجه عملیات ارسال را نشان می دهد محقق می شود.
Messaging.sendEach()
هر پیام را در آرایه داده شده از طریق Firebase Cloud Messaging ارسال می کند.
برخلاف Messaging.sendAll() ، این روش یک تماس RPC برای هر پیام در آرایه داده شده ایجاد می کند.
لیست پاسخ های به دست آمده از مقدار بازگشتی با ترتیب messages مطابقت دارد . یک خطا از این روش یا یک BatchResponse با همه خرابی ها نشان دهنده یک شکست کامل است، به این معنی که هیچ یک از پیام های لیست ارسال نمی شود. خرابی جزئی یا عدم وجود خرابی فقط با یک مقدار بازگشتی BatchResponse نشان داده می شود.
امضا:
sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| پیام ها | پیام [] | یک آرایه غیر خالی که حداکثر 500 پیام دارد. |
| dryRun | بولی | ارسال پیام ها در حالت خشک (فقط اعتبارسنجی). |
برمی گرداند:
Promise< BatchResponse >
وعده ای که با یک شی که نتیجه عملیات ارسال را نشان می دهد محقق می شود.
Messaging.sendEachForMulticast()
پیام چندپخشی داده شده را به تمام نشانه های ثبت FCM مشخص شده در آن ارسال می کند.
این روش از Messaging.sendEach() API در زیر هود استفاده می کند تا پیام داده شده را به تمام گیرندگان هدف ارسال کند. لیست پاسخ های به دست آمده از مقدار بازگشتی با ترتیب توکن ها در MulticastMessage مطابقت دارد . یک خطا از این روش یا یک BatchResponse با همه خرابی ها نشان دهنده یک شکست کامل است، به این معنی که پیام های موجود در لیست می توانند ارسال شوند. خرابی یا شکست جزئی فقط با یک مقدار بازگشتی BatchResponse نشان داده می شود.
امضا:
sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| پیام | MulticastMessage | یک پیام چندپخشی حاوی حداکثر 500 توکن. |
| dryRun | بولی | ارسال پیام در حالت خشک (فقط اعتبارسنجی). |
برمی گرداند:
Promise< BatchResponse >
وعده ای که با یک شی که نتیجه عملیات ارسال را نشان می دهد محقق می شود.
Messaging.sendMulticast()
به جای آن از Messaging.sendEachForMulticast() استفاده کنید.
پیام چندپخشی داده شده را به تمام نشانه های ثبت FCM مشخص شده در آن ارسال می کند.
این روش از sendAll() API در زیر هود استفاده می کند تا پیام داده شده را به تمام گیرندگان هدف ارسال کند. لیست پاسخ های به دست آمده از مقدار بازگشتی با ترتیب توکن ها در MulticastMessage مطابقت دارد . خطای این روش نشان دهنده شکست کامل است، به این معنی که پیام به هیچ یک از نشانه های لیست ارسال نشده است. خرابی های جزئی با یک مقدار بازگشتی BatchResponse نشان داده می شوند.
امضا:
sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| پیام | MulticastMessage | یک پیام چندپخشی حاوی حداکثر 500 توکن. |
| dryRun | بولی | ارسال پیام در حالت خشک (فقط اعتبارسنجی). |
برمی گرداند:
Promise< BatchResponse >
وعده ای که با یک شی که نتیجه عملیات ارسال را نشان می دهد محقق می شود.
Messaging.sendToCondition()
یک پیام FCM به یک شرط ارسال می کند.
برای نمونه کد و مستندات دقیق به ارسال به شرط مراجعه کنید.
امضا:
sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| وضعیت | رشته | شرطی که تعیین می کند به کدام موضوعات پیام ارسال شود. |
| ظرفیت ترابری | MessagingPayload | محموله پیام |
| گزینه ها | گزینه های پیام رسانی | گزینه های اختیاری برای تغییر پیام |
برمی گرداند:
Promise< MessagingConditionResponse >
قولی که با پاسخ سرور پس از ارسال پیام محقق شد.
Messaging.sendToDevice()
به جای آن از Messaging.send() استفاده کنید.
یک پیام FCM را به یک دستگاه منفرد مربوط به رمز ثبت نام ارائه شده ارسال می کند.
برای نمونه کد و مستندات دقیق، به ارسال به دستگاه های جداگانه مراجعه کنید. یا یک registrationToken برای ارسال به یک دستگاه واحد یا یک پارامتر registrationTokens حاوی آرایه ای از نشانه ها برای ارسال به چندین دستگاه می گیرد.
امضا:
sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| registerTokenOrTokens | رشته | رشته[] | |
| ظرفیت ترابری | MessagingPayload | محموله پیام |
| گزینه ها | گزینه های پیام رسانی | گزینه های اختیاری برای تغییر پیام |
برمی گرداند:
Promise< MessagingDevicesResponse >
قولی که با پاسخ سرور پس از ارسال پیام محقق شد.
Messaging.sendToDeviceGroup()
به جای آن از Messaging.send() استفاده کنید.
یک پیام FCM را به گروه دستگاه مربوط به کلید اعلان ارائه شده ارسال می کند.
برای نمونه کد و مستندات دقیق به ارسال به گروه دستگاه مراجعه کنید.
امضا:
sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| notificationKey | رشته | کلید اعلان برای گروه دستگاهی که پیام به آن ارسال می شود. |
| ظرفیت ترابری | MessagingPayload | محموله پیام |
| گزینه ها | گزینه های پیام رسانی | گزینه های اختیاری برای تغییر پیام |
برمی گرداند:
Promise< MessagingDeviceGroupResponse >
قولی که با پاسخ سرور پس از ارسال پیام محقق شد.
Messaging.sendToTopic()
یک پیام FCM به یک موضوع ارسال می کند.
برای نمونه کد و مستندات دقیق به ارسال به موضوع مراجعه کنید.
امضا:
sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| موضوع | رشته | موضوعی که برای آن پیام ارسال شود. |
| ظرفیت ترابری | MessagingPayload | محموله پیام |
| گزینه ها | گزینه های پیام رسانی | گزینه های اختیاری برای تغییر پیام |
برمی گرداند:
Promise< MessagingTopicResponse >
قولی که با پاسخ سرور پس از ارسال پیام محقق شد.
Messaging.subscribeToTopic()
یک دستگاه را در یک موضوع FCM مشترک می کند.
برای نمونه کد و مستندات دقیق ، اشتراک در یک موضوع را ببینید. به صورت اختیاری، می‌توانید آرایه‌ای از نشانه‌ها را برای اشتراک چندین دستگاه ارائه کنید.
امضا:
subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| registerTokenOrTokens | رشته | رشته[] | |
| موضوع | رشته | موضوعی که در آن مشترک شوید. |
برمی گرداند:
Promise< MessagingTopicManagementResponse >
وعده ای که با پاسخ سرور پس از اشتراک دستگاه در موضوع انجام شد.
Messaging.unsubscribeFromTopic()
اشتراک دستگاه را از موضوع FCM لغو می کند.
برای نمونه کد و مستندات دقیق ، لغو اشتراک از یک موضوع را ببینید. به صورت اختیاری، می‌توانید مجموعه‌ای از نشانه‌ها را برای لغو اشتراک چندین دستگاه ارائه کنید.
امضا:
unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| registerTokenOrTokens | رشته | رشته[] | |
| موضوع | رشته | موضوعی که می توان از آن لغو اشتراک کرد. |
برمی گرداند:
Promise< MessagingTopicManagementResponse >
قولی که با پاسخ سرور پس از لغو اشتراک دستگاه از موضوع انجام شد.