chrome.gcm

الوصف

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

الأذونات

gcm

الخصائص

MAX_MESSAGE_SIZE

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

القيمة

4096

الطُرق

register()

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

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

المعلمات

  • senderIds

    string[]

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

المرتجعات

  • Promise<string>

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

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

send()

chrome.gcm.send(
  message: object,
): Promise<string>

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

المعلمات

  • رسالة

    عنصر

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

    • البيانات

      عنصر

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

    • destinationId

      سلسلة

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

    • messageId

      سلسلة

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

    • timeToLive

      number اختياري

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

المرتجعات

  • Promise<string>

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

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

unregister()

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

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

المرتجعات

  • Promise<void>

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

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

الفعاليات

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

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

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