chrome.alarms
Description
使用 chrome.alarms API 安排代码定期运行或在未来的指定时间运行。
Permissions
alarms
Summary
Types
Methods
Events
Types
Alarm
PROPERTIES
name
string
此警报的名称。
periodInMinutes
number optional
如果不为空，则警报是重复警报，并将在 periodInMinutes 分钟内再次触发。
scheduledTime
number
计划触发此警报的时间，以纪元后的毫秒数为单位（例如 Date.now() + n）。出于性能原因，警报可能已延迟任意超出此范围。
AlarmCreateInfo
PROPERTIES
delayInMinutes
number optional
onAlarm 事件应触发的时间长度（以分钟为单位）。
periodInMinutes
number optional
如果设置，则 onAlarm 事件应在 when 或 delayInMinutes 指定的初始事件之后每隔 periodInMinutes 分钟触发。如果未设置，警报将只触发一次。
when
number optional
警报应触发的时间，以纪元后的毫秒数为单位（例如 Date.now() + n）。
Methods
clear
chrome.alarms.clear(
name?: string,
callback?: function,
)Promise
清除给定名称的警报。
PARAMETERS
name
string optional
要清除的警报的名称。默认为空字符串。
callback
function optional
callback参数如下所示：
(wasCleared: boolean) => voidwasCleared
boolean
RETURNS
Promise<boolean>
Pending
这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。
clearAll
chrome.alarms.clearAll(
callback?: function,
)Promise
清除所有警报。
PARAMETERS
callback
function optional
callback参数如下所示:
(wasCleared: boolean) => voidwasCleared
boolean
RETURNS
Promise<boolean>
Pending
这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。
create
chrome.alarms.create( name?: string, alarmInfo: AlarmCreateInfo, )
创建警报。在由 alarmInfo 指定的时间附近，触发 onAlarm 事件。如果有另一个同名的警报（如果没有指定则没有名称），它将被取消并由该警报代替。
为了减少用户机器上的负载，Chrome 将警报限制为最多每 1 分钟一次，但可能会延迟更多。也就是说，将 delayInMinutes 或 periodInMinutes 设置为小于 1 将不会得到遵守并会导致警告。 when 可以设置为“now”之后不到 1 分钟而没有警告，但实际上不会导致警报触发至少 1 分钟。
为了帮助您调试应用程序或扩展程序，当您将其解压加载时，警报触发的频率没有限制。
PARAMETERS
name
string optional
用于标识此警报的可选名称。默认为空字符串。
alarmInfo
描述何时应该触发警报。初始时间必须由 when 或 delayInMinutes （但不能同时由两者）指定。如果设置了 periodInMinutes，警报将在初始事件后每 periodInMinutes 分钟重复一次。如果没有为重复警报设置 when 或 delayInMinutes，则使用 periodInMinutes 作为delayInMinutes 的默认值。
get
chrome.alarms.get(
name?: string,
callback?: function,
)Promise
检索有关指定警报的详细信息。
PARAMETERS
name
string optional
要获取的警报的名称。默认为空字符串。
callback
function optional
callback参数如下所示：
(alarm?: Alarm) => void
alarm
Alarm optional
RETURNS
Promise<Alarm | undefined>
Pending
这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。
getAll
chrome.alarms.getAll(
callback?: function,
)Promise
获取所有警报的数组。
PARAMETERS
callback
function optional
callback参数如下所示：
(alarms: Alarm[]) => void
alarms
Alarm[]
RETURNS
Promise<Alarm[]>
Pending
这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。
Events
onAlarm
chrome.alarms.onAlarm.addListener( callback: function, )
当闹钟过去时触发。对事件页面有用。
PARAMETERS
callback
function
callback参数如下所示：
(alarm: Alarm) => void
alarm
Alarm
By.一粒技术服务