简介

Insight Kit 为开发者提供了一系列基础组件与接口,达到媲美原生应用的体验,如日期选择器、页面跳转等。

调用规范

  • 由于机制问题, JSAPI注入是异步过程, 时序无法保证.
  • 如果需要在页面加载时就调用相关接口, 则须把相关接口放在bootstrap函数中调用来确保正确执行. 对于用户触发时才调用的接口, 则可以直接调用, 不需要放在bootstrap函数中.
insight.bootstrap(function() {
    // Please put the code about the SDK here.
})

快速开始

Promise 方式:

var compression = '0.8',
    items = ['camera', 'album']
insight.ui.chooseImage(compression, items)
    .then( data => {
        // data即为图片地址base64格式
        alert(data);
    })
    .catch( error => {
        alert(JSON.stringify(error));
    })

接口约定

  • 如未特殊约定, 所有API只支持 Promise 风格调用.

  • insight.on 开头的 API 是监听某个事件发生的接口, 接受一个 CALLBACK 函数作为参数.

错误约定

如未特殊约定, Insight Kit 调用出错时会通过 Promise catch函数的参数里会包含一个特殊的字段 code (Number 类型), 作为 API 调用的错误码, 示例:

{
    code: 1,
    msg: '接口不存在'
}
code 描述
1 接口不存在
2 参数无效
3 发生未知错误
4 接口无权限
5 用户取消操作

模块设计

模块 描述 例子
ui 交互组件 alert / datePicker
window 窗口导航相关 pushWindow / popWindow
meida 媒体相关 startRecord / playVoice
storage k-v存储 get / set / del
device 设备功能相关 scan(扫码) / 网络 / 定位
open 开放接口 获取用户信息 / 设备信息等
on 事件监听 页面恢复运行 / 返回事件等