@tjmt/wnsdk

v1.3.20

Published

15 days ago

一套与原生交互JS Api

Downloads

149

0High
0Medium
0Low

zx_web

promise94

vactory

wnsdk 使用说明

1. 使用

1.1. 引入 API 文件（wnsdk.min.js）

1.2. import/require

npm i @tjmt/wnsdk --save
import wnsdk from "@tjmt/wnsdk";

1.3. 方法调用方式

wnsdk.[模块名].[方法名](params)

// 例
wnsdk.ui.toast({ message: "Hello World!" });

1.4. 参数(params: Object)说明

| 属性 | 说明 | | --------- | -------------------------------------- | | key:value | 各个方法的参数名称（key）和值（value） |

| 方法 | 说明 | 返回值 | | :------ | ------------ | ------------ | | success | 成功回调函数 | 成功的返回值 | | error | 失败回调函数 | 失败的返回值 |

// 例：
wnsdk.device.setOrientation({
  type: 0,
  //成功回调函数
  success(result) {
    // 逻辑处理...
  },
  //失败回调函数
  error(error) {
    // 失败处理...
  }
});

2. 扩展

2.1.扩展规则说明

2.1.1.模块扩展规则

模块已存在，按 2.1.2 扩展方法规则进行扩展
模块不存在，直接扩展

2.1.2.方法扩展规则说明

方法存在，不允许扩展
方法不存在，直接扩展

2.2.模块扩展

extendModule(moduleName,apis)

2.2.1.参数说明

| 参数 | 类型 | 必传 | 默认值 | 说明 | | ---------- | ------ | ---- | ------ | ------------------- | | moduleName | String | true | 无 | 模块名 | | apis | Array | true | 无 | 对应的 api 对象数组 |

2.2.2.api 对象：

| 属性 | 类型 | 必传 | 默认值 | 说明 | | ------------- | -------- | ----- | ------------ | ----------------------------- | | namespace | String | true | 无 | 命名空间 | | os | Array | true | 无 | 支持的环境，可选值：MTCoreApi | | defaultParams | Object | false | 无 | 默认参数 | | runCode | Function | false | 模块方法参数 | 执行函数 | | isLongCb | Boolean | false | false | 是否需要长监听 |

//api对象示例
{
    namespace: "screenShot",
    os: ["MTCoreApi"],
    defaultParams: {
    	// 1表示竖屏，0表示横屏，-1表示跟随系统
        orientation: 1
    },
    runCode(...rest){
      // .....处理逻辑

      // wnsdk.callInner.apply(this, args);
	}
}

2.2.3.示例

wnsdk.extendModule("device", [
  {
    namespace: "screenShot",
    os: ["MTCoreApi"],
    defaultParams: {
      // 1表示竖屏，0表示横屏，-1表示跟随系统
      orientation: 1
    }
  }
]);

2.3.方法扩展

extendApi(moduleName, apiParam)

2.3.1.参数说明

| 参数 | 类型 | 必传 | 默认值 | 说明 | | ---------- | ------ | ---- | ------ | ------------------------------- | | moduleName | String | true | 无 | 模块名 | | apiParam | Object | true | 无 | api 对象（参考 2.1.1.api 对象） |

2.3.2.示例

{
    namespace: "screenShot",
    os: ["MTCoreApi"],
    defaultParams: {
        // 1表示竖屏，0表示横屏，-1表示跟随系统
        orientation: 1
    }
}

3. 模块接口

3.1. page 模块

3.1.1. open()

在新窗口打开页面

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------- | ------ | ----- | ------ | -------------------------------------------------------------- | | url | String | true | 无 | 打开页面的链接 | | data | Object | false | 无 | 链接拼接的参数，{ key: value }形式的对象，value 为基本类型数据 | | needCode | Number | false | 1 | 是否需要追加 userCode，0：不需要添加，1：需要动态缀加 userCode | | type | Number | false | 1 | 是否用集成 SDK 功能的 webview 打开 url，1：需要，2：不需要 | | isHalfScreen | Boolean | false | false | 是否打开半屏（默认 false，传：true,即可弹出半屏,弹出方式是从底部向上弹出） |
返回值：无
示例

wnsdk.page.open({
  url: "http://www.tjmeiteng.com",
  data: { a: 1, b: 2 },
  needCode: 0
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.1.2. close()

关闭当前应用，返回上一级

参数：无
返回值：无
示例

wnsdk.page.close({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.1.3. closeMicroApp()

关闭所有打开应用，回到初始页面

参数：无
返回值：无
示例

wnsdk.page.closeMicroApp({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.1.4. reload()

重新加载当前页面

参数：无
返回值：无
示例

wnsdk.page.reload({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.1.5. openUrl()

在浏览器打开网页

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :--- | ------ | ----- | ------ | -------------------------------------------------------------- | | url | String | true | 无 | 打开页面的链接 | | data | Object | false | 无 | 链接拼接的参数，{ key: value }形式的对象，value 为基本类型数据 |
返回值：无
示例

wnsdk.page.openUrl({
  url: "http://www.tjmeiteng.com",
  data: { a: 1, b: 2 },
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.1.6. refreshViewDate()

新数据数据，移动端通知 web 端有新的数据通知，长期回调

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :--- | ------ | ----- | ------ | -------------------------------------------------------------- | | id | String | true | 无 | 应用 ID | | name | String | true | 无 | 应用名称 |
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ------------------------------------------------------ | | status | Number | 1：表示有新的数据，2：表示没有新的数据 | | id | String | 微应用 Id | | name | String | 微应用名称 | | extra | any | 扩展数据，根据微应用确认 |

3.1.5. reloadMicroAppAsVersionUpdate()

微应用自己版本更新时重新加载微应用

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :--- | ------ | ----- | ------ | -------------------------------------------------------------- | | appId | String | true | 无 | 微应用 id |
返回值：无
示例

wnsdk.page.reloadMicroAppAsVersionUpdate({
  appId: "123",
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2. ui 模块

3.2.1. showLoadingBar()

展示页面加载进度

参数：无
返回值：无
示例

wnsdk.ui.showLoadingBar({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.2. closeLoadingBar()

关闭页面加载进度

参数：无
返回值：无
示例

wnsdk.ui.closeLoadingBar({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.3. showStatusBar()

显示顶部状态栏

参数：无
返回值：无
示例

wnsdk.ui.showStatusBar({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.4. hideStatusBar()

隐藏顶部状态栏

参数：无
返回值：无
示例

wnsdk.ui.hideStatusBar({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.5. statusBarColor()

更改顶部状态栏背景颜色

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ---- | ------ | -------------- | | bgcolor | String | true | 无 | 状态栏背景颜色，十六进制代码色值，例如：#ffffff | | color | Number | false | 1 | 状态栏文字颜色，1：黑色，2：白色|
返回值：无
示例

wnsdk.ui.statusBarColor({
  bgcolor:"#ffffff",
  color:1
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.6. toast()

弹出 toast

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ---- | ------ | -------- | | message | String | true | "" | 显示内容 |
返回值：无
示例

wnsdk.ui.toast({
  message:"我是显示内容"
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.7. alert()

确定弹窗

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :---------- | ------------- | ----- | -------- | ------------------------------------------------------ | | title | String | true | "" | 弹窗标题 | | message | String | false | "" | 弹窗内容 | | cancelable | Number | false | 1 | 是否可以点击弹窗以外的区域关闭弹窗，1：关闭，2：不关闭 | | buttonNames | Array[string] | false | ["确定"] | 弹窗底部按钮，点击按钮是在返回值函数返回按钮对应标位置 |
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ------------------------------------------------------ | | index | Number | 被点击按钮在 buttonNames 中的位置，如果点击弹窗以外区域关闭值为 -1 |
示例

wnsdk.ui.alert({
  title:"我是弹窗标题",
  message:"我是弹窗内容",
  cancelable:1,
  buttonNames:["确定"]
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.8. prompt()

输入弹窗

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :---------- | ------------- | ----- | ---------------- | ------------------------------------------------------ | | title | String | true | "" | 弹窗标题 | | hint | String | false | "" | 输入框提示语 | | text | String | false | "" | 输入框内容 | | line | Number | false | 3 | 最大展示行数，默认 3 行，最大支持 5 行 | | length | Number | false | 100 | 最大输入字数，默认 100，最大支持 1000 | | cancelable | Number | false | 1 | 是否可以点击弹窗以外的区域关闭弹窗，1：关闭，2：不关闭 | | buttonNames | Array[string] | false | ["取消", "确定"] | 弹窗底部按钮，点击按钮是在返回值函数返回按钮对应标位置 |
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ------------------------------------------------------ | | index | Number | 被点击按钮在 buttonNames 中的位置，如果点击弹窗以外区域关闭值为 -1 | | message | String | 输入内容 |
示例

wnsdk.ui.prompt({
  title:"我是弹窗标题",
  hint:"我是输入框提示语",
  text:"我是输入框内容",
  line: 4,
  length:100,
  cancelable:1,
  buttonNames:["取消"]
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.9. popWindow()

pop 弹窗

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :---- | ------------- | ---- | ------ | ---------------- | | items | Array[string] | true | 无 | 选项内容数组 | | icons | Array[string] | true | 无 | 选项图标地址数组 |
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ------------------------------------------------------ | | index | Number | 被点击项在 items 中的位置，如果点击弹窗以外区域关闭值为 -1 |
示例

wnsdk.ui.popWindow({
  items:["2"],
  icons:["2","2","2"]
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.10. pickDate()

选择日期

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :---- | ------ | ----- | ------ | ------------------------------ | | title | String | true | 无 | 标题 | | date | String | false | 无 | 默认开始时间，如："2019-12-12" |
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ------------------------------------------------------ | | date | String | 选择的日期 |
示例

wnsdk.ui.pickDate({
  title:"我是标题",
  date:"2019-12-12"
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.11. pickTime()

选择时间

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :---- | ------ | ----- | -------- | ------------------------- | | title | String | true | 无 | 标题 | | date | String | false | 当前日期 | 默认开始时间，如："12:12" |
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ------------------------------------------------------ | | time | String | 选择的时间 |
示例

wnsdk.ui.pickTime({
  title:"我是标题",
  date:"12:12"
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.12. pickDateTime()

选择日期时间

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :---- | ------------- | ----- | -------- | ---------------------------------------------------------------------------------- | | title | Array[string] | true | 无 | 选择日期、时间时的标题，包含两个元素的数组，第一个为日期的标题，第二个为时间的标题 | | date | String | false | 当前日期 | 默认开始时间，如："2019-12-12 12:12" |
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | datetime | String | 选择的日期时间 |
示例

wnsdk.ui.pickDateTime({
  title:"我是标题",
  date:"2019-12-12 12:12"
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.13. showWaiting()

打开等待 loading 弹窗

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ----------------------------- | | message | String | false | 无 | 加载 loading 时显示的提示文字 |
返回值：无
示例

wnsdk.ui.showWaiting({
  message:"我是提示文字"
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.14. closeWaiting()

关闭等待 loading 弹窗

参数：无
返回值：无
示例

wnsdk.ui.closeWaiting({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.2.15. showStatusColor()

修改顶部状态栏颜色

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ----------------------------- | | isGradient | Boolean | false | false | 是否渐变色：默认传 NO（false） | | statusBgColor | String | false | 无 | 最新状态栏背景颜色，例如："296fff"，十六进制 | | direction | String | false | 无 | 从上到下:topToBottom；从左到右:leftToRight；从下到上:bottomToTop；从右到左:rightToLeft；从左下到右上:leftBottomToRightTop；从左上到右下:leftTopToRightBottom；从右上到左下:rightTopToLeftBottom；从右下到左上:rightBottomToLeftTop | | startBgColor | String | false | 无 | 渐变色开始的颜色 "296fff" | | endBgColor | String | false | 无 | 渐变色结束的颜色 "296fff" | | startAlpha | Float | false | 无 | 渐变色开始的颜色比值范围：0.0~1.0 | | endAlpha | Float | false | 无 | 渐变色结束的颜色比值范围：0.0~1.0 | | isPicture | Boolean | false | false | 是否是图片（默认不是） | | picUrl | String | false | 无 | 当是图片时图片的地址 |
返回值：无
示例

wnsdk.ui.showStatusColor({
  isGradient: false,
  statusBgColor: "#1C5AD6",
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.3. runtime 模块

3.3.1. appVersion()

获取当前应用信息

参数：无
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | appVsesion | String | 应用版本 |
示例

wnsdk.runtime.appVersion({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.3.2 launchApp()

打开第三方应用

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :----- | ------ | ----- | ------ | ------------------------------------------------ | | name | String | false | 无 | 应用的包名 |
返回值：无
示例

// 打开微信
wnsdk.runtime.launchApp({
  name: "com.tencent.mm",
  success: function(result) {
    showTips(JSON.stringify(result));
  },
  error: function(error) {
    showTips("失败:" + JSON.stringify(error));
  }
});

3.3.3. clearCache()

清除缓存

参数：无
返回值：无
示例

wnsdk.runtime.clearCache({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.3.4. clipboard()

复制内容到剪切板

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | content | String | false | 无 | 要复制的内容 |
返回值：无
示例

wnsdk.runtime.clipboard({
  content:"我是要复制的内容"
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4. device 模块

3.4.1. screenShot()

截屏

参数：无
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | url | String | 截屏图片的本地保存路径 |
示例

wnsdk.device.screenShot({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.2. setOrientation()

设置横竖屏

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | type | Number | true | 1 | 1：竖屏, 0：横屏, -1：跟随系统 |
返回值：无
示例

wnsdk.device.setOrientation({
  type:1
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.3. vibrateAndBell()

触发手机震动+响铃

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | type | Number | true | 0 | 0：震动 1：响铃 2：震动加响铃 |
返回值：无
示例

wnsdk.device.vibrateAndBell({
  type:0
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.4. location()

获取定位信息

参数：无
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | longitude | Number | 经度 | | latitude | Number | 纬度 | | stress | String | 位置信息 |
示例

wnsdk.device.location({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.5. netState()

获取设备网络状态

参数：无
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | type | Number | -1：无网络,0：移动网络,1：WIFI |
示例

wnsdk.device.netState({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.6. getDeviceId()

获取设备 ID

参数：无
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | deviceId | String | 设备 id |
示例

wnsdk.device.getDeviceId({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.7. getVendorInfo()

获取生产商信息

参数：无
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | uaInfo | String | 生产商以及型号 | | pixel | String | 分辨率 | | deviceId | String | 设备 id | | netWorkType | String | 网络情况 |
示例

wnsdk.device.getVendorInfo({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.8 getScreenLight()

获取屏幕亮度

参数：无
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | light | Number | 当前屏幕亮度 |
示例

wnsdk.device.getScreenLight({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.9. setScreenLight()

设置屏幕亮度

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | light | Number | true | 0 | 设置亮度 0-100 之间 |
返回值：无
示例

wnsdk.device.setScreenLight({
  light:77
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.10. getVolume()

获取当前多媒体音量

参数：无
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | volume | Number | 当前音量 |
示例

wnsdk.device.getVolume({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.11. setVolume()

更改多媒体音量

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | volume | Number | true | 0 | 设置音量 0-100 之间 |
返回值：无
示例

wnsdk.device.setVolume({
  volume:77
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.12. quantity()

获取设备电量信息

参数：无
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | quantity | Number | 当前电量百分数 |
示例

wnsdk.device.quantity({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.13. appLoad()

查询应用是否已经安装

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | name | String | true | 无 | 应用的包名 |
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | load | Number | 0：未安装，1：安装 |
示例

wnsdk.device.appLoad({
  name:"我是应用的包名"
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.14. closeInputKeyboard()

关闭系统键盘

参数：无
返回值：无
示例

wnsdk.device.closeInputKeyboard({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.15 callPhone()

拨打电话

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | tel | Number | false | "" | 电话号码 |
返回值：无
示例

wnsdk.device.callPhone({
  tel:13123454534
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.16. sendMsg()

发送短信

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | tel | Number | true | 无 | 电话号码 | | content | Number | false | "" | 短信内容 |
返回值：无
示例

wnsdk.device.sendMsg({
  tel:13123454534
  content:123
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.17. requestSaveLimit()

获取存储权限

参数：无
返回值：无
示例

wnsdk.device.requestSaveLimit({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.18. requestCameraLimit()

获取摄像头权限

参数：无
返回值：无
示例

wnsdk.device.requestCameraLimit({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.19. requestLocationLimit()

获取定位权限

参数：无
返回值：无
示例

wnsdk.device.requestLocationLimit({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.20. requestVoiceLimit()

获取麦克风权限

参数：无
返回值：无
示例

wnsdk.device.requestVoiceLimit({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.21. requestPhoneLimit()

获取电话权限

参数：无
返回值：无
示例

wnsdk.device.requestPhoneLimit({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.22. requestAddressBookLimit()

获取通讯录权限

参数：无
返回值：无
示例

wnsdk.device.requestAddressBookLimit({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.23. getBlueToothStatus()

获取手机蓝牙开关状态

参数：无
返回值：String
示例

wnsdk.device.getBlueToothStatus({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.24. setPhoneBlueTooth()

设置手机蓝牙开关

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | type | Number | true | 0 | 0：关闭 1：开启 |
返回值：无
示例

wnsdk.device.setPhoneBlueTooth({
  type: 0,
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.25. getBlueToothConnectStatusByMac()

获取蓝牙连接状态

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | mac | String | true | 无 | 蓝牙 mac 地址 |
返回值：String
示例

wnsdk.device.getBlueToothConnectStatusByMac({
  mac: "C4:64:E3:64:6A:06",
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.26. connectBlueToothByMac()

连接蓝牙设备

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | mac | String | true | 无 | 蓝牙 mac 地址 |
返回值：无
示例

wnsdk.device.connectBlueToothByMac({
  mac: "C4:64:E3:64:6A:06",
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.27. disconnectBlueToothByMac()

断开蓝牙设备

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | mac | String | true | 无 | 蓝牙 mac 地址 |
返回值：无
示例

wnsdk.device.disconnectBlueToothByMac({
  mac: "C4:64:E3:64:6A:06",
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.28. connectAndSendDataToBlueToothDevice()

连接蓝牙设备，并发送数据

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | mac | String | true | 无 | 蓝牙 mac 地址 | | serviceUUID | String | true | 无 | 服务 UUID | | readCharacteristicUUID | String | true | 无 | 蓝牙读取 UUID | | writeCharacteristicUUID | String | true | 无 | 蓝牙写入 UUID | | descriptorUUID | String | true | 无 | 蓝牙特征 UUID | | data | Array | true | [1] | 发送的数据 |
返回值：无
示例

wnsdk.device.connectAndSendDataToBlueToothDevice({
  mac: "C4:64:E3:64:6A:06",
  serviceUUID: "****",
  readCharacteristicUUID: "****",
  writeCharacteristicUUID: "****",
  descriptorUUID: "****",
  data: [1],
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.4.29. webViewScreenShot()

微应用内部截图

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | microAppId | String | true | 无 | 微应用 ID |
返回值：无
示例

wnsdk.device.webViewScreenShot({
  microAppId: "123***",
  success(result) {
    // 逻辑处理...
    // JSON字符串,对应result字段{"remoteUrl":"https://192.168.***","imageName":"110.jpg","imgeSize":"10245"}"value:1.远程链接;2.名称;3.大小(单位:B)
  },
  error(error) {
    // 失败处理...
  }
});

3.5. systemClick 模块

3.5.1. hookSystemBack()

获取 android 手机系统返回键点击事件使用权，获取成功之后 success 回调函数会被调用一次无返回值，之后每次系统返回键被按下都会被调用，有返回值

参数
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | systemBack | String | 值：back，系统返回键被触发 |
示例

wnsdk.systemClick.hookSystemBack({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.5.2. giveUpSystemBack()

释放 android 手机系统返回键点击事件使用权

参数：无
返回值：无
示例

wnsdk.systemClick.giveUpSystemBack({
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.6. media 模块

3.6.1. multimediaPreview()

音乐播放、照片预览、视频预览、语音播放、文件预览

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | type | String | true | 无 | 多媒体类型 (file、image、video) | | url | String | true | 无 | 文件地址 | | name | String | true | 无 | 文件名 | | token | Number | false | 0 | 链接是否需要追加 token(0 不需要,1 需要) | | encryptType | Number | false | 2 | 是否为加密文件(1 加密,2 非加密) |
返回值：无
示例

wnsdk.media.multimediaPreview({
  type:"image",
  url:"D:/123.jpg",
  name:"123",
  token:0
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.6.2. multimediaDownLoad()

文件下载

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | type | String | true | 无 | 多媒体类型 (file、image、video) | | url | String | true | 无 | 文件地址 | | name | String | true | 无 | 文件名 | | token | Number | false | 0 | 链接是否需要追加 token(0 不需要,1 需要) | | encryptType | Number | false | 2 | 是否为加密文件(1 加密,2 非加密) |
返回值：无
示例

wnsdk.media.multimediaDownLoad({
  type:"image",
  url:"D:/123.jpg",
  name:"123",
  token:0
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.6.3. richImagesPreview()

富媒体消息预览

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | userId | String | true | 无 | 消息创建者 id，随手拍消息必传 | | userName | String | true | 无 | 消息创建者名称，随手拍消息必传 | | avatar | String | true | 无 | 消息创建者头像链接 | | msgId | String | true | 无 | 消息 id | | title | String | false | 无 | 消息标题 | | createTime | String | true | 无 | 消息创建时间| | location | String | false | 无 | 位置信息 | | describe | String | false | 无 | 描述 | | tags | Array[Object] | false | 无 | 标签的名称，随手拍消息有标签的时候必传 | | imgList | Array[Object] | true | 无 | 照片、视频队列 |
- tags | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | id | String | true | 无 | 标签 ID | | name | String | true | 无 | 标签名称 | | groupId | String | false | 无 | 标签对应的群 id |
- imgList | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | path | String | false | 无 | 本地资源路径 | | url | String | true | 无 | 远程资源路径 | | thumbnail | String | false | 无 | 缩略图地址 | | name | String | false | 无 | 资源名称 | | from | Number | false | 无 | 来源，0：实时拍摄，1：本地选取 | | type | Number | false | 无 | 类型，0：照片，1：视频 | | describe | String | false | 无 | 描述 | | duration | String | false | 无 | 时长 | | size | String | false | 无 | 大小 |
返回值：无
示例

wnsdk.media.richImagesPreview({
  userId: "消息创建者id",
  userName: "消息创建者名称",
  avatar: "消息创建者头像链接",
  msgId: "消息id",
  title: "消息标题",
  createTime: "消息创建时间",
  location: "位置信息",
  describe: "描述",
  tags:[
    {
      id: "标签ID",
      name: "标签名称",
      groupId: "标签对应的群id"
    }
  ],
  imgList:[
    {
      path: "本地资源路径",
      url: "远程资源路径",
      thumbnail: "缩略图地址",
      name: "资源名称",
      from: 0,
      type: 0,
      describe: "描述",
      duration: "时长",
      size: "大小"
    }
  ]
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.6.4. chooseAndUpLoadMedia()

本地文件选择并上传

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | type | Array[Object] | true | 无 | 文件类型，示例：[{ typeName: "file", childType: [] }], typeName 可选值："file", "image", "camera", "voice", childType":[] 文件类型，类似于 png、doc，不传则是全部类型 | | number | Number | true | 无 | 选择文件数量最小值：1，最大值：9 | | sizeLimit | Number | true | 无 | 总大小限制，单位 M 10~100] | | encryption | Number | false | 0 | 是否上传到加密区(0 不需要,1 需要) | | folderName | String | true | 无 | 保存的文件夹名称 | | callbackUploadType | Number | 1 | 无 | 上传成功后返回形式，0：单个返回，1：统一返回 | | encryptType | Number | false | 2 | 上传文件是否执行加密操作，1：加密，2：不加密 |
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | number | Number | 选择文件数量 | | encryption | Number | 0 上传到 oss 加密区, 1 非加密区 | | medias | Number | 上传文件数据 |
- data Array[Object] | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | mediaType | String | 文件类型 | | url | String | 文件远程链接 | | mediaName | String | 文件名 | | mediaSize | String | 文件大小 | | mediaDuration | String | 视频、语音类文件时长 |
示例

wnsdk.media.chooseAndUpLoadMedia({
  type:[{typeName: "image", childType: ["png", "jpg"]}],
  number:6,
  sizeLimit:66,
  encryption:0,
  folderName:"我上传的文件"
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.6.5. saveBase64AsImage()

将 base64 转换成 BitMap,然后保存至本地 SD 卡 ZhiXin 目录下,并在相册中展示

参数：Object
| 参数 | 类型 | 必传 | 默认值 | 说明 | | :----- | ------ | ---- | ------ | ------------------ | | base64 | String | true | 无 | 照片的 base64 编码 |
返回值：无
示例

wnsdk.media.saveBase64AsImage({
  base64: "base64编码",
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.6.6. saveMediaToZhiWen()

保存多媒体到智文

参数：Object
| 参数 | 类型 | 必传 | 默认值 | 说明 | | :------------ | ------ | ----- | ------ | ----------------------------------- | | mediaUrl | String | true | 无 | 多媒体远程 url | | mediaName | String | true | 无 | 多媒体名称,必须包含尾缀(也就是类型) | | mediaSize | String | true | 无 | 多媒体大小,单位字节(B) | | mediaDuration | String | false | 无 | 多媒体时长,单位秒(s) |
返回值：无
示例

wnsdk.media.saveMediaToZhiWen({
  mediaUrl: "http://sdsfdsfds",
  mediaName: "oss使用教程.mp4",
  mediaSize: "10241",
  mediaDuration: "600",
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.6.7. imagesPreview()

照片批量预览

参数：
- imgList[Object]
  | 参数 | 类型 | 必传 | 默认值 | 说明 | | :---------- | ------ | ----- | ------ | --------------------------------------- | | localPath | String | false | 无 | 图片本地路径 | | url | String | true | 无 | 图片远程地址，用于图片预览 | | name | String | false | 无 | 图片名称 | | size | String | false | 无 | 多媒体大小,单位字节(B) | | token | Number | false | 0 | 链接是否需要追加 token(0 不需要,1 需要) | | encryptType | Number | false | 2 | 是否为加密文件(1 加密,2 非加密) | | extra | String | false | 无 | 扩展字段 |
- showPosition[Number] 默认显示图片下标，默认为 0
返回值：无
示例

wnsdk.media.imagesPreview({
  imgList: [
    {
      url: "http://sdsfdsfds",
      name: "oss使用教程.png",
      size: "10241",
      encryptType: 1
    },
    {
      url: "http://www.baidu.com/1243.jpg",
      name: "1243.jpg",
      size: "10241",
      encryptType: 1
    }
  ],
  showPosition: 2,
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.6.8. runHandClapOfZhiXin()

随手拍拍摄完成后上传多媒体到 OSS，返回远程连接给 js

参数：
- Object
  | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------------------ | ------- | ----- | ------ | ---------------------------------------------------------------------------------------------------- | | handClapType | String | false | 无 | 拍摄-图片、视频，1 为默认，拍摄图片，2 拍摄视频-视频只能录制一个，3 由用户自己决定拍照或者录制(默认) | | takePhotoNum | Number | false | 无 | 拍摄个数[1-9]之间，handClapType=”2“时，number 只能为 1 | | canChooseLocalImage | Boolean | false | true | 是否在本地可选照片，true 为可选（默认），false 为不可选 | | canEditImage | Boolean | false | true | 是否可编辑照片，true 为可编辑（默认），false 为不可编辑 | | addWaterMarkToImage | Boolean | false | true | 是否将水印合成到照片中，true 为合成（默认），false 为不合成 | | callbackUploadType | String | false | 2 | 移动端上传文件成功后返回的方式 ("0":默认，代表是单个返回，"1": 代表是统一返回 ) | | encryption | String | false | 无 | 是否上传到 oss 加密区(0 不需要,1 需要) |
返回值：无
示例

wnsdk.media.runHandClapOfZhiXin({
  "handClapType":1,
  "takePhotoNum":9,
  "canChooseLocalImage":false,
  "canEditImage":ture,
  "addWaterMarkToImage":true,
  "callbackUploadType":"1",
  "encryption":0
  success(result) {
    // 逻辑处理...
    //{"takeNumber":"9","currentIndex":"2","medias","[{"mediaType":"image","url":"http://","mediaName":"测试用例","mediaSize":"1024","mediaDuration":"10","takeTime":"189452225522","position":"天津市南开区奥城****"},...]}
    //参数说明:1.必传,随手拍图片个数;2.当前返回的第几张(统一返回时,值为选中的个数);3.远程连接属性(某一个文件上传失败时,则对应字段里的url为空)
  },
  error(error) {
    // 失败处理...
  }
});

3.7. util 模块

3.7.1 scan()

扫描二维码

参数：无
| 参数 | 类型 | 必传 | 默认值 | 说明 | | --------- | ------ | ----- | ------ | ------------------------------------------------------------------------- | | returnUrl | String | false | 1 | "0"为返回 url 给 web,原生端不打开 url,"1"不返回 url 给 web,原生端打开 url |

返回值：若 returnUrl 为"1"时有返回
| key | 类型 | 说明 | | --- | ------ | ------------ | | url | String | 扫描到的 url |

示例

wnsdk.util.scan({
  returnUrl: "0",
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.7.2 localAvatar()

获取用户头像

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | id | String | true | 无 | 用户的 id |
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | url | String | 头像路径或者数据流 |
示例

wnsdk.util.localAvatar({
  id:"用户的id"
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.7.3. chooseAddressBook()

组织架构选人

参数：Object | 参数 | 类型 | 必传 | 默认值 | 说明 | | :------ | ------ | ----- | ------ | ------------ | | id | String | true | 无 | 公司 id | | selected | Array[string] | false | 无 | 已选择人员列表，再次进行选择时进行回显并禁用，人员 accountId 组成的数据| | editSelect | Array[string] | false | 无 | 已选择人员中可被再次编辑人员列表，再次进行选择时可以对已选择人员进行取消选择、选择操作，人员 accountId 组成的数据, 并且人员必须在 selected 中| | type | Number | false | 1 | 选择类型，1：单选，2：多选 |
返回值：Object | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | msg | String | 执行结果描述 | | data | Array[Object] | 选择人员数据 |
- data Array[Object] | key | 类型 | 说明 | | :---------- | -------- | ---------------------------- | | accountId | String | 账号 id | | corpUserId | String | 企业用户 id | | name | String | 昵称 | | corpId | String | 公司 id | | position | String | 职位 | | mobile | String | 电话 | | email | String | 邮箱 | | avatar | String | 头像 | | hiredDate | String | 入职时间 | | leaveDate | String | 离职时间 | | jobNumber | String | 员工号 | | status | String | 状态(0-未激活, 1-正常, 2-锁定, 3-离职) |
示例

wnsdk.util.chooseAddressBook({
  id:"公司id",
  selected,
  editSelect,
  type:1
  success(result) {
    // 逻辑处理...
  },
  error(error) {
    // 失败处理...
  }
});

3.7.4. chooseAddressBookByCorpIds()