Messaging class

خدمة المراسلة مرتبطة بالتطبيق المقدم.

إمضاء:

export declare class Messaging 

ملكيات

ملكية الصفات التعريفية يكتب وصف
برنامج برنامج التطبيق المرتبط بمثيل خدمة Messaging الحالي.

طُرق

طريقة الصفات التعريفية وصف
إرسال (رسالة، تشغيل جاف) يرسل الرسالة المحددة عبر FCM.
إرسال الكل (الرسائل، التشغيل الجاف) يرسل جميع الرسائل الموجودة في المصفوفة المحددة عبر Firebase Cloud Messaging. يستخدم التجميع لإرسال القائمة بأكملها كمكالمة RPC واحدة. بالمقارنة مع طريقة send() ، تعد هذه الطريقة طريقة أكثر فعالية لإرسال رسائل متعددة. تتوافق قائمة الاستجابات التي تم الحصول عليها من القيمة المرجعة مع ترتيب الرموز المميزة في MulticastMessage . يشير الخطأ من هذه الطريقة إلى فشل كامل، مما يعني عدم إمكانية إرسال أي من الرسائل الموجودة في القائمة. تتم الإشارة إلى حالات الفشل الجزئي بواسطة قيمة الإرجاع BatchResponse .
إرسال كل (رسائل، تشغيل جاف) يرسل كل رسالة في المصفوفة المحددة عبر Firebase Cloud Messaging. على عكس Messaging.sendAll() ، تقوم هذه الطريقة بإجراء استدعاء RPC واحد لكل رسالة في المصفوفة المحددة. قائمة الاستجابات التي تم الحصول عليها من قيمة الإرجاع تتوافق مع ترتيب messages . يشير خطأ من هذه الطريقة أو BatchResponse مع كافة حالات الفشل إلى فشل كامل، مما يعني عدم إمكانية إرسال أي من الرسائل الموجودة في القائمة. تتم الإشارة إلى حالات الفشل الجزئي أو عدم وجود حالات فشل فقط من خلال قيمة الإرجاع BatchResponse .
sendEachForMulticast(message, DryRun) يرسل رسالة البث المتعدد المحددة إلى كافة رموز تسجيل FCM المحددة فيها. تستخدم هذه الطريقة واجهة برمجة تطبيقات Messaging.sendEach() أسفل الغطاء لإرسال الرسالة المحددة إلى جميع المستلمين المستهدفين. تتوافق قائمة الاستجابات التي تم الحصول عليها من القيمة المرجعة مع ترتيب الرموز المميزة في MulticastMessage . يشير خطأ من هذه الطريقة أو BatchResponse مع كافة حالات الفشل إلى فشل كامل، مما يعني إمكانية إرسال الرسائل الموجودة في القائمة. تتم الإشارة إلى حالات الفشل أو الفشل الجزئي فقط من خلال قيمة الإرجاع BatchResponse .
إرسال متعدد (رسالة، تشغيل جاف) يرسل رسالة البث المتعدد المحددة إلى كافة رموز تسجيل FCM المحددة فيها. تستخدم هذه الطريقة واجهة برمجة تطبيقات sendAll() الموجودة أسفل الغطاء لإرسال الرسالة المحددة إلى جميع المستلمين المستهدفين. تتوافق قائمة الاستجابات التي تم الحصول عليها من القيمة المرجعة مع ترتيب الرموز المميزة في MulticastMessage . يشير الخطأ من هذه الطريقة إلى فشل كامل، مما يعني أنه لم يتم إرسال الرسالة إلى أي من الرموز المميزة الموجودة في القائمة. تتم الإشارة إلى حالات الفشل الجزئي بواسطة قيمة الإرجاع BatchResponse .
sendToCondition(الحالة، الحمولة، الخيارات) يرسل رسالة FCM إلى الشرط. راجع إرسال إلى شرط للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية.
sendToDevice (registrationTokenOrTokens، payload، options) يرسل رسالة FCM إلى جهاز واحد يتوافق مع رمز التسجيل المقدم. راجع الإرسال إلى الأجهزة الفردية للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. يأخذ إما registrationToken لإرساله إلى جهاز واحد أو معلمة registrationTokens التي تحتوي على مجموعة من الرموز المميزة لإرسالها إلى أجهزة متعددة.
sendToDeviceGroup (مفتاح الإشعارات، الحمولة، الخيارات) يرسل رسالة FCM إلى مجموعة الأجهزة المقابلة لمفتاح الإشعارات المقدم. راجع إرسال إلى مجموعة أجهزة للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية.
sendToTopic (الموضوع، الحمولة، الخيارات) يرسل رسالة FCM إلى موضوع ما. راجع إرسال إلى موضوع للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية.
الاشتراك في ToTopic (تسجيل TokenOrTokens، الموضوع) يشترك جهازًا في موضوع FCM. راجع الاشتراك في موضوع للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. اختياريًا، يمكنك توفير مجموعة من الرموز المميزة للاشتراك في أجهزة متعددة.
إلغاء الاشتراك من Topic (تسجيل TokenOrTokens، الموضوع) إلغاء اشتراك جهاز من موضوع FCM. راجع إلغاء الاشتراك في أحد المواضيع للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. اختياريًا، يمكنك توفير مجموعة من الرموز المميزة لإلغاء الاشتراك في أجهزة متعددة.

تطبيق المراسلة

التطبيق المرتبط بمثيل خدمة Messaging الحالي.

إمضاء:

get app(): App;

مثال

var app = messaging.app;

إرسال الرسائل ()

يرسل الرسالة المحددة عبر FCM.

إمضاء:

send(message: Message, dryRun?: boolean): Promise<string>;

حدود

معامل يكتب وصف
رسالة رسالة حمولة الرسالة.
ركض جاف منطقية ما إذا كان سيتم إرسال الرسالة في وضع التشغيل الجاف (التحقق من الصحة فقط).

عائدات:

وعد <سلسلة>

وعد يتم الوفاء به باستخدام سلسلة معرف رسالة فريدة بعد تسليم الرسالة بنجاح إلى خدمة FCM للتسليم.

المراسلة.sendAll()

استخدم Messaging.sendEach() بدلاً من ذلك.

يرسل جميع الرسائل الموجودة في المصفوفة المحددة عبر Firebase Cloud Messaging. يستخدم التجميع لإرسال القائمة بأكملها كمكالمة RPC واحدة. بالمقارنة مع طريقة send() ، تعد هذه الطريقة طريقة أكثر فعالية لإرسال رسائل متعددة.

تتوافق قائمة الاستجابات التي تم الحصول عليها من القيمة المرجعة مع ترتيب الرموز المميزة في MulticastMessage . يشير الخطأ من هذه الطريقة إلى فشل كامل، مما يعني عدم إمكانية إرسال أي من الرسائل الموجودة في القائمة. تتم الإشارة إلى حالات الفشل الجزئي بواسطة قيمة الإرجاع BatchResponse .

إمضاء:

sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

حدود

معامل يكتب وصف
رسائل رسالة [] مصفوفة غير فارغة تحتوي على ما يصل إلى 500 رسالة.
ركض جاف منطقية ما إذا كان سيتم إرسال الرسائل في وضع التشغيل الجاف (التحقق من الصحة فقط).

عائدات:

وعد < BatchResponse >

تم تنفيذ الوعد بكائن يمثل نتيجة عملية الإرسال.

المراسلة.sendEach ()

يرسل كل رسالة في المصفوفة المحددة عبر Firebase Cloud Messaging.

على عكس Messaging.sendAll() ، تقوم هذه الطريقة بإجراء استدعاء RPC واحد لكل رسالة في المصفوفة المحددة.

تتوافق قائمة الاستجابات التي تم الحصول عليها من القيمة المرجعة مع ترتيب messages . يشير خطأ من هذه الطريقة أو BatchResponse مع كافة حالات الفشل إلى فشل كامل، مما يعني عدم إمكانية إرسال أي من الرسائل الموجودة في القائمة. تتم الإشارة إلى حالات الفشل الجزئي أو عدم وجود حالات فشل فقط من خلال قيمة الإرجاع BatchResponse .

إمضاء:

sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

حدود

معامل يكتب وصف
رسائل رسالة [] مصفوفة غير فارغة تحتوي على ما يصل إلى 500 رسالة.
ركض جاف منطقية ما إذا كان سيتم إرسال الرسائل في وضع التشغيل الجاف (التحقق من الصحة فقط).

عائدات:

وعد < BatchResponse >

تم تنفيذ الوعد بكائن يمثل نتيجة عملية الإرسال.

Messaging.sendEachForMulticast()

يرسل رسالة البث المتعدد المحددة إلى كافة رموز تسجيل FCM المحددة فيها.

تستخدم هذه الطريقة واجهة برمجة تطبيقات Messaging.sendEach() أسفل الغطاء لإرسال الرسالة المحددة إلى جميع المستلمين المستهدفين. تتوافق قائمة الاستجابات التي تم الحصول عليها من القيمة المرجعة مع ترتيب الرموز المميزة في MulticastMessage . يشير خطأ من هذه الطريقة أو BatchResponse مع كافة حالات الفشل إلى فشل كامل، مما يعني إمكانية إرسال الرسائل الموجودة في القائمة. تتم الإشارة إلى حالات الفشل أو الفشل الجزئي فقط من خلال قيمة الإرجاع BatchResponse .

إمضاء:

sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

حدود

معامل يكتب وصف
رسالة رسالة البث المتعدد رسالة متعددة البث تحتوي على ما يصل إلى 500 رمزًا.
ركض جاف منطقية ما إذا كان سيتم إرسال الرسالة في وضع التشغيل الجاف (التحقق من الصحة فقط).

عائدات:

وعد < BatchResponse >

تم تنفيذ الوعد بكائن يمثل نتيجة عملية الإرسال.

المراسلة.sendMulticast()

استخدم Messaging.sendEachForMulticast() بدلاً من ذلك.

يرسل رسالة البث المتعدد المحددة إلى كافة رموز تسجيل FCM المحددة فيها.

تستخدم هذه الطريقة واجهة برمجة تطبيقات sendAll() الموجودة أسفل الغطاء لإرسال الرسالة المحددة إلى جميع المستلمين المستهدفين. تتوافق قائمة الاستجابات التي تم الحصول عليها من القيمة المرجعة مع ترتيب الرموز المميزة في MulticastMessage . يشير الخطأ من هذه الطريقة إلى فشل كامل، مما يعني أنه لم يتم إرسال الرسالة إلى أي من الرموز المميزة الموجودة في القائمة. تتم الإشارة إلى حالات الفشل الجزئي بواسطة قيمة الإرجاع BatchResponse .

إمضاء:

sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

حدود

معامل يكتب وصف
رسالة رسالة البث المتعدد رسالة متعددة البث تحتوي على ما يصل إلى 500 رمزًا.
ركض جاف منطقية ما إذا كان سيتم إرسال الرسالة في وضع التشغيل الجاف (التحقق من الصحة فقط).

عائدات:

وعد < BatchResponse >

تم تنفيذ الوعد بكائن يمثل نتيجة عملية الإرسال.

المراسلة.sendToCondition()

يرسل رسالة FCM إلى الشرط.

راجع إرسال إلى شرط للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية.

إمضاء:

sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;

حدود

معامل يكتب وصف
حالة خيط شرط تحديد المواضيع التي سيتم إرسال الرسالة إليها.
حمولة MessagingPayload حمولة الرسالة.
خيارات خيارات المراسلة خيارات اختيارية لتغيير الرسالة.

عائدات:

وعد< MessagingConditionResponse >

وعد يتم الوفاء به مع استجابة الخادم بعد إرسال الرسالة.

المراسلة.sendToDevice()

استخدم Messaging.send() بدلاً من ذلك.

يرسل رسالة FCM إلى جهاز واحد يتوافق مع رمز التسجيل المقدم.

راجع الإرسال إلى الأجهزة الفردية للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. يأخذ إما registrationToken لإرساله إلى جهاز واحد أو معلمة registrationTokens التي تحتوي على مجموعة من الرموز المميزة لإرسالها إلى أجهزة متعددة.

إمضاء:

sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;

حدود

معامل يكتب وصف
رمز التسجيل أو الرموز سلسلة | خيط[]
حمولة MessagingPayload حمولة الرسالة.
خيارات خيارات المراسلة خيارات اختيارية لتغيير الرسالة.

عائدات:

وعد< MessagingDevicesResponse >

وعد يتم الوفاء به مع استجابة الخادم بعد إرسال الرسالة.

المراسلة.sendToDeviceGroup()

استخدم Messaging.send() بدلاً من ذلك.

يرسل رسالة FCM إلى مجموعة الأجهزة المقابلة لمفتاح الإشعارات المقدم.

راجع إرسال إلى مجموعة أجهزة للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية.

إمضاء:

sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;

حدود

معامل يكتب وصف
notificationKey خيط مفتاح الإشعارات لمجموعة الأجهزة المراد إرسال الرسالة إليها.
حمولة MessagingPayload حمولة الرسالة.
خيارات خيارات المراسلة خيارات اختيارية لتغيير الرسالة.

عائدات:

وعد< MessagingDeviceGroupResponse >

وعد يتم الوفاء به مع استجابة الخادم بعد إرسال الرسالة.

المراسلة.sendToTopic()

يرسل رسالة FCM إلى موضوع ما.

راجع إرسال إلى موضوع للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية.

إمضاء:

sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;

حدود

معامل يكتب وصف
عنوان خيط الموضوع الذي سيتم إرسال الرسالة إليه.
حمولة MessagingPayload حمولة الرسالة.
خيارات خيارات المراسلة خيارات اختيارية لتغيير الرسالة.

عائدات:

وعد< MessagingTopicResponse >

وعد يتم الوفاء به مع استجابة الخادم بعد إرسال الرسالة.

المراسلة.subscribeToTopic()

يشترك جهازًا في موضوع FCM.

راجع الاشتراك في موضوع للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. اختياريًا، يمكنك توفير مجموعة من الرموز المميزة للاشتراك في أجهزة متعددة.

إمضاء:

subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

حدود

معامل يكتب وصف
رمز التسجيل أو الرموز سلسلة | خيط[]
عنوان خيط الموضوع الذي سيتم الاشتراك فيه.

عائدات:

وعد< MessagingTopicManagementResponse >

وعد يتم الوفاء به مع استجابة الخادم بعد اشتراك الجهاز في الموضوع.

المراسلة.إلغاء الاشتراكمنTopic()

إلغاء اشتراك جهاز من موضوع FCM.

راجع إلغاء الاشتراك في أحد المواضيع للحصول على نماذج التعليمات البرمجية والوثائق التفصيلية. اختياريًا، يمكنك توفير مجموعة من الرموز المميزة لإلغاء الاشتراك في أجهزة متعددة.

إمضاء:

unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

حدود

معامل يكتب وصف
رمز التسجيل أو الرموز سلسلة | خيط[]
عنوان خيط الموضوع الذي تريد إلغاء الاشتراك فيه.

عائدات:

وعد< MessagingTopicManagementResponse >

وعد تم الوفاء به مع استجابة الخادم بعد إلغاء اشتراك الجهاز من الموضوع.