chrome.gcm

توضیحات

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

مجوزها

gcm

خواص
MAX_MESSAGE_SIZE

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

ارزش

4096

روش ها
register()
قول بده
chrome.gcm.register(
  senderIds: string[],
  callback?: function,
): Promise<string>

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

پارامترها
  • senderIds

    رشته[]

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (registrationId: string) => void

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

      رشته

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

برمی گرداند

  • قول<رشته>

    Chrome 116+

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

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

با توجه به محتوای آن پیام ارسال می کند.

پارامترها
  • پیام

    شی

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

    • داده ها

      شی

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

    • شناسه مقصد

      رشته

      شناسه سروری که برای ارسال پیام توسط Google API Console اختصاص داده شده است.

    • شناسه پیام

      رشته

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

    • timeToLive

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

      زمان تا زندگی پیام در چند ثانیه. اگر امکان ارسال پیام در آن زمان وجود نداشته باشد، یک رویداد onSendError مطرح می شود. زمان زنده بودن 0 نشان می دهد که پیام باید فورا ارسال شود یا اگر امکان پذیر نباشد، با شکست مواجه می شود. مقدار پیش فرض time-to-live 86,400 ثانیه (1 روز) و حداکثر مقدار 2,419,200 ثانیه (28 روز) است.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (messageId: string) => void

    • شناسه پیام

      رشته

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

برمی گرداند

  • قول<رشته>

    Chrome 116+

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

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

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

پارامترها
  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 116+

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

رویدادها
onMessage 
chrome.gcm.onMessage.addListener(
  callback: function,
)

هنگامی که یک پیام از طریق FCM دریافت می شود فعال می شود.

پارامترها
  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (message: object) => void

    • پیام

      شی

      • collapseKey

        رشته اختیاری

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

      • داده ها

        شی

        داده های پیام

      • از

        رشته اختیاری

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

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

هنگامی که یک سرور FCM مجبور شد پیام‌های ارسال شده توسط یک سرور برنامه را به برنامه حذف کند، فعال می‌شود. برای اطلاعات بیشتر در مورد مدیریت این رویداد ، Lifetime of a message را ببینید.

پارامترها
  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    () => void

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

زمانی که امکان ارسال پیام به سرور FCM وجود نداشت فعال شد.

پارامترها
  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (error: object) => void

    • خطا

      شی

      • جزئیات

        شی

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

      • errorMessage

        رشته

        پیام خطایی که مشکل را توضیح می دهد.

      • شناسه پیام

        رشته اختیاری

        شناسه پیام با این خطا، اگر خطا مربوط به پیام خاصی باشد.