شرح
از chrome.gcm برای فعال کردن برنامه‌ها و افزونه‌ها برای ارسال و دریافت پیام ازطریق پیام‌رسانی ابری Firebase (FCM) استفاده کنید.
اجازه‌ها
gcmمشخصات
MAX_MESSAGE_SIZE
حداکثر اندازه (به بایت) همه جفت‌های کلید/مقدار در پیام.
مقدار
۴۰۹۶
روش‌ها
register()
browser.gcm.register(
senderIds: string[],
): Promise<string>
برنامه را در FCM ثبت می‌کند. شناسه ثبت توسط callback برگردانده خواهد شد. اگر register دوباره با همان فهرست senderIds فراخوانی شود، همان شناسه ثبت برگردانده خواهد شد.
پارامترها
-
senderIds
string[]
فهرستی از شناسه‌های سرور که مجاز به ارسال پیام به برنامه هستند. باید حداقل یک و حداکثر ۱۰۰ شناسه فرستنده داشته باشد.
بازگشتی‌ها
-
Promise<string>
Chrome نسخه ۱۱۶ و بالاتر browser.* از Chrome نسخه ۱۴۸وقتی ثبت‌نام تکمیل شود، حل می‌شود.
send()
browser.gcm.send(
message: object,
): Promise<string>
پیامی را براساس محتوای آن ارسال می‌کند.
پارامترها
-
پیام
شیء
پیامی برای ارسال به طرف مقابل ازطریق FCM.
-
داده
شیء
داده‌های پیام برای ارسال به سرور.
goog.وgoogleغیرحساس به حروف و همچنینcollapse_keyحساس به حروف به‌عنوان پیشوند کلید مجاز نیستند. مجموع همه جفت‌های کلید/مقدار نباید ازgcm.MAX_MESSAGE_SIZEبیشتر شود. -
destinationId
رشته
شناسه سرور برای ارسال پیام به آن، همان‌طور که توسط کنسول Google API اختصاص داده شده است.
-
messageId
رشته
شناسه پیام. این شناسه باید برای هر پیام در محدوده برنامه‌ها یکتا باشد. برای دریافت راهنمایی درباره انتخاب و مدیریت شناسه، به اسناد پیام‌رسانی ابری مراجعه کنید.
-
timeToLive
شماره اختیاری
زمان بقای پیام برحسب ثانیه. اگر ارسال پیام در آن زمان ممکن نباشد، رویداد onSendError ایجاد خواهد شد. زمان بقای ۰ نشان می‌دهد که پیام باید فوراً ارسال شود یا اگر امکان‌پذیر نباشد، ارسال آن ناموفق خواهد بود. مقدار پیش‌فرض زمان بقا ۸۶٬۴۰۰ ثانیه (۱ روز) و حداکثر مقدار آن ۲٬۴۱۹٬۲۰۰ ثانیه (۲۸ روز) است.
-
بازگشتی‌ها
-
Promise<string>
Chrome نسخه ۱۱۶ و بالاتر browser.* از Chrome نسخه ۱۴۸پس‌از اینکه پیام با موفقیت در صف ارسال قرار گرفت، حل می‌شود. اگر خطایی رخ دهد، promise رد خواهد شد.
unregister()
browser.gcm.unregister(): Promise<void>
ثبت برنامه را از FCM لغو می‌کند.
بازگشتی‌ها
-
Promise<void>
Chrome نسخه ۱۱۶ و بالاتر browser.* از Chrome نسخه ۱۴۸پس‌از تکمیل لغو ثبت‌نام، حل می‌شود. اگر وعده رد نشود، لغو ثبت‌نام موفقیت‌آمیز بوده است.
رویدادها
onMessage
browser.gcm.onMessage.addListener(
callback: function,
)
وقتی پیامی ازطریق FCM دریافت می‌شود، فعال می‌شود.
پارامترها
-
تماس برگشتی
عملکرد
پارامتر
callbackبه‌صورت زیر است:(message: object) => void
-
پیام
شیء
-
collapseKey
رشته اختیاری
کلید جمع کردن پیام. برای جزئیات، پیام‌های جمع‌شدنی و جمع‌نشدنی را ببینید.
-
داده
شیء
داده‌های پیام.
-
از
رشته اختیاری
فرستنده‌ای که پیام را صادر کرده است.
-
-
onMessagesDeleted
browser.gcm.onMessagesDeleted.addListener(
callback: function,
)
زمانی فعال می‌شود که سرور FCM مجبور باشد پیام‌های ارسال‌شده توسط سرور برنامه به برنامه را حذف کند. برای جزئیات مربوط به مدیریت این رویداد، طول عمر پیام را ببینید.
پارامترها
-
تماس برگشتی
عملکرد
پارامتر
callbackبه‌صورت زیر است:() => void
onSendError
browser.gcm.onSendError.addListener(
callback: function,
)
وقتی ارسال پیام به سرور FCM ممکن نباشد، فعال می‌شود.
پارامترها
-
تماس برگشتی
عملکرد
پارامتر
callbackبه‌صورت زیر است:(error: object) => void
-
خطا
شیء
-
جزئیات
شیء
جزئیات تکمیلی مربوط به خطا، درصورت وجود.
-
errorMessage
رشته
پیام خطایی که مشکل را شرح می‌دهد.
-
messageId
رشته اختیاری
شناسه پیام دارای این خطا، اگر خطا مربوط به پیام خاصی باشد.
-
-