chrome.gcm

refresh date: 2026-09-25 robots: noindex

الوصف

استخدِم chrome.gcm للسماح للتطبيقات والإضافات بإرسال الرسائل وتلقّيها من خلال مراسلة Firebase السحابية (FCM).

الأذونات

gcm

الخصائص

MAX_MESSAGE_SIZE

الحد الأقصى لحجم جميع أزواج المفتاح/القيمة في الرسالة (بالبايت).

القيمة

4096

الطُرق

register()

وعد 
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
): Promise<string>

تسجِّل هذه الطريقة التطبيق في خدمة "المراسلة عبر السحابة الإلكترونية من Firebase". ستعرض callback رقم تعريف التسجيل. إذا تم استدعاء register مرة أخرى باستخدام قائمة senderIds نفسها، سيتم عرض رقم التعريف نفسه.

المعلمات

  • senderIds

    string[]

    قائمة بمعرّفات الخوادم المسموح لها بإرسال رسائل إلى التطبيق. يجب أن يحتوي على رقم تعريف مرسِل واحد على الأقل و100 رقم تعريف مرسِل على الأكثر.

  • callback

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (registrationId: string) => void

    • registrationId

      سلسلة

      معرّف تسجيل يخصّصه FCM للتطبيق.

المرتجعات

  • Promise<string>

    الإصدار 116 من Chrome والإصدارات الأحدث

    يتم حلّها عند اكتمال عملية التسجيل.

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، بينما تحتاج المنصات الأخرى إلى استخدام عمليات معاودة الاتصال.

send()

وعد 
chrome.gcm.send(
  message: object,
  callback?: function,
): Promise<string>

يرسِل رسالة وفقًا لمحتواها.

المعلمات

  • رسالة

    عنصر

    رسالة لإرسالها إلى الطرف الآخر من خلال FCM

    • البيانات

      عنصر

      بيانات الرسالة التي سيتم إرسالها إلى الخادم لا يُسمح باستخدام goog. وgoogle غير الحسّاسَين لحالة الأحرف، بالإضافة إلى collapse_key الحسّاس لحالة الأحرف، كبادئات للمفاتيح. يجب ألا يتجاوز مجموع جميع أزواج المفتاح/القيمة gcm.MAX_MESSAGE_SIZE.

    • destinationId

      سلسلة

      معرّف الخادم الذي سيتم إرسال الرسالة إليه، كما هو محدّد في وحدة تحكّم Google API

    • messageId

      سلسلة

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

    • timeToLive

      number اختياري

      تشير هذه السمة إلى مدة بقاء الرسالة بالثواني. إذا لم يكن من الممكن إرسال الرسالة خلال هذا الوقت، سيتم إنشاء حدث onSendError. يشير وقت البقاء على قيد الحياة الذي تبلغ قيمته 0 إلى أنّه يجب إرسال الرسالة على الفور أو تعذُّر إرسالها إذا لم يكن ذلك ممكنًا. القيمة التلقائية لمدة البقاء هي 86,400 ثانية (يوم واحد) والحد الأقصى للقيمة هو 2,419,200 ثانية (28 يومًا).

  • callback

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    (messageId: string) => void

    • messageId

      سلسلة

      معرّف الرسالة التي تم إصدار ردّ الاتصال لها.

المرتجعات

  • Promise<string>

    الإصدار 116 من Chrome والإصدارات الأحدث

    يتم حلّها بعد وضع الرسالة بنجاح في قائمة الانتظار لإرسالها. في حال حدوث خطأ، سيتم رفض الوعد.

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، بينما تحتاج المنصات الأخرى إلى استخدام عمليات معاودة الاتصال.

unregister()

وعد 
chrome.gcm.unregister(
  callback?: function,
): Promise<void>

لإلغاء تسجيل التطبيق من خدمة FCM.

المعلمات

  • callback

    الدالة اختيارية

    تظهر المَعلمة callback على النحو التالي: 

    () => void

المرتجعات

  • Promise<void>

    الإصدار 116 من Chrome والإصدارات الأحدث

    يتم حلّها بعد اكتمال عملية إلغاء التسجيل. تم إلغاء التسجيل بنجاح إذا لم يتم رفض الوعد.

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، بينما تحتاج المنصات الأخرى إلى استخدام عمليات معاودة الاتصال.

الفعاليات

onMessage

chrome.gcm.onMessage.addListener(
  callback: function,
)

يتم تنشيط هذا الحدث عند تلقّي رسالة من خلال خدمة "مراسلة Firebase السحابية".

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (message: object) => void

onMessagesDeleted

chrome.gcm.onMessagesDeleted.addListener(
  callback: function,
)

يتم تنشيط هذا الحدث عندما يضطر خادم مراسلة Firebase السحابية إلى حذف الرسائل التي أرسلها خادم التطبيق إلى التطبيق. اطّلِع على مدة بقاء الرسالة لمعرفة تفاصيل حول كيفية التعامل مع هذا الحدث.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    () => void

onSendError

chrome.gcm.onSendError.addListener(
  callback: function,
)

يتم تنشيط هذا الحدث عندما يتعذّر إرسال رسالة إلى خادم FCM.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (error: object) => void

    • خطأ

      عنصر

      • التفاصيل

        عنصر

        تفاصيل إضافية متعلّقة بالخطأ، إذا كانت متاحة

      • errorMessage

        سلسلة

        رسالة الخطأ التي تصف المشكلة

      • messageId

        سلسلة اختيارية

        معرّف الرسالة التي تتضمّن هذا الخطأ، إذا كان الخطأ مرتبطًا برسالة معيّنة