setLaunchAppTimeout
API_LEVEL
2.0
开始支持,API 兼容性请参考 API_LEVEL。
注册一个定时器,定时唤起小程序,在此期间如果设备重启,则定时器会失效。
类型
function setLaunchAppTimeout(option: Option): Result
参数
Option
属性 | 类型 | 必填 | 默认值 | 说明 | API_LEVEL |
---|---|---|---|---|---|
appId | number | 是 | - | 小程序 ID | 2.0 |
url | string | 是 | - | 页面路径 | 2.0 |
utc | number | 否 | - | utc 时间戳(毫秒),优先级高于 delay ,当与 delay 字段同时设置的 时候,只有 utc 字段生效 | 2.0 |
delay | number | 否 | 0 | 等待时间(毫秒) | 3.0 |
params | string|object | 否 | - | 传递给 app.js 生命周期 onCreate 中的参数,支持字符串或者标准 JSON 对象。如果传递标准 JSON 对象,该方法内部会将其转为字符串 | 2.0 |
Result
类型 | 说明 |
---|---|
number | 表示定时器的编号,这个值可以传递给 clearLaunchAppTimeout 来取消定时器 |
代码示例
import { setLaunchAppTimeout, clearLaunchAppTimeout } from '@zos/router'
const timeoutId = setLaunchAppTimeout({
url: 'pages/js_widget_sample',
appId: 1000001,
delay: 1000,
})
clearLaunchAppTimeout({
timeoutId,
})