chrome.notifications

描述 使用 chrome.notifications API 通过模板创建丰富通知,并在系统托盘中向用户显示这些通知。
可用版本 从 Chrome 28 开始支持。
权限 "notifications"

摘要

类型
TemplateType
PermissionLevel
NotificationOptions
方法
create chrome.notifications.create(string notificationId, NotificationOptions options, function callback)
clear chrome.notifications.clear(string notificationId, function callback)
getAll chrome.notifications.getAll(function callback)
getPermissionLevel chrome.notifications.getPermissionLevel(function callback)
事件
onClosed
onClicked

类型

TemplateType

枚举
"basic"

PermissionLevel

从 Chrome 32 开始支持。

枚举
"granted"

NotificationOptions

属性
TemplateType type

要显示哪种类型的通知,调用 notifications.create 方法时必须指定

string iconUrl

发送方的图标、应用图标或图片通知的缩略图 URL。

URL 可以为 data URL、blob URL 或相对于应用 .crx 文件中的资源的 URL。调用 notifications.create 方法时必须指定

string title

通知标题(例如邮件发送者的姓名),调用 notifications.create 方法时必须指定

string message

通知的主要内容,调用 notifications.create 方法时必须指定

方法

create

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

创建并显示通知。

参数
string notificationId

通知的标识符。如果为空,该方法会生成一个标识符。如果匹配已有的标识符,该方法在创建操作之前会首先清除这一通知。

NotificationOptions options

通知内容。

function callback

返回通知标识符(提供的或生成的),代表创建的通知。

callback 参数应该是一个如下形式的函数:

function(string notificationId) {...};
string notificationId

更新已有的通知。

参数
string notificationId

要更新的通知标识符,由 notifications.create 方法返回。

NotificationOptions options

更新后的通知内容。

function callback

调用时指示是否存在匹配的通知。

callback 参数应该是一个如下形式的函数:

function(boolean wasUpdated) {...};
boolean wasUpdated

clear

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

清除指定的通知。

参数
string notificationId

要清除的通知标识符,由 notifications.create 方法返回。

function callback

调用时指示是否存在匹配的通知。

callback 参数应该是一个如下形式的函数:

function(boolean wasCleared) {...};
boolean wasCleared

getAll

chrome.notifications.getAll(function callback)

从 Chrome 29 开始支持。

获取所有通知。

参数
function callback

返回系统中当前所有通知标识符。

callback 参数应该是一个如下形式的函数:

function(object notifications) {...};
object notifications

getPermissionLevel

chrome.notifications.getPermissionLevel(function callback)

从 Chrome 32 开始支持。

获取用户是否为当前应用或应用启用通知。

参数
function callback

返回当前的权限级别。

callback 参数应该是一个如下形式的函数:

function( PermissionLevel level) {...};
PermissionLevel level

事件

onClosed

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

addListener

chrome.notifications.onClosed.addListener(function callback)
参数
function callback

callback 参数应该是一个如下形式的函数:

function(string notificationId, boolean byUser) {...};
string notificationId
boolean byUser

onClicked

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

addListener

chrome.notifications.onClicked.addListener(function callback)
参数
function callback

callback 参数应该是一个如下形式的函数:

function(string notificationId) {...};
string notificationId