chrome.gcm

توضیحات

chrome.gcm برای فعال کردن ارسال و دریافت پیام‌ها از طریق Firebase Cloud Messaging (FCM) برای برنامه‌ها و افزونه‌ها استفاده کنید.

مجوزها

gcm

خواص

MAX_MESSAGE_SIZE

حداکثر اندازه (برحسب بایت) تمام جفت‌های کلید/مقدار در یک پیام.

ارزش

۴۰۹۶ عدد

روش‌ها

register()

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

برنامه را با FCM ثبت می‌کند. شناسه ثبت توسط callback برگشت داده می‌شود. اگر register دوباره با همان لیست senderIds فراخوانی شود، همان شناسه ثبت برگردانده می‌شود.

پارامترها

  • شناسه‌های فرستنده

    رشته[]

    فهرستی از شناسه‌های سرور که مجاز به ارسال پیام به برنامه هستند. این فهرست باید حداقل شامل یک و حداکثر ۱۰۰ شناسه فرستنده باشد.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (registrationId: string) => void

    • شناسه ثبت نام

      رشته

      شناسه ثبت نام که توسط FCM به برنامه اختصاص داده شده است.

بازگشت‌ها

  • قول<string>

    کروم ۱۱۶+

    با اتمام ثبت نام حل میشه.

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

send()

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

پیامی را مطابق با محتوای آن ارسال می‌کند.

پارامترها

  • پیام

    شیء

    پیامی برای ارسال به طرف مقابل از طریق FCM.

    • داده‌ها

      شیء

      داده‌های پیام برای ارسال به سرور. goog. و google که به حروف کوچک و بزرگ حساس نیستند، و همچنین collapse_key به حروف کوچک و بزرگ حساس است، به عنوان پیشوندهای کلید مجاز نیستند. مجموع تمام جفت‌های کلید/مقدار نباید از gcm.MAX_MESSAGE_SIZE بیشتر شود.

    • شناسه مقصد

      رشته

      شناسه سروری که پیام به آن ارسال می‌شود، همانطور که توسط کنسول API گوگل تعیین شده است.

    • شناسه پیام

      رشته

      شناسه پیام. این شناسه باید برای هر پیام در محدوده برنامه‌های کاربردی منحصر به فرد باشد. برای راهنمایی در مورد انتخاب و مدیریت شناسه ، به مستندات پیام‌رسانی ابری مراجعه کنید.

    • زمان برای زندگی

      شماره اختیاری

      زمان ارسال پیام بر حسب ثانیه. اگر ارسال پیام در این مدت زمان امکان‌پذیر نباشد، رویداد onSendError رخ می‌دهد. زمان ارسال برابر با ۰ نشان می‌دهد که پیام باید فوراً ارسال شود یا در صورت عدم امکان، با شکست مواجه می‌شود. مقدار پیش‌فرض زمان ارسال ۸۶۴۰۰ ثانیه (۱ روز) و حداکثر مقدار آن ۲۴۱۹۲۰۰ ثانیه (۲۸ روز) است.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (messageId: string) => void

    • شناسه پیام

      رشته

      شناسه پیامی که فراخوانی برگشتی برای آن صادر شده است.

بازگشت‌ها

  • قول<string>

    کروم ۱۱۶+

    پس از اینکه پیام با موفقیت در صف ارسال قرار گرفت، برطرف می‌شود. در صورت بروز خطا، promise رد خواهد شد.

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

unregister()

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

برنامه را از FCM لغو ثبت می‌کند.

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۱۱۶+

    پس از اتمام لغو ثبت، برطرف می‌شود. اگر promise رد نشود، لغو ثبت با موفقیت انجام شده است.

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

رویدادها

onMessage

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

زمانی اجرا می‌شود که پیامی از طریق FCM دریافت شود.

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است: 

    (message: object) => void

    • پیام

      شیء

      • کلید فروپاشی

        رشته اختیاری

        کلید جمع کردن یک پیام. برای جزئیات بیشتر به پیام‌های غیرقابل جمع شدن و قابل جمع شدن مراجعه کنید.

      • داده‌ها

        شیء

        داده‌های پیام.

      • از

        رشته اختیاری

        فرستنده‌ای که پیام را صادر کرده است.

onMessagesDeleted

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

زمانی اجرا می‌شود که یک سرور FCM مجبور باشد پیام‌های ارسالی توسط یک سرور برنامه به برنامه را حذف کند. برای جزئیات بیشتر در مورد نحوه مدیریت این رویداد، به بخش «طول عمر یک پیام» مراجعه کنید.

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است: 

    () => void

onSendError

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

زمانی اجرا می‌شود که ارسال پیام به سرور FCM امکان‌پذیر نباشد.

پارامترها

  • تماس برگشتی

    تابع

    پارامتر callback به شکل زیر است: 

    (error: object) => void

    • خطا

      شیء

      • جزئیات

        شیء

        جزئیات بیشتر مربوط به خطا، در صورت وجود.

      • پیام خطا

        رشته

        پیام خطایی که مشکل را توصیف می‌کند.

      • شناسه پیام

        رشته اختیاری

        شناسه‌ی پیام حاوی این خطا، در صورتی که خطا مربوط به یک پیام خاص باشد.