start
API_LEVEL
3.0开始支持,API 兼容性请参考 API_LEVEL。
启动指定的设备应用服务,启动结果通过回调函数返回。
信息
权限代码: device:os.bg_service
类型
function start(option: Option): Result
参数
Option
| 属性 | 类型 | 必填 | 默认值 | 说明 | API_LEVEL |
|---|---|---|---|---|---|
| file | string | 是 | - | 设备应用服务 js 文件,必须是在 app.json module 中 app-service 字段配置的文件 | 3.0 |
| param | string | 否 | - | 设备应用服务 js 文件加载时,传入的参数 | 3.0 |
| complete_func | (callbackOption: CallbackOption) => void | 是 | - | 设备应用服务启动完成回调函数 | 3.0 |
| reload | boolean | 否 | true | 是否持久化,跟随系统运行状态变化自动重启。系统状态变化包括:系统重启,省电模式进出,系统语言变更,小程序更新等 | 4.0 |
CallbackOption
| 属性 | 类型 | 说明 | API_LEVEL |
|---|---|---|---|
| file | string | 设备应用服务 js 文件,与 start 传入参数相同 | 3.0 |
| result | boolean | 设备应用服务启动结果,true 代表成功,false 代表失败 | 3.0 |
Result
| 类型 | 说明 |
|---|---|
boolean | 如果返回 0 则表明设备应用服务启动成功,其余值的含义参考 ERROR_CODE |
ERROR_CODE
| 值 | 类型 | 说明 | API_LEVEL |
|---|---|---|---|
| 0 | number | 成功 | 3.0 |
| 1 | number | 参数错误 | 3.0 |
| 2 | number | 服务状态错误 | 3.0 |
| 3 | number | 无权限 | 3.0 |
| 4 | number | 内存不足 | 3.0 |
| 5 | number | 不支持 | 3.0 |
| 6 | number | 服务被禁止 | 3.0 |
| 7 | number | 服务数量已达系统限制 | 3.0 |
| 255 | number | 未知错误 | 3.0 |
代码示例
import { start } from '@zos/app-service'