chrome.notifications

refresh date: 2026-09-25 robots: noindex

شرح

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

اجازه‌ها

notifications

این اجازه هشداری را فعال می‌کند.

انواع

NotificationBitmap

NotificationButton

مشخصات

• iconUrl

  رشته اختیاری

  از Chrome 59 منسوخ شده است

  نمادهای دکمه برای کاربران Mac OS X قابل‌مشاهده نیست.

• عنوان

  رشته

NotificationItem

مشخصات

• پیام

  رشته

  جزئیات بیشتر درباره این مورد.

• عنوان

  رشته

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

NotificationOptions

مشخصات

• appIconMaskUrl

  رشته اختیاری

  از Chrome 59 منسوخ شده است

  ماسک نماد برنامه برای کاربران Mac OS X قابل‌مشاهده نیست.

  نشانی وب ماسک نماد برنامه. نشانی‌های وب همان محدودیت‌های iconUrl را دارند.

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

• دکمه‌ها

  NotificationButton[] اختیاری

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

• contextMessage

  رشته اختیاری

  محتوای اعلان جایگزین با قلمی با وزن کمتر.

• eventTime

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

  مُهر زمان مرتبط با اعلان، برحسب میلی‌ثانیه پس‌از مبدأ (مثلاً Date.now() + n).

• iconUrl

  رشته اختیاری

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

  نشانی‌های وب می‌توانند نشانی وب داده، نشانی وب blob، یا نشانی وب مربوط به منبعی در فایل crx .این افزونه باشند

  **توجه:**این مقدار برای روش notifications.create() الزامی است.

• imageUrl

  رشته اختیاری

  از Chrome 59 منسوخ شده است

  تصویر برای کاربران Mac OS X قابل‌مشاهده نیست.

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

• isClickable

  بولی اختیاری

  از Chrome 67 منسوخ شده است

  این راهنمایی میانای کاربری از Chrome 67 نادیده گرفته می‌شود

• موارد

  NotificationItem[] اختیاری

  موارد برای اعلان‌های چندموردی. کاربران Mac OS X فقط مورد اول را می‌بینند.

• پیام

  رشته اختیاری

  محتوای اصلی اعلان.

  **توجه:**این مقدار برای روش notifications.create() الزامی است.

• اولویت‌دار

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

  اولویت از ۲- تا ۲ است. ‫-۲ کمترین اولویت است. ‫۲ بالاترین است. صفر پیش‌فرض است. در پلاتفرم‌هایی که از مرکز اعلان‌ها پشتیبانی نمی‌کنند (Windows،‏ Linux، و Mac)، مقادیر ‎-2 و ‎-1 منجر به خطا می‌شوند زیرا اعلان‌های دارای این اولویت‌ها اصلاً نشان داده نخواهند شد.

• پیشرفت

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

  پیشرفت فعلی از ۰ تا ۱۰۰ متغیر است.

• requireInteraction

  بولی اختیاری

  Chrome نسخه ۵۰ و بالاتر

  نشان می‌دهد که اعلان باید تا زمانی که کاربر آن را فعال یا رد کند، روی صفحه قابل‌مشاهده باقی بماند. این مقدار به‌طور پیش‌فرض false است.

• بی‌صدا

  بولی اختیاری

  Chrome نسخه ۷۰ به بالا

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

• عنوان

  رشته اختیاری

  عنوان اعلان (مثلاً نام فرستنده برای ایمیل).

  **توجه:**این مقدار برای روش notifications.create() الزامی است.

• نوع

  TemplateType اختیاری

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

PermissionLevel

شمارشی

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

"denied"
مشخص می‌کند که کاربر انتخاب کرده است اعلان‌های برنامه یا افزونه نشان داده نشود.

TemplateType

شمارشی

«basic»
حاوی نماد، عنوان، پیام، expandedMessage، و حداکثر دو دکمه است.

«تصویر»
حاوی نماد، عنوان، پیام، expandedMessage، تصویر، و حداکثر دو دکمه است.

«فهرست»
شامل نماد، عنوان، پیام، موارد، و حداکثر دو دکمه است. کاربران Mac OS X فقط مورد اول را می‌بینند.

«پیشرفت»
شامل نماد، عنوان، پیام، پیشرفت، و حداکثر دو دکمه است.

روش‌ها

clear()

قول

chrome.notifications.clear(
  notificationId: string,
  callback?: function,
): Promise<boolean>

اعلان مشخص‌شده را پاک می‌کند.

پارامترها

• notificationId

  رشته

  شناسه اعلانی که باید پاک شود. این مقدار با روش notifications.create برگردانده می‌شود.

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (wasCleared: boolean) => void

  • wasCleared

    بولی

بازگشتی‌ها

• Promise<boolean>

  Chrome نسخه ۱۱۶ و بالاتر

  یک Promise برمی‌گرداند که برای نشان دادن اینکه آیا اعلان منطبقی وجود داشته است یا نه حل می‌شود.

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

create()

قول

chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
): Promise<string>

اعلان ایجاد و نمایش می‌دهد.

پارامترها

• notificationId

  رشته اختیاری

  شناسه اعلان. اگر تنظیم نشده یا خالی باشد، شناسه‌ای به‌طور خودکار تولید خواهد شد. اگر با اعلان موجودی مطابقت داشته باشد، این روش ابتدا آن اعلان را پاک می‌کند و سپس عملیات ایجاد را ادامه می‌دهد. شناسه نباید بیشتر از ۵۰۰ نویسه باشد.

  پارامتر notificationId قبل‌از Chrome 42 الزامی است.

• گزینه‌ها

  NotificationOptions

  محتوای اعلان.

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (notificationId: string) => void

  • notificationId

    رشته

بازگشتی‌ها

• Promise<string>

  Chrome نسخه ۱۱۶ و بالاتر

  یک Promise برمی‌گرداند که با شناسه اعلان (ارائه‌شده یا تولیدشده) که نشان‌دهنده اعلان ایجادشده است، حل می‌شود.

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getAll()

قول

chrome.notifications.getAll(
  callback?: function,
): Promise<object>

همه اعلان‌های این برنامه یا افزونه را بازیابی می‌کند.

پارامترها

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (notifications: object) => void

  • اعلان‌ها

    شیء

بازگشتی‌ها

• Promise<object>

  Chrome نسخه ۱۱۶ و بالاتر

  یک Promise برمی‌گرداند که با مجموعه notification_ids موجود در سیستم حل می‌شود.

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getPermissionLevel()

قول

chrome.notifications.getPermissionLevel(
  callback?: function,
): Promise<PermissionLevel>

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

پارامترها

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (level: PermissionLevel) => void

  • سطح

    PermissionLevel

بازگشتی‌ها

• Promise<PermissionLevel>

  Chrome نسخه ۱۱۶ و بالاتر

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

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

update()

قول

chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
): Promise<boolean>

اعلان موجود را به‌روز می‌کند.

پارامترها

• notificationId

  رشته

  شناسه اعلانی که باید به‌روز شود. این مقدار با روش notifications.create برگردانده می‌شود.

• گزینه‌ها

  NotificationOptions

  محتوای اعلان برای به‌روزرسانی.

• تماس برگشتی

  تابع اختیاری

  پارامتر callback به‌صورت زیر است:

  (wasUpdated: boolean) => void

  • wasUpdated

    بولی

بازگشتی‌ها

• Promise<boolean>

  Chrome نسخه ۱۱۶ و بالاتر

  یک Promise برمی‌گرداند که برای نشان دادن اینکه آیا اعلان منطبقی وجود داشته است یا نه حل می‌شود.

  ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

رویدادها

onButtonClicked

chrome.notifications.onButtonClicked.addListener(
  callback: function,
)

کاربر دکمه‌ای را در اعلان فشار داد.

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (notificationId: string, buttonIndex: number) => void

  • notificationId

    رشته

  • buttonIndex

    شماره

onClicked

chrome.notifications.onClicked.addListener(
  callback: function,
)

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (notificationId: string) => void

  • notificationId

    رشته

onClosed

chrome.notifications.onClosed.addListener(
  callback: function,
)

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (notificationId: string, byUser: boolean) => void

  • notificationId

    رشته

  • byUser

    بولی

onPermissionLevelChanged

chrome.notifications.onPermissionLevelChanged.addListener(
  callback: function,
)

کاربر سطح اجازه را تغییر می‌دهد. از Chrome 47، فقط ChromeOS دارای واسط کاربری است که این رویداد را ارسال می‌کند.

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (level: PermissionLevel) => void

  • سطح

    PermissionLevel

onShowSettings

از Chrome 65 منسوخ شده است

chrome.notifications.onShowSettings.addListener(
  callback: function,
)

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

کاربر روی پیوندی برای تنظیمات اعلان برنامه کلیک کرد. از Chrome 47، فقط ChromeOS دارای واسط کاربری است که این رویداد را ارسال می‌کند. از Chrome 65، آن واسط کاربر از ChromeOS نیز برداشته شده است.

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  () => void