3DTouch

来自于：官方立即使用

setListener setShortcutItems

概述

3DTouch 封装了 iPhone6s、iPhone6s plus 以后版本的手机特有的 3DTouch 功能。使用本模块需要支持 3DTouch 屏幕的手机和 iOS9.0 以上的操作系统

可以在代码中动态设置快捷菜单，也可以在 Info.plist 里面配置快捷菜单，配置方法请参考链接里面的”配置 3DTouch 应用快捷菜单“：//community.apicloud.com/bbs/forum.php?mod=viewthread&tid=20

3DTouch - 图1

setListener

监听通过快捷菜单打开应用。建议在首页的apiready方法里面进行监听。

setListener(callback(ret, err))

callback(ret, err)

ret：

  • 类型：JSON 对象

  • 内部字段：

  1. {
  2.     type:                //被点击的菜单的标识，字符串类型
  3.     title:                //被点击的菜单标题，字符串类型
  4.     subtitle:            //（可选项）被点击的菜单副标题，字符串类型
  5.     userInfo:            //（可选项）自定义信息，JSON对象
  6. }

示例代码

  1. var 3DTouch = api.require('3DTouch');
  2. 3DTouch.setListener(
  3.     function(ret, err) {
  4.         var type = ret.type;
  5.         if (type == 'com.mycompany.myapp.openfavorites') {
  7.         }
  8.     }
  9. );

可用性

iOS9及以上系统

可提供的1.0.0及更高版本

setShortcutItems

动态设置应用快捷菜单。

如果在Info.plist里面配置了静态的应用快捷菜单，两者不会覆盖。

setShortcutItems({params})

params

items：

  • 类型：JSON数组
  • 默认值：无
  • 描述：应用快捷菜单配置项
  • 内部字段：
  1. [{
  2.     type:'',                //菜单项的标识，字符串类型
  3.     title:'',                //菜单标题，字符串类型
  4.     subtitle:'',            //（可选项）菜单子标题，字符串类型
  5.     icon:{                    //（可选项）菜单图标，JSON对象
  6.         file:'',            //（可选项）图标文件路径，需放置在widget目录下，如widget/image/icon1.png。图标必须是单色的png格式图片，尺寸建议为105*105，若配置了该字段将忽略type字段。字符串类型
  7.         type:0                //（可选项）使用系统提供的图标，请参考常量里面的“应用快捷菜单图标类型”。数字类型
  8.     },
  9.     userInfo:{                //（可选项）附加信息，JSON对象
  10.         'key':'value'
  11.     }
  12. }]

示例代码

  1. var 3DTouch = api.require('3DTouch');
  2. 3DTouch.setShortcutItems({
  3.     items: [{
  4.         type: 'com.api.testapp.favorite',
  5.         title: 'Favorites',
  6.         icon: {
  7.             file: 'widget/image/open-favorites'
  8.         },
  9.         userInfo: {
  10.             'key1': 'value1'
  11.         }
  12.     }, {
  13.         type: 'com.api.testapp.compose',
  14.         title: 'New Message',
  15.         icon: {
  16.             type: 0
  17.         },
  18.         userInfo: {
  19.             'key2': 'value2'
  20.         }
  21.     }]
  22. });

可用性

iOS9及以上系统

可提供的1.0.0及更高版本

应用快捷菜单图标类型

应用快捷菜单图标类型

应用快捷菜单图标类型，数字类型

取值范围

  1. 0            // compose
  2. 1            // play
  3. 2            // pause
  4. 3            // add
  5. 4            // location
  6. 5            // search
  7. 6            // share
  8. 7            // prohibit                iOS9.1及以后系统有效
  9. 8            // contact                iOS9.1及以后系统有效
  10. 9            // home                    iOS9.1及以后系统有效
  11. 10            // mark location         iOS9.1及以后系统有效
  12. 11            // favorite                iOS9.1及以后系统有效
  13. 12            // love                    iOS9.1及以后系统有效
  14. 13            // cloud                iOS9.1及以后系统有效
  15. 14            // invitation            iOS9.1及以后系统有效
  16. 15            // confirmation            iOS9.1及以后系统有效
  17. 16            // mail                    iOS9.1及以后系统有效
  18. 17            // message                iOS9.1及以后系统有效
  19. 18            // date                    iOS9.1及以后系统有效
  20. 19            // time                    iOS9.1及以后系统有效
  21. 20            // capture photo        iOS9.1及以后系统有效
  22. 21            // capture video        iOS9.1及以后系统有效
  23. 22            // task                    iOS9.1及以后系统有效
  24. 23            // task completed        iOS9.1及以后系统有效
  25. 24            // alarm                iOS9.1及以后系统有效
  26. 25            // bookmark                iOS9.1及以后系统有效
  27. 26            // shuffle                iOS9.1及以后系统有效
  28. 27            // audio                iOS9.1及以后系统有效
  29. 28            // update                iOS9.1及以后系统有效

可用性

iOS系统

可提供的1.0.0及更高版本