browser.gcm

الوصف

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

الأذونات

gcm

الخصائص

MAX_MESSAGE_SIZE

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

القيمة

4096

الطُرق

register()

browser.gcm.register(
  senderIds: string[],
): Promise<string>

تسجيل التطبيق في FCM سيتم عرض معرّف التسجيل من خلال callback. في حال استدعاء register مرة أخرى باستخدام قائمة senderIds نفسها، سيتم عرض معرّف التسجيل نفسه.

المعلمات

  • senderIds

    string[]

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

المرتجعات

  • وعد<سلسلة>

    الإصدار 116 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

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

send()

browser.gcm.send(
  message: object,
): 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 يومًا).

المرتجعات

  • وعد<سلسلة>

    الإصدار 116 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

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

unregister()

browser.gcm.unregister(): Promise<void>

لإلغاء تسجيل التطبيق من FCM

المرتجعات

  • وعد<فراغ>

    الإصدار 116 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

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

الفعاليات

onMessage

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

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

المعلمات

  • callback

    دالة

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

    (message: object) => void

    • رسالة

      عنصر

      • collapseKey

        string اختياري

        مفتاح التصغير لرسالة معيّنة يُرجى الاطّلاع على الرسائل القابلة للطي وغير القابلة للطي لمزيد من التفاصيل.

      • البيانات

        عنصر

        بيانات الرسالة

      • من

        string اختياري

        المرسِل الذي أصدر الرسالة

onMessagesDeleted

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

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

المعلمات

  • callback

    دالة

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

    () => void

onSendError

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

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

المعلمات

  • callback

    دالة

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

    (error: object) => void

    • خطأ

      عنصر

      • التفاصيل

        عنصر

        تفاصيل إضافية متعلقة بالخطأ، عند توفّرها

      • errorMessage

        سلسلة

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

      • messageId

        string اختياري

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