NotificationMessagePayload interface

واسط نشان دهنده بار پیام اعلان API قدیمی FCM. پیام‌های اعلان به توسعه‌دهندگان اجازه می‌دهد تا 4 کیلوبایت جفت کلید-مقدار از پیش تعریف‌شده را ارسال کنند. کلیدهای پذیرفته شده در زیر مشخص شده است.

برای نمونه‌های کد و مستندات دقیق، به ساخت درخواست‌های ارسال مراجعه کنید.

امضا:

export interface NotificationMessagePayload 

خواص

ویژگی	تایپ کنید	شرح
نشان	رشته	مقدار نشان در نماد برنامه صفحه اصلی. اگر مشخص نشده باشد، نشان تغییر نمی کند. اگر روی 0 تنظیم شود، نشان حذف می شود. **پلتفرم ها:** iOS
بدن	رشته	متن متن اعلان. **پلتفرم ها:** iOS، اندروید، وب
bodyLocArgs	رشته	مقادیر رشته متغیری که به جای مشخص کننده های قالب در body_loc_key استفاده می شود تا متن اصلی را به محلی سازی فعلی کاربر بومی سازی کنید. مقدار باید یک آرایه JSON رشته ای باشد. **iOS:** مربوط به loc-args در بارگذاری APN است. برای اطلاعات بیشتر به مرجع کلید Payload و محلی سازی محتوای اعلان های راه دور خود مراجعه کنید. **اندروید:** برای اطلاعات بیشتر به قالب بندی و استایلینگ مراجعه کنید. **پلتفرم ها:** iOS، Android
bodyLockkey	رشته	کلید رشته بدنه در منابع رشته برنامه برای بومی سازی متن متن به محلی سازی فعلی کاربر. **iOS:** مربوط به loc-key در بارگذاری APN است. برای اطلاعات بیشتر به مرجع کلید Payload و محلی سازی محتوای اعلان های راه دور خود مراجعه کنید. **اندروید:** برای اطلاعات بیشتر به منابع رشته مراجعه کنید. **پلتفرم ها:** iOS، Android
clickAction	رشته	اقدام مرتبط با کلیک کاربر روی اعلان. اگر مشخص شده باشد، زمانی که کاربر روی اعلان کلیک می کند، یک فعالیت با فیلتر هدف منطبق راه اندازی می شود. * **پلتفرم ها:** اندروید
رنگ	رشته	رنگ نماد اعلان، که در قالب #rrggbb بیان شده است. **پلتفرم ها:** اندروید
آیکون	رشته	نماد اعلان **Android:** نماد اعلان را برای myicon منبع قابل ترسیم روی myicon تنظیم می کند. اگر این کلید را در درخواست ارسال نکنید، FCM نماد راه‌انداز مشخص‌شده در مانیفست برنامه شما را نمایش می‌دهد. **وب:** URL مورد استفاده برای نماد اعلان. **پلتفرم ها:** اندروید، وب
صدا	رشته	صدایی که وقتی دستگاه اعلان دریافت می کند پخش می شود. از «پیش‌فرض» برای صدای اعلان پیش‌فرض دستگاه یا نام فایل یک منبع صوتی همراه در برنامه پشتیبانی می‌کند. فایل های صوتی باید در /res/raw/ قرار داشته باشند. **پلتفرم ها:** اندروید
برچسب زدن	رشته	شناسه برای جایگزینی اعلان‌های موجود در کشوی اعلان استفاده می‌شود. اگر مشخص نشده باشد، هر درخواست یک اعلان جدید ایجاد می کند. اگر مشخص شده باشد و اعلانی با همان برچسب قبلاً نشان داده شده باشد، اعلان جدید جایگزین اعلان موجود در کشوی اعلان می شود. **پلتفرم ها:** اندروید
عنوان	رشته	عنوان اطلاعیه **پلتفرم ها:** iOS، اندروید، وب
titleLocArgs	رشته	مقادیر رشته متغیری که به جای مشخص کننده های قالب در title_loc_key استفاده می شود تا متن عنوان را به محلی سازی فعلی کاربر بومی سازی کنید. مقدار باید یک آرایه JSON رشته ای باشد. **iOS:** مربوط به title-loc-args در بارگذاری APN است. برای اطلاعات بیشتر به مرجع کلید Payload و محلی سازی محتوای اعلان های راه دور خود مراجعه کنید. **اندروید:** برای اطلاعات بیشتر به قالب بندی و استایلینگ مراجعه کنید. **پلتفرم ها:** iOS، Android
titleLockkey	رشته	کلید رشته عنوان در منابع رشته برنامه برای بومی سازی متن عنوان در محلی سازی فعلی کاربر. **iOS:** مربوط به title-loc-key در بارگذاری APN است. برای اطلاعات بیشتر به مرجع کلید Payload و محلی سازی محتوای اعلان های راه دور خود مراجعه کنید. **اندروید:** برای اطلاعات بیشتر به منابع رشته مراجعه کنید. **پلتفرم ها:** iOS، Android

NotificationMessagePayload.badge

مقدار نشان در نماد برنامه صفحه اصلی.

اگر مشخص نشده باشد، نشان تغییر نمی کند.

اگر روی 0 تنظیم شود ، نشان حذف می شود.

**پلتفرم ها:** iOS

امضا:

badge?: string;

NotificationMessagePayload.body

متن متن اعلان.

**پلتفرم ها:** iOS، اندروید، وب

امضا:

body?: string;

NotificationMessagePayload.bodyLocArgs

مقادیر رشته متغیری که به جای مشخص کننده های قالب در body_loc_key استفاده می شود تا متن اصلی را به محلی سازی فعلی کاربر بومی سازی کنید.

مقدار باید یک آرایه JSON رشته ای باشد.

**iOS:** مربوط به loc-args در بارگذاری APN است. برای اطلاعات بیشتر به مرجع کلید Payload و محلی سازی محتوای اعلان های راه دور خود مراجعه کنید.

**اندروید:** برای اطلاعات بیشتر به قالب بندی و استایلینگ مراجعه کنید.

**پلتفرم ها:** iOS، Android

امضا:

bodyLocArgs?: string;

NotificationMessagePayload.bodyLocKey

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

**iOS:** مربوط به loc-key در بارگذاری APN است. برای اطلاعات بیشتر به مرجع کلید Payload و محلی سازی محتوای اعلان های راه دور خود مراجعه کنید.

**اندروید:** برای اطلاعات بیشتر به منابع رشته مراجعه کنید.

**پلتفرم ها:** iOS، Android

امضا:

bodyLocKey?: string;

NotificationMessagePayload.clickAction

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

* **پلتفرم ها:** اندروید

امضا:

clickAction?: string;

NotificationMessagePayload.color

رنگ نماد اعلان، که در قالب #rrggbb بیان شده است.

**پلتفرم ها:** اندروید

امضا:

color?: string;

نماد NotificationMessagePayload

نماد اعلان

**Android:** نماد اعلان را برای myicon منبع قابل ترسیم روی myicon تنظیم می کند . اگر این کلید را در درخواست ارسال نکنید، FCM نماد راه‌انداز مشخص‌شده در مانیفست برنامه شما را نمایش می‌دهد.

**وب:** URL مورد استفاده برای نماد اعلان.

**پلتفرم ها:** اندروید، وب

امضا:

icon?: string;

NotificationMessagePayload.sound

صدایی که وقتی دستگاه اعلان دریافت می کند پخش می شود. از «پیش‌فرض» برای صدای اعلان پیش‌فرض دستگاه یا نام فایل یک منبع صوتی همراه در برنامه پشتیبانی می‌کند. فایل های صوتی باید در /res/raw/ قرار داشته باشند .

**پلتفرم ها:** اندروید

امضا:

sound?: string;

NotificationMessagePayload.tag

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

اگر مشخص نشده باشد، هر درخواست یک اعلان جدید ایجاد می کند.

اگر مشخص شده باشد و اعلانی با همان برچسب قبلاً نشان داده شده باشد، اعلان جدید جایگزین اعلان موجود در کشوی اعلان می شود.

**پلتفرم ها:** اندروید

امضا:

tag?: string;

NotificationMessagePayload.title

عنوان اطلاعیه

**پلتفرم ها:** iOS، اندروید، وب

امضا:

title?: string;

NotificationMessagePayload.titleLocArgs

مقادیر رشته متغیری که به جای مشخص کننده های قالب در title_loc_key استفاده می شود تا متن عنوان را به محلی سازی فعلی کاربر بومی سازی کنید.

مقدار باید یک آرایه JSON رشته ای باشد.

**iOS:** مربوط به title-loc-args در بارگذاری APN است. برای اطلاعات بیشتر به مرجع کلید Payload و محلی سازی محتوای اعلان های راه دور خود مراجعه کنید.

**اندروید:** برای اطلاعات بیشتر به قالب بندی و استایلینگ مراجعه کنید.

**پلتفرم ها:** iOS، Android

امضا:

titleLocArgs?: string;

NotificationMessagePayload.titleLocKey

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

**iOS:** مربوط به title-loc-key در بارگذاری APN است. برای اطلاعات بیشتر به مرجع کلید Payload و محلی سازی محتوای اعلان های راه دور خود مراجعه کنید.

**اندروید:** برای اطلاعات بیشتر به منابع رشته مراجعه کنید.

**پلتفرم ها:** iOS، Android

امضا:

titleLocKey?: string;