小程序开放平台

文档中心
基础
路由
跳转
转发
界面
网络
支付
数据缓存
媒体
位置
开放接口
设备
剪贴板
网络
电话
内存
扫码
scanCode
屏幕
XHSML
性能
第三方平台
文件
数据分析
画布

xhs.scanCode

开发
>
JS API
>
设备
>
扫码
>
scanCode
>
更新时间:2024-11-13 19:05:30

以Promise风格调用: 支持

调起客户端扫码界面进行扫码

参数

Object object

属性
类型
默认值
必填
说明
onlyFromCamerabooleanfalse是否只能从相机扫码,不允许从相册选择图片
scanTypearray背景颜色值,有效值为十六进制颜色
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性
类型
说明
errMsgstring
resultstring所扫码的内容
scanTypestring所扫码的类型
charSetstring所扫码的字符集
pathstring当所扫的码为当前小程序二维码时,会返回此字段,内容为二维码携带的 path
rawDatastring原始数据,base64编码
scanType 的合法值
合法值
说明
QR_CODE二维码
AZTEC一维码
CODABAR一维码
CODE_39一维码
CODE_93一维码
CODE_128一维码
DATA_MATRIX二维码
EAN_8一维码
EAN_13一维码
ITF一维码
MAXICODE一维码
PDF_417二维码
RSS_14一维码
RSS_EXPANDED一维码
UPC_A一维码
UPC_E一维码
UPC_EAN_EXTENSION一维码
WX_CODE二维码
CODE_25一维码

实例代码

// 允许从相机和相册扫码
xhs.scanCode({
  success (res) {
    console.log(res)
  }
})

// 只允许从相机扫码
xhs.scanCode({
  onlyFromCamera: true,
  success (res) {
    console.log(res)
  }
})