Messaging class

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

Signature:

export declare class Messaging 

أماكن إقامة

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

الطُرق

الطريقة	المعدِّلات	الوصف
enableLegacyHttpTransport()		تفعِّل هذه السياسة استخدام نقل HTTP/1.1 القديم لكلٍّ من sendEach() وsendEachForMulticast().
إرسال(message, driveRun)		لإرسال الرسالة المحددة عبر خدمة "المراسلة عبر السحابة الإلكترونية من Firebase".
sendAll(messages, rockRun)		يرسل جميع الرسائل في الصفيف المحدد عبر المراسلة عبر السحابة الإلكترونية من Firebase. يتم استخدام التجميع لإرسال القائمة بأكملها كطلب RPC واحد. مقارنةً بطريقة send()، تُعد هذه الطريقة طريقة أكثر فاعلية لإرسال رسائل متعددة.تتوافق قائمة الردود التي يتم الحصول عليها من القيمة المعروضة مع ترتيب الرموز المميزة في MulticastMessage. يشير الخطأ من هذه الطريقة إلى الإخفاق الكلي، مما يعني أنه لا يمكن إرسال أي من الرسائل الموجودة في القائمة. وتتم الإشارة إلى الأخطاء الجزئية من خلال القيمة المعروضة BatchResponse.
send each(messages, rockRun)		لإرسال كل رسالة في الصفيف المحدد من خلال المراسلة عبر السحابة الإلكترونية من Firebase.على عكس Messaging.sendAll()، تجري هذه الطريقة استدعاء RPC واحدًا لكل رسالة في الصفيف المحدد.تتوافق قائمة الردود التي يتم الحصول عليها من القيمة المعروضة مع ترتيب messages. يشير الخطأ من هذه الطريقة أو الخطأ "BatchResponse" الذي يضم جميع الأخطاء إلى تعذُّر الإجراء تمامًا، ما يعني أنّه لا يمكن إرسال أي من الرسائل الواردة في القائمة. لا تتم الإشارة إلى حالات الإخفاق الجزئية أو عدم الأعطال إلا من خلال القيمة المعروضة BatchResponse.
sendafterForMulticast(message, rockRun)		لإرسال رسالة البث المتعدد المحدّدة إلى جميع الرموز المميزة لتسجيل خدمة FCM المحددة فيها.تستخدم هذه الطريقة واجهة برمجة التطبيقات Messaging.send يضيف() واجهة برمجة التطبيقات الخاصة بإرسال الرسالة المحددة إلى جميع المستلمين المستهدفين. تتوافق قائمة الاستجابات التي يتم الحصول عليها من القيمة المعروضة مع ترتيب الرموز المميّزة في MulticastMessage. إذا كان هناك خطأ من هذه الطريقة أو رسالة "BatchResponse" تتضمّن جميع الأخطاء، يشير ذلك إلى حدوث إخفاق إجمالي، ما يعني أنّه قد يتم إرسال الرسائل الواردة في القائمة. لا تتم الإشارة إلى حالات الإخفاق أو الإخفاق الجزئية إلا من خلال القيمة المعروضة BatchResponse.
sendMulticast(message, rockRun)		لإرسال رسالة البث المتعدد المحدّدة إلى جميع الرموز المميّزة للتسجيل في خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" المحدّدة فيها.تستخدم هذه الطريقة واجهة برمجة التطبيقات sendAll() ضمن الخيارات لإرسال الرسالة المحدّدة إلى جميع المستلِمين المستهدَفين. تتوافق قائمة الاستجابات التي يتم الحصول عليها من القيمة المعروضة مع ترتيب الرموز المميّزة في MulticastMessage. يشير الخطأ من هذه الطريقة إلى الإخفاق الكلي، مما يعني أن الرسالة لم يتم إرسالها إلى أي من الرموز المميزة في القائمة. وتتم الإشارة إلى الأخطاء الجزئية من خلال القيمة المعروضة BatchResponse.
sendToCondition(condition, payload, options)		لإرسال رسالة FCM إلى أحد الشروط.يمكنك الاطّلاع على إرسال إلى شرط للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية.
sendToDevice(registrationTokenOrTokens, payload, options)		لإرسال رسالة FCM إلى جهاز واحد يتوافق مع الرمز المميّز للتسجيل.يمكنك الاطّلاع على الإرسال إلى أجهزة فردية للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية. يستغرق الأمر registrationToken للإرسال إلى جهاز واحد أو معلَمة registrationTokens تحتوي على مصفوفة من الرموز المميّزة لإرسالها إلى أجهزة متعددة.
sendToDeviceGroup(notificationsKey, payload, options)		لإرسال رسالة عبر خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" إلى مجموعة أجهزة تتوافق مع مفتاح الإشعار المقدَّم.يمكنك الاطّلاع على الإرسال إلى مجموعة أجهزة لمعرفة عيّنات الرموز والمستندات التفصيلية.
sendToTopic(topic, payload, options)		لإرسال رسالة عبر خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" إلى موضوع.راجِع إرسال إلى موضوع للاطّلاع على نماذج الرموز والمستندات التفصيلية.
partnerToTopic(registrationTokenOrTokens, topic)		يؤدي هذا الإجراء إلى اشتراك جهاز في موضوع "المراسلة عبر السحابة الإلكترونية من Firebase".راجِع الاشتراك في موضوع للاطّلاع على نماذج الرموز والمستندات التفصيلية. يمكنك اختياريًا تقديم مجموعة من الرموز المميّزة للاشتراك في أجهزة متعدّدة.
unsubscribeFromTopic(registrationTokenOrTokens, topic)		لإلغاء الاشتراك في جهاز من موضوع خدمة "المراسلة عبر السحابة الإلكترونية من Firebase".راجِع إلغاء الاشتراك في موضوع للاطّلاع على نماذج الرموز والمستندات التفصيلية. يمكنك اختياريًا تقديم مجموعة من الرموز المميّزة لإلغاء الاشتراك في أجهزة متعدّدة.

تطبيق Messaging.app

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

Signature:

get app(): App;

مثال

var app = messaging.app;

Messaging.enableLegacyHttpTransport()

تحذير: أصبحت واجهة برمجة التطبيقات هذه قديمة الآن.

وستتم إزالة ذلك عندما يصل تنفيذ نقل HTTP/2 إلى نفس استقرار تنفيذ HTTP/1.1 القديم.

تفعِّل هذه السياسة استخدام نقل HTTP/1.1 القديم مع sendEach() وsendEachForMulticast().

Signature:

enableLegacyHttpTransport(): void;

المرتجعات:

فراغ

مثال

const messaging = getMessaging(app);
messaging.enableLegacyTransport();
messaging.sendEach(messages);

Messaging.send()

لإرسال الرسالة المحددة عبر خدمة "المراسلة عبر السحابة الإلكترونية من Firebase".

Signature:

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

المَعلمات

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

المرتجعات:

وعود<string>

تم الوفاء بوعد بسلسلة معرّف رسالة فريدة بعد تسليم الرسالة بنجاح إلى خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" للتسليم.

Messaging.sendAll()

تحذير: أصبحت واجهة برمجة التطبيقات هذه قديمة الآن.

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

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

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

Signature:

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

المَعلمات

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

المرتجعات:

الوعد<BatchResponse>

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

Messaging.send يُمْكِنْ()

يرسل كل رسالة في الصفيف المحدد عبر المراسلة عبر السحابة الإلكترونية من Firebase.

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

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

Signature:

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

المَعلمات

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

المرتجعات:

الوعد<BatchResponse>

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

Messaging.sendRemoveForMulticast()

لإرسال رسالة البث المتعدد المحدّدة إلى جميع الرموز المميّزة لتسجيل خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" المحدّدة فيها.

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

Signature:

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

المَعلمات

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

المرتجعات:

الوعد<BatchResponse>

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

Messaging.sendMulticast()

تحذير: أصبحت واجهة برمجة التطبيقات هذه قديمة الآن.

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

لإرسال رسالة البث المتعدد المحدّدة إلى جميع الرموز المميّزة لتسجيل خدمة "المراسلة عبر السحابة الإلكترونية من Firebase" المحدّدة فيها.

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

Signature:

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

المَعلمات

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

المرتجعات:

الوعد<BatchResponse>

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

Messaging.sendToCondition()

تحذير: أصبحت واجهة برمجة التطبيقات هذه قديمة الآن.

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

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

راجِع الإرسال إلى شرط للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

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

المَعلمات

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

المرتجعات:

وعود<MessagingConditionResponse>

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

Messaging.sendToDevice()

تحذير: أصبحت واجهة برمجة التطبيقات هذه قديمة الآن.

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

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

راجِع الإرسال إلى أجهزة فردية للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية. يستغرق الأمر registrationToken للإرسال إلى جهاز واحد أو معلَمة registrationTokens تحتوي على مصفوفة من الرموز المميّزة لإرسالها إلى أجهزة متعددة.

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
التسجيلTokenOrTokens	سلسلة | سلسلة[]
حمولة البيانات	MessagingPayload	حمولة الرسالة
خيارات	MessagingOptions	خيارات اختيارية لتغيير الرسالة.

المرتجعات:

وعد <MessagingDevicesResponse>

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

Messaging.sendToDeviceGroup()

تحذير: أصبحت واجهة برمجة التطبيقات هذه قديمة الآن.

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

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

راجِع الإرسال إلى مجموعة أجهزة للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية.

Signature:

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

المَعلمات

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

المرتجعات:

الوعد<MessagingDeviceGroupResponse>

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

Messaging.sendTopic()

تحذير: أصبحت واجهة برمجة التطبيقات هذه قديمة الآن.

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

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

راجِع الإرسال إلى موضوع للاطّلاع على نماذج الرموز والمستندات التفصيلية.

Signature:

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

المَعلمات

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

المرتجعات:

وعود<MessagingTopicResponse>

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

Messaging.subscribeToTopic()

تشير هذه الحالة إلى اشتراك جهاز في موضوع "المراسلة عبر السحابة الإلكترونية من Firebase".

راجِع الاشتراك في موضوع للاطّلاع على عيّنات التعليمات البرمجية والمستندات التفصيلية. يمكنك اختياريًا تقديم مجموعة من الرموز المميّزة للاشتراك في أجهزة متعدّدة.

Signature:

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

المَعلمات

المعلمة	النوع	الوصف
التسجيلTokenOrTokens	سلسلة | سلسلة[]
موضوع	السلسلة	الموضوع الذي تريد الاشتراك فيه

المرتجعات:

وعود <MessagingTopicManagementResponse>

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

Messaging.unsubscribeFromTopic()

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

راجِع إلغاء الاشتراك في موضوع للاطّلاع على عيّنات من الرموز البرمجية والمستندات التفصيلية. يمكنك اختياريًا تقديم مجموعة من الرموز المميّزة لإلغاء الاشتراك في أجهزة متعدّدة.

Signature:

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

المَعلمات

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

المرتجعات:

وعود <MessagingTopicManagementResponse>

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