chrome.notifications

توضیحات

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

مجوزها

notifications

انواع

NotificationBitmap

NotificationButton

خواص

  • iconUrl

    رشته اختیاری

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

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

  • عنوان

    رشته

NotificationItem

خواص

  • پیام

    رشته

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

  • عنوان

    رشته

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

NotificationOptions

خواص

  • appIconMaskUrl

    رشته اختیاری

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

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

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

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

  • دکمه ها

    NotificationButton [] اختیاری است

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

  • contextMessage

    رشته اختیاری

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

  • رویداد زمان

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

    یک مهر زمانی مرتبط با اعلان، در میلی ثانیه گذشته از دوره (مثلاً Date.now() + n ).

  • iconUrl

    رشته اختیاری

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

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

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

  • imageUrl

    رشته اختیاری

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

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

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

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

    بولی اختیاری

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

    این راهنمایی رابط کاربری در Chrome 67 نادیده گرفته شده است

  • موارد

    NotificationItem [] اختیاری است

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

  • پیام

    رشته اختیاری

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

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

  • اولویت

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

    محدوده اولویت از -2 تا 2 است. -2 کمترین اولویت است. 2 بالاترین است. صفر پیش فرض است. در پلتفرم‌هایی که از مرکز اعلان پشتیبانی نمی‌کنند (ویندوز، لینوکس و مک)، -2 و -1 با خطا مواجه می‌شوند زیرا اعلان‌هایی با آن اولویت‌ها اصلا نشان داده نمی‌شوند.

  • پیشرفت

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

    دامنه پیشرفت فعلی بین 0 تا 100 است.

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

    بولی اختیاری

    Chrome 50+

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

  • ساکت

    بولی اختیاری

    Chrome 70+

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

  • عنوان

    رشته اختیاری

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

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

  • نوع

    TemplateType اختیاری است

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

PermissionLevel

Enum

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

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

TemplateType

Enum

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

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

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

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

روش ها

clear()

قول بده
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

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

پارامترها

  • شناسه اطلاع رسانی

    رشته

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (wasCleared: boolean) => void

    • پاک شد

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 116+

    Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

create()

قول بده
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
)

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

پارامترها

  • شناسه اطلاع رسانی

    رشته اختیاری

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

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

  • محتویات اطلاعیه

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (notificationId: string) => void

    • شناسه اطلاع رسانی

      رشته

برمی گرداند

  • قول<رشته>

    Chrome 116+

    Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

getAll()

قول بده
chrome.notifications.getAll(
  callback?: function,
)

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

پارامترها

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (notifications: object) => void

    • اطلاعیه ها

      شی

برمی گرداند

  • قول<object>

    Chrome 116+

    Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

getPermissionLevel()

قول بده
chrome.notifications.getPermissionLevel(
  callback?: function,
)

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

پارامترها

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (level: PermissionLevel) => void

برمی گرداند

  • Promise< PermissionLevel >

    Chrome 116+

    Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

update()

قول بده
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
)

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

پارامترها

  • شناسه اطلاع رسانی

    رشته

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

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (wasUpdated: boolean) => void

    • به روز شد

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 116+

    Promises فقط برای Manifest V3 و نسخه‌های جدیدتر پشتیبانی می‌شود، پلتفرم‌های دیگر باید از callback استفاده کنند.

رویدادها

onButtonClicked

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

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

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

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

    • شناسه اطلاع رسانی

      رشته

    • buttonIndex

      شماره

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,
)

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

پارامترها

onShowSettings

از Chrome 65 منسوخ شده است
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

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

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

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    () => void