桌面图标

接口声明

  1. { "name": "system.shortcut" }

导入模块

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

接口定义

方法

shortcut.hasInstalled(OBJECT)

获取桌面图标是否创建

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

shortcut.install(OBJECT)

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

权限要求

创建桌面图标

参数：
参数名类型必填说明
message 1030+String否权限弹窗上的说明文字，用于向用户解释为什么要创建桌面图标
successFunction否创建成功
failFunction否创建失败
completeFunction否执行结束后的回调
fail 返回错误代码
错误码说明
201用户拒绝创建
示例：
  1. shortcut.install({
  2.   success: function() {
  3.     console.log('handling success')
  4.   }
  5. })

属性

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

示例：

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

后台运行限制

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