快应用 桌面图标
接口声明
{"name": "system.shortcut"}
导入模块
import shortcut from '@system.shortcut'
或
const shortcut = require('@system.shortcut')
接口定义
shortcut.hasInstalled(OBJECT)
获取桌面图标是否创建
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 成功回调。参数:true 已创建,false 未创建 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调 |
示例:
shortcut.hasInstalled({
success: function () {
console.log('handling success')
}
})
shortcut.install(OBJECT)
创建桌面图标,每次创建都需要用户授权
权限要求
创建桌面图标
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 成功回调 |
fail | Function | 否 | 失败回调 |
complete | Function | 否 | 执行结束后的回调 |
fail返回错误代码
错误码 | 说明 |
---|---|
201 | 用户拒绝,获取创建桌面图标权限失败 |
示例:
shortcut.install({
success: function () {
console.log('handling success')
}
})
属性
名称 | 参数类型 | 是否可读 | 是否可写 | 描述 |
---|---|---|---|---|
systemPromptEnabled 1020+ | Boolean | 是 | 是 | 是否开启系统快捷方式创建弹窗,默认 true。不会持久化,只对当前运行有效 |
示例:
shortcut.systemPromptEnabled = false
let enabled = shortcut.systemPromptEnabled
console.log('system prompt enabled: ' + enabled)
后台运行限制
禁止使用。
后台运行详细用法参见 后台运行脚本。