appshortcut

来自于:开发者立即使用

概述

appshortcut是用来给软件添加一个快捷方式的工具,可以自由的设置标题、图标和参数。需要开发者引导用户去设置App的“桌面快捷方式”权限。当通过快捷图标启动app能识别创建图标的用户参数,进行页面跳转等业务逻辑的处理。appshortcut模块是shortCut模块的扩展,增加了快捷键图标和参数的自定义设置,同时支持iOS系统创建快捷方式。

补充说明

  • 经测试,由于有些手机在软件安装之后才会同意软件权限,所以导致在有些手机上面创建快捷方式会稍微慢一些,一般手机都是正常的。
  • 而针对慢的问题的测试结果是软件第一次安装,由于手机性能差导致权限提示步骤会慢一些,导致手机对软件创建快捷方式的授权也会。
  • 慢半拍,这是正常现象。

快捷方式传值

api.addEventListener({
    name:'appintent'
},function(ret,err){
    alert("快捷appintent方式传值:"+JSON.stringify(ret));
});

模块接口

addShortCut

添加快捷方式

addShortCut({params}, callback(ret, err))

params

title:

  • 类型:字符串
  • 描述:(必选项)为app添加快捷方式的名称。

icon:

  • 类型:字符串
  • 描述:(可选项)为快捷方式设置启动图标,默认为当前App的启动图标。(支持:fs://,widget://)

urlScheme:

  • 类型:字符串
  • 描述:(必选项)本app的urlScheme字符串。(仅支持iOS系统)

appParam:

  • 类型:字符串
  • 描述:(可选项)为快捷方式设置启动参数。

appDownloadUrl:

  • 类型:字符串
  • 描述:(必选项)本app的appstore下载地址,当未安装app时,自动跳转到改地址引导用户进行下载。(仅支持iOS系统)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: ''
}

示例代码

var demo = api.require('appshortcut');
demo.addShortCut({
    title:"快捷方式",
    icon : "widget://image/ic_launcher.png",
    urlScheme : "myscheme",
    appParam : "key1=value1&key2=value2&key3=value3",
    appDownloadUrl : "http://www.baidu.com"
}, function(ret, err){
    alert(JSON.stringify(ret));
});

可用性

iOS系统、Android系统

可提供的1.0.0及更高版本