chrome.notifications

说明

使用 chrome.notifications API 通过模板创建丰富通知，并在系统托盘中向用户显示这些通知。

权限

notifications

类型

NotificationBitmap

NotificationButton

属性

  • iconUrl

    字符串（选填）

    自 Chrome 59 起已弃用

    Mac OS X 用户看不到按钮图标。

  • title

    字符串

NotificationItem

属性

  • 私信

    字符串

    有关此商品的更多详细信息。

  • title

    字符串

    列表通知中某个项目的标题。

NotificationOptions

属性

  • appIconMaskUrl

    字符串（选填）

    自 Chrome 59 起已弃用

    应用图标遮罩不会向 Mac OS X 用户显示。

    应用图标遮罩的网址。网址的限制与 iconUrl 相同。

    应用图标遮罩应位于 Alpha 渠道中，因为系统只会考虑图片的 Alpha 渠道。

  • 按钮

    NotificationButton[] 可选

    最多两个通知操作按钮的文字和图标。

  • contextMessage

    字符串（选填）

    使用较低字重的字体显示替代通知内容。

  • eventTime

    number 可选

    与通知关联的时间戳，以自纪元以来经过的毫秒数表示（例如 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() 方法需要此值。

  • 优先级

    number 可选

    优先级范围为 -2 到 2。-2 是最低优先级。2 为最高值。默认值为零。在不支持通知中心的平台（Windows、Linux 和 Mac）上，-2 和 -1 会导致错误，因为具有这些优先级的通知根本不会显示。

  • 进度

    number 可选

    当前进度范围为 0 到 100。

  • requireInteraction

    布尔值（可选）

    Chrome 50 及更高版本

    表示通知应一直显示在屏幕上，直到用户激活或关闭通知。此属性的默认值为 false。

  • 静音

    布尔值（可选）

    Chrome 70 及更高版本

    表示在显示通知时不应发出任何声音或振动。此属性的默认值为 false。

  • title

    字符串（选填）

    通知的标题（例如电子邮件的发件人姓名）。

    **注意：**notifications.create() 方法需要此值。

  • 类型

    TemplateType 可选

    要显示的通知类型。notifications.create 方法的必需参数。

PermissionLevel

枚举

“granted”
指定用户已选择显示来自应用或扩展程序的通知。这是安装时的默认设置。

“拒绝”
指定用户已选择不显示来自应用或扩展程序的通知。

TemplateType

枚举

“基本”
包含图标、标题、消息、expandedMessage 和最多两个按钮。

“image”
包含一个图标、标题、消息、expandedMessage、图片和最多两个按钮。

“list”
包含图标、标题、消息、项和最多两个按钮。Mac OS X 用户只能看到第一项。

“progress”
包含图标、标题、消息、进度和最多两个按钮。

方法

clear()

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

清除指定通知。

参数

返回

  • Promise<boolean>

    Chrome 116 及更高版本

create()

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

创建并显示通知。

参数

  • notificationId

    字符串（选填）

    通知的标识符。如果未设置或为空，系统会自动生成 ID。如果与现有通知匹配，此方法会先清除该通知，然后再继续执行创建操作。标识符的长度不得超过 500 个字符。

    在 Chrome 42 之前，notificationId 参数是必需的。

  • 通知的内容。

返回

  • Promise<string>

    Chrome 116 及更高版本

getAll()

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

检索相应应用或扩展程序的所有通知。

返回

  • Promise<object>

    Chrome 116 及更高版本

getPermissionLevel()

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

检索用户是否已启用来自相应应用或扩展程序的通知。

返回

update()

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

更新现有通知。

参数

返回

  • Promise<boolean>

    Chrome 116 及更高版本

事件

onButtonClicked

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

用户按下了通知中的按钮。

参数

  • callback

    函数

    callback 参数如下所示： 

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

    • notificationId

      字符串

    • buttonIndex

      数值

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

用户更改了权限级别。自 Chrome 47 起，只有 ChromeOS 具有可调度此事件的界面。

参数

onShowSettings

自 Chrome 65 起已弃用
chrome.notifications.onShowSettings.addListener(
  callback: function,
)

自定义通知设置按钮不再受支持。

用户点击了应用通知设置的链接。自 Chrome 47 起，只有 ChromeOS 具有可调度此事件的界面。自 Chrome 65 起，该界面也已从 ChromeOS 中移除。

参数

  • callback

    函数

    callback 参数如下所示： 

    () => void