chrome.gcm

الوصف

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

الأذونات

gcm

أماكن إقامة

MAX_MESSAGE_SIZE

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

القيمة

4096

الطُرق

register()

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

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

المعلمات

  • senderIds

    سلسلة[]

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

  • رد الاتصال

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

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

    (registrationId: string) => void

    • registrationId

      سلسلة

      رقم تعريف تسجيل مخصّص للتطبيق من قِبل خدمة "المراسلة عبر السحابة الإلكترونية من Firebase".

المرتجعات

  • وعود<string>

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

    تتوفّر الوعود في الإصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير معاودة الاتصال. التوافق مع الأنظمة القديمة. لا يمكنك استخدام كلتيهما في نفس استدعاء الدالة. تشير رسالة الأشكال البيانية يتم حل الوعد بنفس النوع الذي يتم إرساله إلى معاودة الاتصال.

send()

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

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

المعلمات

  • رسالة

    كائن

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

    • البيانات

      كائن

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

    • destinationId

      سلسلة

      معرِّف الخادم المطلوب إرسال الرسالة إليه على النحو المحدّد بواسطة وحدة التحكم في واجهة Google API.

    • messageId

      سلسلة

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

    • timeToLive

      الرقم اختياري

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

  • رد الاتصال

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

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

    (messageId: string) => void

    • messageId

      سلسلة

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

المرتجعات

  • وعود<string>

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

    تتوفّر الوعود في الإصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير معاودة الاتصال. التوافق مع الأنظمة القديمة. لا يمكنك استخدام كلتيهما في نفس استدعاء الدالة. تشير رسالة الأشكال البيانية يتم حل الوعد بنفس النوع الذي يتم إرساله إلى معاودة الاتصال.

unregister()

وعود 
chrome.gcm.unregister(
  callback?: function,
)

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

المعلمات

  • رد الاتصال

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

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

    () => void

المرتجعات

  • وعود <باطلة>

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

    تتوفّر الوعود في الإصدار Manifest V3 والإصدارات الأحدث، ولكن يتم توفير معاودة الاتصال. التوافق مع الأنظمة القديمة. لا يمكنك استخدام كلتيهما في نفس استدعاء الدالة. تشير رسالة الأشكال البيانية يتم حل الوعد بنفس النوع الذي يتم إرساله إلى معاودة الاتصال.

فعاليات

onMessage

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

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

المعلمات

  • رد الاتصال

    دالة

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

    (message: object) => void

    • رسالة

      كائن

      • collapseKey

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

        مفتاح التصغير للرسالة. اطّلِع على الرسائل غير القابلة للتصغير والتصغير لمعرفة التفاصيل.

      • البيانات

        كائن

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

      • من

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

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

onMessagesDeleted

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

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

المعلمات

  • رد الاتصال

    دالة

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

    () => void

onSendError

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

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

المعلمات

  • رد الاتصال

    دالة

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

    (error: object) => void

    • خطأ

      كائن

      • التفاصيل

        كائن

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

      • errorMessage

        سلسلة

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

      • messageId

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

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