chrome.notifications

توضیحات

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

مجوزها

notifications

انواع

NotificationBitmap

NotificationButton

خواص

• آیکون‌آرل

  رشته اختیاری

  از کروم ۵۹ منسوخ شده است

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

• عنوان

  رشته

NotificationItem

خواص

• پیام

  رشته

  توضیحات تکمیلی در مورد این کالا.

• عنوان

  رشته

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

NotificationOptions

خواص

• appIconMaskUrl

  رشته اختیاری

  از کروم ۵۹ منسوخ شده است

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

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

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

• دکمه‌ها

  دکمه اعلان [] اختیاری

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

• متن پیام

  رشته اختیاری

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

• رویدادزمان

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

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

• آیکون‌آرل

  رشته اختیاری

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

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

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

• آدرس تصویر

  رشته اختیاری

  از کروم ۵۹ منسوخ شده است

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

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

• قابل کلیک است

  بولی اختیاری

  از زمان کروم ۶۷ منسوخ شده است

  این نکته رابط کاربری از کروم ۶۷ نادیده گرفته می‌شود

• اقلام

  NotificationItem [] اختیاری

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

• پیام

  رشته اختیاری

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

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

• اولویت

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

  اولویت از -۲ تا ۲ متغیر است. -۲ کمترین اولویت را دارد. ۲ بالاترین اولویت را دارد. صفر پیش‌فرض است. در پلتفرم‌هایی که از مرکز اعلان‌ها پشتیبانی نمی‌کنند (ویندوز، لینوکس و مک)، -۲ و -۱ منجر به خطا می‌شوند زیرا اعلان‌هایی با این اولویت‌ها اصلاً نمایش داده نمی‌شوند.

• پیشرفت

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

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

• نیاز به تعامل

  بولی اختیاری

  کروم ۵۰+

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

• ساکت

  بولی اختیاری

  کروم ۷۰+

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

• عنوان

  رشته اختیاری

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

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

• نوع

  نوع الگو اختیاری

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

PermissionLevel

شمارشی

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

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

TemplateType

شمارشی

"اساسی"
شامل یک آیکون، عنوان، پیام، پیام گسترش‌یافته و حداکثر دو دکمه است.

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

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

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

روش‌ها

clear()

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

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

پارامترها

• شناسه اعلان

  رشته

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

بازگشت‌ها

• قول <boolean>

  کروم ۱۱۶+

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

create()

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

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

پارامترها

• شناسه اعلان

  رشته اختیاری

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

  پارامتر notificationId قبل از کروم ۴۲ الزامی است.

• گزینه‌ها

  گزینه‌های اعلان

  مفاد اطلاعیه.

بازگشت‌ها

• قول<string>

  کروم ۱۱۶+

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

getAll()

chrome.notifications.getAll(): Promise<object>

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

بازگشت‌ها

• قول دادن<object>

  کروم ۱۱۶+

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

getPermissionLevel()

chrome.notifications.getPermissionLevel(): Promise<PermissionLevel>

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

بازگشت‌ها

• قول < سطح دسترسی >

  کروم ۱۱۶+

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

update()

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

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

پارامترها

• شناسه اعلان

  رشته

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

• گزینه‌ها

  گزینه‌های اعلان

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

بازگشت‌ها

• قول <boolean>

  کروم ۱۱۶+

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

رویدادها

onButtonClicked

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

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

پارامترها

• تماس برگشتی

  تابع

  پارامتر callback به شکل زیر است:

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

  • شناسه اعلان

    رشته

  • دکمه فهرست

    شماره

onClicked

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

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

پارامترها

• تماس برگشتی

  تابع

  پارامتر callback به شکل زیر است:

  (notificationId: string) => void

  • شناسه اعلان

    رشته

onClosed

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

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

پارامترها

• تماس برگشتی

  تابع

  پارامتر callback به شکل زیر است:

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

  • شناسه اعلان

    رشته

  • توسط کاربر

    بولی

onPermissionLevelChanged

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

کاربر سطح مجوز را تغییر می‌دهد. از کروم ۴۷ به بعد، فقط کروم‌او‌اس رابط کاربری دارد که این رویداد را ارسال می‌کند.

پارامترها

• تماس برگشتی

  تابع

  پارامتر callback به شکل زیر است:

  (level: PermissionLevel) => void

  • سطح

    سطح دسترسی

onShowSettings

از زمان کروم ۶۵ منسوخ شده است

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

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

کاربر روی لینکی برای تنظیمات اعلان برنامه کلیک کرد. از کروم ۴۷، فقط کروم‌او‌اس رابط کاربری دارد که این رویداد را ارسال می‌کند. از کروم ۶۵، آن رابط کاربری از کروم‌او‌اس نیز حذف شده است.

پارامترها

• تماس برگشتی

  تابع

  پارامتر callback به شکل زیر است:

  () => void