chrome.notifications

Description

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

Permissions

notifications

Summary

• Types

  NotificationBitmap

  NotificationButton

  NotificationItem

  NotificationOptions

  PermissionLevel

  TemplateType

• Methods

  clear

  create

  getAll

  getPermissionLevel

  update

• Events

  onButtonClicked

  onClicked

  onClosed

  onPermissionLevelChanged

  onShowSettings

Types

NotificationBitmap

NotificationButton

PROPERTIES

• iconUrl

  string optional

  Deprecated since Chrome 59

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

• title

  string

NotificationItem

PROPERTIES

• message

  string

  有关此项目的其他详细信息。

• title

  string

  列表通知的一项的标题。

NotificationOptions

PROPERTIES

• appIconMaskUrl

  string optional

  Deprecated since Chrome 59

  Mac OS X 用户看不到应用程序图标蒙版。

  应用程序图标掩码的 URL。 URL 与 iconUrl 具有相同的限制。

  应用程序图标蒙版应该在 alpha 通道中，因为只会考虑图像的 alpha 通道。

• buttons

  NotificationButton[] optional

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

• contextMessage

  string optional

  具有较轻字体的替代通知内容。

• eventTime

  number optional

  与通知关联的时间戳，以纪元后的毫秒数为单位（例如 Date.now() + n）。

• iconUrl

  string optional

  发件人头像、应用程序图标或图像通知缩略图的 URL。

  URL 可以是数据 URL、blob URL 或与此扩展的 .crx 文件中的资源相关的 URL，notifications.create 方法是必需的。

• imageUrl

  string optional

  Deprecated since Chrome 59

  Mac OS X 用户看不到该图像。

  图像类型通知的图像缩略图的 URL。 URL 与 iconUrl 具有相同的限制。

• isClickable

  boolean optional

  Deprecated since Chrome 67

  从 Chrome 67 开始，此 UI 提示将被忽略

• items

  NotificationItem[] optional

  多项目通知的项目。 Mac OS X 上的用户只能看到第一项。

• message

  string optional

  主要通知内容。 notifications.create 方法是必需的。

• priority

  number optional

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

• progress

  number optional

  当前进度范围为 0 到 100。

• requireInteraction

  boolean optional

  Chrome 50+

  指示通知应在屏幕上保持可见，直到用户激活或关闭通知。这默认为 false。

• silent

  boolean optional

  Chrome 70+

  表示在显示通知时不应发出声音或振动。这默认为 false。

• title

  string optional

  通知的标题（例如电子邮件的发件人姓名）。 notifications.create 方法是必需的。

• type

  TemplateType optional

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

PermissionLevel

TYPE

"granted", or "denied"

TemplateType

TYPE

"basic", "image", "list", or "progress"

Methods

clear

chrome.notifications.clear(
  notificationId: string,
  callback?: function,
)

清除指定的通知。

PARAMETERS

• notificationId

  string

  要清除的通知的 id。这是由notifications.create 方法返回的。

• callback

  function optional

  The callback parameter looks like:

  (wasCleared: boolean) => void

  • wasCleared

    boolean

create

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

创建并显示通知。

PARAMETERS

• notificationId

  string optional

  通知的标识符。如果未设置或为空，将自动生成一个 ID。如果它与现有通知匹配，则此方法在继续创建操作之前首先清除该通知。标识符不得超过 500 个字符。

  Chrome 42 之前需要notificationId 参数。

• options

  NotificationOptions

  通知内容。

• callback

  function optional

  The callback parameter looks like:

  (notificationId: string) => void

  • notificationId

    string

getAll

chrome.notifications.getAll(
  callback: function,
)

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

PARAMETERS

• callback

  function

  The callback parameter looks like:

  (notifications: object) => void

  • notifications

    object

getPermissionLevel

chrome.notifications.getPermissionLevel(
  callback: function,
)

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

PARAMETERS

• callback

  function

  The callback parameter looks like:

  (level: PermissionLevel) => void

  • level

    PermissionLevel

update

chrome.notifications.update( notificationId: string, options: NotificationOptions, callback?: function, )

更新现有通知。

PARAMETERS

• notificationId

  string

  要更新的通知的 id。这是由notifications.create 方法返回的。

• options

  NotificationOptions

  要更新到的通知的内容。

• callback

  function optional

  The callback parameter looks like:

  (wasUpdated: boolean) => void

  • wasUpdated

    boolean

Events

onButtonClicked

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

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

PARAMETERS

• callback

  function

  The callback parameter looks like:

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

  • notificationId

    string

  • buttonIndex

    number

onClicked

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

用户单击了通知的非按钮区域。

PARAMETERS

• callback

  function

  The callback parameter looks like:

  (notificationId: string) => void

  • notificationId

    string

onClosed

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

通过系统或用户操作关闭通知。

PARAMETERS

• callback

  function

  The callback parameter looks like:

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

  • notificationId

    string

  • byUser

    boolean

onPermissionLevelChanged

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

用户更改权限级别。从 Chrome 47 开始，只有 ChromeOS 具有调度此事件的 UI。

PARAMETERS

• callback

  function

  The callback parameter looks like:

  (level: PermissionLevel) => void

  • level

    PermissionLevel

onShowSettings

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

Deprecated since Chrome 65

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

用户单击了应用程序通知设置的链接。从 Chrome 47 开始，只有 ChromeOS 具有调度此事件的 UI。从 Chrome 65 开始，该 UI 也已从 ChromeOS 中删除。

PARAMETERS

• callback

  function

  The callback parameter looks like:

  () => void

By.一粒技术服务.