رابطی که نشان دهنده گزینه هایی است که هنگام ارسال پیام از طریق APIهای قدیمی FCM ارائه می شود.
برای نمونه‌های کد و مستندات دقیق، به ساخت درخواست‌های ارسال مراجعه کنید.
امضا:
export interface MessagingOptions
خواص
| ویژگی | تایپ کنید | شرح |
|---|---|---|
| collapseKey | رشته | رشته ای که گروهی از پیام ها را شناسایی می کند (به عنوان مثال، "به روز رسانی های موجود") که می توانند جمع شوند، به طوری که تنها آخرین پیام در هنگام ازسرگیری تحویل ارسال می شود. این برای جلوگیری از ارسال بیش از حد پیام‌های مشابه زمانی که دستگاه دوباره آنلاین می‌شود یا فعال می‌شود، استفاده می‌شود. هیچ تضمینی برای ترتیب ارسال پیام ها وجود ندارد. حداکثر چهار کلید کوچک کردن مختلف در هر زمان مجاز است. این بدان معنی است که سرور FCM می تواند به طور همزمان چهار پیام مختلف ارسال به همگام سازی را در هر برنامه مشتری ذخیره کند. اگر از این تعداد تجاوز کنید، هیچ تضمینی وجود ندارد که سرور FCM کدام چهار کلید را نگه دارد. **مقدار پیش فرض:** هیچ کدام |
| محتوای موجود | بولی | در iOS، از این فیلد برای نمایش content-available در بارگذاری APN استفاده کنید. وقتی یک اعلان یا پیام داده ارسال می‌شود و روی true تنظیم می‌شود، یک برنامه مشتری غیرفعال بیدار می‌شود. در Android، پیام های داده به طور پیش فرض برنامه را بیدار می کنند. در Chrome، این پرچم در حال حاضر پشتیبانی نمی‌شود. **مقدار پیش فرض:** false |
| dryRun | بولی | اینکه آیا پیام باید واقعا ارسال شود یا نه. هنگامی که روی true تنظیم می شود، به توسعه دهندگان اجازه می دهد تا بدون ارسال پیام واقعاً یک درخواست را آزمایش کنند. وقتی روی false تنظیم شود، پیام ارسال خواهد شد. **مقدار پیش فرض:** false |
| محتوای قابل تغییر | بولی | در iOS، از این فیلد برای نمایش mutable-content در بارگذاری APN استفاده کنید. وقتی اعلان ارسال می‌شود و روی true تنظیم می‌شود، می‌توان محتوای اعلان را قبل از نمایش با استفاده از برنامه افزودنی برنامه Notification Service تغییر داد. . در اندروید و وب، این پارامتر نادیده گرفته می شود. **مقدار پیش فرض:** false |
| اولویت | رشته | اولویت پیام. مقادیر معتبر "normal" و "high". در iOS، این موارد با اولویت‌های APN 5 و 10 مطابقت دارند. به طور پیش‌فرض، پیام‌های اعلان با اولویت بالا و پیام‌های داده با اولویت عادی ارسال می‌شوند. اولویت عادی مصرف باتری برنامه مشتری را بهینه می کند و باید از آن استفاده کرد مگر اینکه تحویل فوری لازم باشد. برای پیام‌هایی با اولویت معمولی، برنامه ممکن است پیام را با تاخیر نامشخصی دریافت کند. وقتی پیامی با اولویت بالا ارسال می‌شود، بلافاصله ارسال می‌شود و برنامه می‌تواند یک دستگاه خواب را بیدار کند و یک اتصال شبکه را به سرور شما باز کند. برای اطلاعات بیشتر، به تنظیم اولویت یک پیام مراجعه کنید . **مقدار پیش‌فرض:** "high" برای پیام‌های اعلان، "normal" برای پیام‌های داده |
| limitedPackageName | رشته | نام بسته برنامه که نشانه های ثبت نام باید برای دریافت پیام مطابقت داشته باشند. **مقدار پیش فرض:** هیچ کدام |
| timeToLive | عدد | اگر دستگاه آفلاین باشد، پیام چقدر (در ثانیه) باید در فضای ذخیره سازی FCM نگهداری شود. حداکثر زمان پشتیبانی زنده چهار هفته و مقدار پیش فرض نیز چهار هفته است. برای اطلاعات بیشتر، به تنظیم طول عمر پیام مراجعه کنید . **مقدار پیش فرض:** 2419200 (نماینده چهار هفته، در ثانیه) |
MessagingOptions.collapseKey
رشته ای که گروهی از پیام ها را شناسایی می کند (به عنوان مثال، "به روز رسانی های موجود") که می توانند جمع شوند، به طوری که تنها آخرین پیام در هنگام ازسرگیری تحویل ارسال می شود. این برای جلوگیری از ارسال بیش از حد پیام‌های مشابه زمانی که دستگاه دوباره آنلاین می‌شود یا فعال می‌شود، استفاده می‌شود.
هیچ تضمینی برای ترتیب ارسال پیام ها وجود ندارد.
حداکثر چهار کلید کوچک کردن مختلف در هر زمان مجاز است. این بدان معنی است که سرور FCM می تواند به طور همزمان چهار پیام مختلف ارسال به همگام سازی را در هر برنامه مشتری ذخیره کند. اگر از این تعداد تجاوز کنید، هیچ تضمینی وجود ندارد که سرور FCM کدام چهار کلید را نگه دارد.
**مقدار پیش فرض:** هیچ کدام
امضا:
collapseKey?: string;
MessagingOptions.contentAvailable
در iOS، از این فیلد برای نمایش content-available در بارگذاری APN استفاده کنید. هنگامی که یک اعلان یا پیام داده ارسال می شود و این روی true تنظیم می شود ، یک برنامه مشتری غیرفعال بیدار می شود. در Android، پیام های داده به طور پیش فرض برنامه را بیدار می کنند. در Chrome، این پرچم در حال حاضر پشتیبانی نمی‌شود.
**مقدار پیش فرض:** false
امضا:
contentAvailable?: boolean;
MessagingOptions.dryRun
اینکه آیا پیام باید واقعا ارسال شود یا نه. وقتی روی true تنظیم شود ، به توسعه دهندگان این امکان را می دهد که بدون ارسال پیام واقعاً یک درخواست را آزمایش کنند. وقتی روی false تنظیم شود ، پیام ارسال خواهد شد.
**مقدار پیش فرض:** false
امضا:
dryRun?: boolean;
MessagingOptions.mutableContent
در iOS، از این فیلد برای نمایش mutable-content در بارگذاری APN استفاده کنید. هنگامی که یک اعلان ارسال می شود و این روی true تنظیم می شود ، می توان محتوای اعلان را قبل از نمایش با استفاده از برنامه افزودنی سرویس اعلان تغییر داد .
در اندروید و وب، این پارامتر نادیده گرفته می شود.
**مقدار پیش فرض:** false
امضا:
mutableContent?: boolean;
MessagingOptions.priority
اولویت پیام. مقادیر معتبر "normal" و "high". در iOS، اینها با اولویت های APN 5 و 10 مطابقت دارند .
به طور پیش‌فرض، پیام‌های اعلان با اولویت بالا و پیام‌های داده با اولویت عادی ارسال می‌شوند. اولویت عادی مصرف باتری برنامه مشتری را بهینه می کند و باید از آن استفاده کرد مگر اینکه تحویل فوری لازم باشد. برای پیام‌هایی با اولویت معمولی، برنامه ممکن است پیام را با تاخیر نامشخصی دریافت کند.
وقتی پیامی با اولویت بالا ارسال می‌شود، بلافاصله ارسال می‌شود و برنامه می‌تواند یک دستگاه خواب را بیدار کند و یک اتصال شبکه را به سرور شما باز کند.
برای اطلاعات بیشتر، به تنظیم اولویت یک پیام مراجعه کنید .
**مقدار پیش‌فرض:** "high" برای پیام‌های اعلان، "normal" برای پیام‌های داده
امضا:
priority?: string;
MessagingOptions.restrictedPackageName
نام بسته برنامه که نشانه های ثبت نام باید برای دریافت پیام مطابقت داشته باشند.
**مقدار پیش فرض:** هیچ کدام
امضا:
restrictedPackageName?: string;
MessagingOptions.timeToLive
اگر دستگاه آفلاین باشد، پیام چقدر (در ثانیه) باید در فضای ذخیره سازی FCM نگهداری شود. حداکثر زمان پشتیبانی زنده چهار هفته و مقدار پیش فرض نیز چهار هفته است. برای اطلاعات بیشتر، به تنظیم طول عمر پیام مراجعه کنید .
**مقدار پیش فرض:** 2419200 (نماینده چهار هفته، در ثانیه)
امضا:
timeToLive?: number;