Skip to main content
版本:v3

setLaunchAppTimeout

API_LEVEL 2.0 开始支持,API 兼容性请参考 API_LEVEL

注册一个定时器,定时唤起小程序,在此期间如果设备重启,则定时器会失效。

类型

function setLaunchAppTimeout(option: Option): Result

参数

Option

属性类型必填默认值说明API_LEVEL
appIdnumber-小程序 ID2.0
urlstring-页面路径2.0
utcnumber-utc 时间戳(毫秒),优先级高于 delay,当与 delay 字段同时设置的时候,只有 utc 字段生效2.0
delaynumber0等待时间(毫秒)3.0
paramsstring|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,
})