chrome.notifications

תיאור

אפשר להשתמש ב-API של chrome.notifications כדי ליצור התראות עשירות באמצעות תבניות ולהציג את ההתראות האלה למשתמשים במגש המערכת.

הרשאות

notifications

סוגים

NotificationBitmap

NotificationButton

מאפיינים

  • iconUrl

    מחרוזת אופציונלי

    הוצא משימוש מאז Chrome 59

    סמלי לחצנים לא גלויים למשתמשי Mac OS X.

  • title

    מחרוזת

NotificationItem

מאפיינים

  • הודעה

    מחרוזת

    פרטים נוספים על הפריט הזה.

  • title

    מחרוזת

    השם של פריט אחד בהודעה ברשימה.

NotificationOptions

מאפיינים

  • appIconMaskUrl

    מחרוזת אופציונלי

    הוצא משימוש מאז Chrome 59

    המסכה של סמל האפליקציה לא גלויה למשתמשי Mac OS X.

    כתובת URL למסכה של סמל האפליקציה. על כתובות URL חלות אותן הגבלות כמו iconUrl.

    המסכה של סמל האפליקציה צריכה להיות בערוץ אלפא, כי המערכת תתייחס רק לערוץ האלפא של התמונה.

  • לחצנים

    NotificationButton[] אופציונלי

    טקסט וסמלים בשביל עד שני לחצני פעולה של התראות.

  • contextMessage

    מחרוזת אופציונלי

    החלפת תוכן ההתראה בגופן קטן יותר.

  • eventTime

    מספר אופציונלי

    חותמת זמן שמשויכת להתראה, באלפיות השנייה אחרי תחילת התקופה (למשל Date.now() + n).

  • iconUrl

    מחרוזת אופציונלי

    כתובת URL של הדמות של השולח, סמל האפליקציה או תמונה ממוזערת של התראות על תמונות.

    כתובות ה-URL יכולות להיות כתובת URL של נתונים, כתובת URL של blob או כתובת URL ביחס למשאב בקובץ ה- .crx של התוסף הזה

    **הערה:**הערך הזה נדרש לשיטה notifications.create().

  • imageUrl

    מחרוזת אופציונלי

    הוצא משימוש מאז Chrome 59

    התמונה אינה גלויה למשתמשי Mac OS X.

    כתובת URL של התמונה הממוזערת להתראות מסוג תמונה. על כתובות URL חלות אותן הגבלות כמו iconUrl.

  • isClickable

    ערך בוליאני אופציונלי

    הוצא משימוש מאז Chrome 67

    החל מגרסה 67 של Chrome, המערכת מתעלמת מהרמז הזה של ממשק המשתמש

  • פריטים

    NotificationItem[] אופציונלי

    פריטים להתראות על כמה פריטים. משתמשים ב-Mac OS X רואים רק את הפריט הראשון.

  • הודעה

    מחרוזת אופציונלי

    התוכן העיקרי של ההתראות.

    **הערה:**הערך הזה נדרש לשיטה notifications.create().

  • הקמפיין

    מספר אופציונלי

    רמת העדיפות נעה בין 2- ל-2. העדיפות הנמוכה ביותר היא 2-. הערך 2 הוא הגבוה ביותר. ברירת המחדל היא אפס. בפלטפורמות שלא תומכות במרכז התראות (Windows, Linux ו-Mac), הערכים -2 ו-1 גורמים לשגיאה, כי התראות עם העדיפויות האלה לא יוצגו בכלל.

  • התקדמות

    מספר אופציונלי

    ההתקדמות הנוכחית נעה בין 0 ל-100.

  • requireInteraction

    ערך בוליאני אופציונלי

    Chrome 50+

    מציין שההתראה תישאר גלויה במסך עד שהמשתמש יפעיל או יסגור את ההתראה. ערך ברירת המחדל הוא False.

  • שקט

    ערך בוליאני אופציונלי

    Chrome 70+

    מציין שלא יושמעו צלילים או רטט כשההתראה מוצגת. ערך ברירת המחדל הוא False.

  • title

    מחרוזת אופציונלי

    כותרת ההתראה (למשל, שם השולח של הודעת אימייל).

    **הערה:**הערך הזה נדרש לשיטה notifications.create().

  • סוג

    TemplateType אופציונלי

    איזה סוג של התראה להציג. חובה ל-method notifications.create.

PermissionLevel

Enum

'אושר'
המציין שהמשתמש בחר להציג התראות מהאפליקציה או מהתוסף. זוהי ברירת המחדל בזמן ההתקנה.

'נדחתה'
המציין שהמשתמש בחר לא להציג התראות מהאפליקציה או מהתוסף.

TemplateType

Enum

"בסיסי"
מכיל סמל, כותרת, הודעה,ExpandMessage ועד שני לחצנים.

"image"
מכיל סמל, כותרת, הודעה,ExpandMessage, תמונה ועד שני לחצנים.

"רשימה"
מכיל סמל, כותרת, הודעה, פריטים ועד שני לחצנים. משתמשים ב-Mac OS X רואים רק את הפריט הראשון.

"התקדמות"
מכיל סמל, כותרת, הודעה, התקדמות, ועד שני לחצנים.

שיטות

clear()

הבטחה 
chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

ניקוי ההתראה שצוינה

פרמטרים

  • notificationId

    מחרוזת

    המזהה של ההתראה שרוצים להסיר. הערך הזה מוחזר באמצעות השיטה notifications.create.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (wasCleared: boolean) => void

    • wasCleared

      בוליאני

החזרות

  • Promise<boolean>

    Chrome 116 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

create()

הבטחה 
chrome.notifications.create(
  notificationId?: string,
  options: NotificationOptions,
  callback?: function,
)

יוצר ומציג התראה.

פרמטרים

  • notificationId

    מחרוזת אופציונלי

    המזהה של ההתראה. אם השדה לא מוגדר או ריק, המערכת תיצור מזהה באופן אוטומטי. אם היא תואמת להודעה קיימת, השיטה הזו מוחקת קודם את ההתראה הזו לפני שממשיכים בפעולת היצירה. המזהה צריך להיות קצר מ-500 תווים.

    הפרמטר notificationId נדרש לפני Chrome 42.

  • אפשרויות

    NotificationOptions

    תוכן ההתראה.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (notificationId: string) => void

    • notificationId

      מחרוזת

החזרות

  • Promise<string>

    Chrome 116 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

getAll()

הבטחה 
chrome.notifications.getAll(
  callback?: function,
)

אחזור כל ההתראות של האפליקציה או התוסף.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (notifications: object) => void

    • התראות

      אובייקט

החזרות

  • Promise<object>

    Chrome 116 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

getPermissionLevel()

הבטחה 
chrome.notifications.getPermissionLevel(
  callback?: function,
)

אחזור אם המשתמש הפעיל התראות מהאפליקציה הזו או מהתוסף הזה.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (level: PermissionLevel) => void

החזרות

  • Promise<PermissionLevel>

    Chrome 116 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

update()

הבטחה 
chrome.notifications.update(
  notificationId: string,
  options: NotificationOptions,
  callback?: function,
)

מעדכן התראה קיימת.

פרמטרים

  • notificationId

    מחרוזת

    המזהה של ההתראה שצריך לעדכן. הערך הזה מוחזר באמצעות השיטה notifications.create.

  • אפשרויות

    NotificationOptions

    תוכן ההתראה שאליו יש לעדכן.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (wasUpdated: boolean) => void

    • wasUpdated

      בוליאני

החזרות

  • Promise<boolean>

    Chrome 116 ואילך

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה הזו מצליחה לפתור את הבעיה באותו סוג שמועבר לקריאה החוזרת.

אירועים

onButtonClicked

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

המשתמש לחץ על לחצן בהתראה.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

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

    • notificationId

      מחרוזת

    • buttonIndex

      number

onClicked

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

המשתמש לחץ באזור שלא כולל לחצנים בהתראה.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    (notificationId: string) => void

    • notificationId

      מחרוזת

onClosed

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

ההתראה נסגרה, על ידי המערכת או על ידי פעולת משתמש.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

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

    • notificationId

      מחרוזת

    • byUser

      בוליאני

onPermissionLevelChanged

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

המשתמש משנה את רמת ההרשאה. החל מגרסה 47 של Chrome, רק ב-ChromeOS יש ממשק משתמש ששולח את האירוע הזה.

פרמטרים

onShowSettings

הוצא משימוש מאז Chrome 65
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

הלחצן של הגדרת ההתראות בהתאמה אישית לא נתמך יותר.

המשתמש לחץ על קישור להגדרת ההתראות של האפליקציה. החל מגרסה 47 של Chrome, רק ב-ChromeOS יש ממשק משתמש ששולח את האירוע הזה. החל מגרסה 65 של Chrome, ממשק המשתמש הזה הוסר גם מ-ChromeOS.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

    הפרמטר callback נראה כך: 

    () => void