codeTools

立即使用

概述

codeTools模块封装了二维码、条形码操作相关功能

decodeImg

二维码/条形码图片解码,iOS不支持条形码图片解码

decodeImg({params}, callback(ret))

params

path:

  • 类型:字符串
  • 描述:(可选项)要识别的图片路径,要求本地路径(fs://、widget://)

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,        //布尔型;是否解码成功
      content: ''          //扫描的二维码/条形码信息
}

示例代码

var codeTools = api.require('codeTools');
codeTools.decodeImg({
    path: 'widget://res/img/apicloud.png'
}, function(ret) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

encodeImg

将字符串生成二维码/条形码图片,

encodeImg({params}, callback(ret))

params

type:

  • 类型:字符串
  • 描述:(可选项)生成图片的类型,默认值:'qr_image'
  • 取值范围
    • bar_image(生成条形码图片)
    • qr_image(生成二维码图片)

content:

  • 类型:字符串
  • 描述:所要生成的二维码/条形码字符串,当 type 为 bar_image 时,该值只能为数字字符串

saveToAlbum:

  • 类型:布尔
  • 描述:(可选项)扫描的二维码/条形码图片是否自动保存到相册
  • 默认值:false

saveImg:

  • 类型:JSON 对象
  • 描述:(可选项)扫描的二维码/条形码图片保存所需要的参数,若不传则不保存
  • 内部字段:
{
    path: 'fs://a.jpg',  //字符串类型;保存的文件路径;若路径不存在,则创建此路径,只支持fs://协议
    w: 200,              //(可选项)数字类型;生成图片的宽度,默认:200
    h: 200               //(可选项)数字类型;生成图片的高度,默认:200
}

callback(ret)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true,        //布尔型;是否生成成功
    imgPath: '',         //字符串类型;需要保存的二维码图片绝对路径(自定义路径)
    albumPath: '',       //字符串类型;需要保存的二维码图片绝对路径(相册路径)
}

err:

  • 类型:
  • 内部字段:
{
      code: 2,  //数字类型;错误码
               // -1 编码错误
               // 2:albumError(图片保存相册失败)
      msg:''  // 异常信息
}

示例代码

var codeTools = api.require('codeTools');
codeTools.encodeImg({
    content: 'http://www.apicloud.com/',
    saveToAlbum: true,
    saveImg: {
        path: 'fs://album.png',
        w: 200,
        h: 200
    }
}, function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本