AndroidNotification interface

نشان دهنده گزینه های اعلان مخصوص Android است که می توانند در AndroidConfig گنجانده شوند .

امضا:

export interface AndroidNotification 

خواص

AndroidNotification.body

متن اعلان اندروید. وقتی ارائه شد، مجموعه بدنه را از طریق admin.messaging.Notification لغو می‌کند .

امضا:

body?: string;

AndroidNotification.bodyLocArgs

آرایه ای از کلیدهای منبع که به جای تعیین کننده های قالب در bodyLocKey استفاده می شود .

امضا:

bodyLocArgs?: string[];

AndroidNotification.bodyLocKey

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

امضا:

bodyLocKey?: string;

AndroidNotification.channelId

شناسه کانال اعلان اندروید (جدید در Android O). قبل از دریافت هرگونه اعلان با این شناسه کانال، برنامه باید کانالی با این شناسه کانال ایجاد کند. اگر این شناسه کانال را در درخواست ارسال نکنید، یا اگر شناسه کانال ارائه‌شده هنوز توسط برنامه ایجاد نشده باشد، FCM از شناسه کانال مشخص‌شده در مانیفست برنامه استفاده می‌کند.

امضا:

channelId?: string;

AndroidNotification.clickAction

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

امضا:

clickAction?: string;

AndroidNotification.color

رنگ نماد اعلان در قالب #rrggbb .

امضا:

color?: string;

AndroidNotification.defaultLightSettings

اگر روی true تنظیم شود ، از تنظیمات نور LED پیش فرض چارچوب Android برای اعلان استفاده کنید. مقادیر پیش فرض در config.xml مشخص شده است . اگر default_light_settings روی true و light_settings نیز تنظیم شده باشد، به جای مقدار پیش فرض light_settings تعیین شده توسط کاربر استفاده می شود.

امضا:

defaultLightSettings?: boolean;

AndroidNotification.defaultSound

اگر روی true تنظیم شود ، از صدای پیش فرض فریمورک اندروید برای اعلان استفاده کنید. مقادیر پیش فرض در config.xml مشخص شده است .

امضا:

defaultSound?: boolean;

AndroidNotification.defaultVibrateTimings

اگر روی true تنظیم شود ، از الگوی ارتعاشی پیش‌فرض چارچوب Android برای اعلان استفاده کنید. مقادیر پیش فرض در config.xml مشخص شده است . اگر default_vibrate_timings روی true و vibrate_timings نیز تنظیم شده باشد، مقدار پیش‌فرض به جای vibrate_timings تعیین‌شده توسط کاربر استفاده می‌شود. .

امضا:

defaultVibrateTimings?: boolean;

AndroidNotification.eventTimestamp

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

امضا:

eventTimestamp?: Date;

نماد AndroidNotification

منبع آیکون برای اعلان اندروید.

امضا:

icon?: string;

AndroidNotification.imageUrl

URL تصویری که در اعلان نمایش داده می شود.

امضا:

imageUrl?: string;

AndroidNotification.lightSettings

تنظیمات برای کنترل میزان چشمک زدن و رنگ LED اعلان در صورت موجود بودن LED در دستگاه. کل زمان چشمک زدن توسط سیستم عامل کنترل می شود.

امضا:

lightSettings?: LightSettings;

AndroidNotification.localOnly

تنظیم می کند که آیا این اعلان فقط مربوط به دستگاه فعلی باشد یا خیر. برخی از اعلان ها را می توان برای نمایش از راه دور به دستگاه های دیگر مانند ساعت Wear OS پل زد. این راهنمایی را می توان به گونه ای تنظیم کرد که توصیه کند این اعلان پل زده نشود. به راهنمای Wear OS مراجعه کنید .

امضا:

localOnly?: boolean;

AndroidNotification.notificationCount

تعداد مواردی که این اعلان نشان می دهد را تنظیم می کند. ممکن است به عنوان یک تعداد نشان برای راه‌اندازهایی که از نشان پشتیبانی می‌کنند نمایش داده شود. NotificationBadge را ببینید . به عنوان مثال، اگر فقط از یک اعلان برای نمایش چندین پیام جدید استفاده می‌کنید، این ممکن است مفید باشد، اما می‌خواهید تعداد کل پیام‌های جدید را نشان دهد. اگر صفر یا نامشخص باشد، سیستم‌هایی که از نشان پشتیبانی می‌کنند از پیش‌فرض استفاده می‌کنند، که عبارت است از افزایش عددی که در منوی فشار طولانی هر بار که اعلان جدیدی می‌رسد، نمایش داده می‌شود.

امضا:

notificationCount?: number;

AndroidNotification.priority

اولویت نسبی را برای این اعلان تنظیم می کند. اعلان‌های با اولویت پایین ممکن است در شرایط خاصی از کاربر پنهان شوند. توجه داشته باشید که این اولویت با AndroidMessagePriority متفاوت است . این اولویت پس از تحویل پیام توسط مشتری پردازش می شود. در حالی که AndroidMessagePriority یک مفهوم FCM است که زمان تحویل پیام را کنترل می کند.

امضا:

priority?: ('min' | 'low' | 'default' | 'high' | 'max');

AndroidNotification.sound

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

امضا:

sound?: string;

AndroidNotification.sticky

وقتی روی false یا تنظیم نشده تنظیم شود، وقتی کاربر روی آن در پانل کلیک می کند، اعلان به طور خودکار حذف می شود. وقتی روی true تنظیم شود ، اعلان حتی زمانی که کاربر روی آن کلیک می کند ادامه دارد.

امضا:

sticky?: boolean;

AndroidNotification.tag

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

امضا:

tag?: string;

AndroidNotification.ticker

متن "ticker" را تنظیم می کند که به سرویس های دسترسی ارسال می شود. قبل از سطح API 21 (Lollipop)، متنی را تنظیم می‌کند که در اولین بار رسیدن اعلان در نوار وضعیت نمایش داده شود.

امضا:

ticker?: string;

AndroidNotification.title

عنوان اعلان اندروید. در صورت ارائه، عنوان مجموعه از طریق admin.messaging.Notification را لغو می کند .

امضا:

title?: string;

AndroidNotification.titleLocArgs

آرایه ای از کلیدهای منبع که به جای تعیین کننده های قالب در titleLocKey استفاده می شود .

امضا:

titleLocArgs?: string[];

AndroidNotification.titleLocKey

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

امضا:

titleLocKey?: string;

AndroidNotification.vibrateTimingsMillis

الگوی ارتعاش را برای استفاده تنظیم می کند. برای روشن یا خاموش کردن ویبراتور، آرایه ای از میلی ثانیه را رد کنید. اولین مقدار مدت زمان انتظار قبل از روشن کردن ویبراتور را نشان می دهد. مقدار بعدی مدت زمان روشن نگه داشتن ویبراتور را نشان می دهد. مقادیر بعدی بین مدت زمان برای خاموش کردن ویبراتور و روشن کردن ویبراتور متناوب می شود. اگر vibrate_timings و default_vibrate_timings روی true تنظیم شده باشد ، مقدار پیش فرض به جای vibrate_timings تعیین شده توسط کاربر استفاده می شود .

امضا:

vibrateTimingsMillis?: number[];

AndroidNotification.visibility

نمایان بودن اعلان را تنظیم می کند. یا باید private باشه ، public ، یا secret . اگر مشخص نشده باشد، پیش‌فرض روی private است .

امضا:

visibility?: ('private' | 'public' | 'secret');