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>

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

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

send()

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

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

المَعلمات

  • رسالة

    كائن

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

    • البيانات

      كائن

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

    • destinationId

      سلسلة

      رقم تعريف الخادم المطلوب إرسال الرسالة إليه وفقًا لما تم تحديده من خلال Google API Console.

    • messageId

      سلسلة

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

    • timeToLive

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

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

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    (messageId: string)=>void

    • messageId

      سلسلة

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

المرتجعات

  • وعد<string>

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

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

unregister()

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

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

المَعلمات

  • معاودة الاتصال

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

    تبدو معلَمة callback على النحو التالي: 

    ()=>void

المرتجعات

  • Promise<void>

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

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

فعاليات

onMessage

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

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

المَعلمات

  • معاودة الاتصال

    الوظيفة

    تبدو معلَمة callback على النحو التالي: 

    (message: object)=>void

    • رسالة

      كائن

onMessagesDeleted

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

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

المَعلمات

  • معاودة الاتصال

    الوظيفة

    تبدو معلَمة callback على النحو التالي: 

    ()=>void

onSendError

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

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

المَعلمات

  • معاودة الاتصال

    الوظيفة

    تبدو معلَمة callback على النحو التالي: 

    (error: object)=>void

    • خطأ

      كائن

      • التفاصيل

        كائن

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

      • errorMessage

        سلسلة

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

      • messageId

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

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