教程 框架 组件 接口 工具 其他

桌面图标 shortcut

接口声明

{ "name": "system.shortcut" }

导入模块

import shortcut from '@system.shortcut'const shortcut = require('@system.shortcut')

接口定义

方法

shortcut.hasInstalled(OBJECT)

获取桌面图标是否创建。调用shortcut.install方法后立即调用该方法得到的结果可能不正确,存在一定延时。 建议在调用shortcut.install方法后不要立即调用该方法。 (注:各厂商延时情况可能略有不同,vivo侧android 11之前机型大概有50ms左右延时、android 11及之后机型大概有100ms左右延时)

参数:
参数名类型必填说明
successFunction成功回调。参数:true 已创建,false 未创建
failFunction失败回调
completeFunction执行结束后的回调
示例:
shortcut.hasInstalled({
  success: function() {
    console.log('handling success')
  }
})

shortcut.install(OBJECT)

创建桌面图标,每次创建都需要用户授权

权限要求

创建桌面图标

参数:
参数名类型必填说明
message 1030+String权限弹窗上的说明文字,用于向用户解释为什么要创建桌面图标
successFunction创建成功
failFunction创建失败
completeFunction执行结束后的回调
fail 返回错误代码
错误码说明
201用户拒绝创建
207 1100+用户拒绝并勾选不再询问复选框
1001接口调用超过当日使用频次
示例:
shortcut.install({
  success: function() {
    console.log('handling success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}, errorMsg=${data}`)
  }
})

属性

名称参数类型是否可读是否可写描述
systemPromptEnabled 1020+ Boolean是否开启系统快捷方式创建弹窗,默认 true。不会持久化,只对当前运行有效

示例:

shortcut.systemPromptEnabled = false
let enabled = shortcut.systemPromptEnabled
console.log('system prompt enabled: ' + enabled)

后台运行限制

禁止使用。
后台运行详细用法参见后台运行 脚本

条匹配 "" 的结果

    没有搜索到与 "" 相关的内容