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

scanCode(params: Object)

版本要求:

BaseKit≥2.3.2@ray-js/ray≥0.3.23

支持平台:

iOSAndroid

import { scanCode } from '@ray-js/ray';

// Promise 调用
try {
  const res = await scanCode({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

描述

调起客户端扫码界面进行扫码注意：Android返回的数据中，只有result字段可用，其他字段无意义。

参数

属性	类型	必填	默认值	说明	BaseKit 最低版本
`onlyFromCamera`	boolean	否	`false`	是否只能从相机扫码，不允许从相册选择图片	-
`isShowActionTitle`	boolean	否	`true`	是否显示动作标题(仅Android生效)	v3.3.3
`isShowTorch`	boolean	否	`false`	是否显示闪关灯(仅Android生效)	v3.3.3
`isShowKeyboard`	boolean	否	`false`	是否显示输入设置代码	v3.12.0
		否	-	输入设置文案修改	v3.12.0
`customTips`	string	否	-	自定义提示标语(仅Android生效)	v3.3.3
`scanType`	string[]	否	`["barCode", "qrCode"]`	扫码类型	-
`complete`	() => void	否	-	接口调用结束的回调函数（调用成功、失败都会执行）	-
`success`	(params: Object) => void	否	-	接口调用成功的回调函数	-
`fail`	(params: Object) => void	否	-	接口调用失败的回调函数	-

success 回调参数

属性	类型	说明	BaseKit 最低版本
`result`	string	所扫码的内容	v3.2.6
`scanType`	string	所扫码的类型	v3.2.6
`charSet`	string	所扫码的字符集	v3.2.6
`path`	string	当所扫的码为当前小程序二维码时，会返回此字段，内容为二维码携带的 path (不一定会有返回值)	v3.2.6
`rawData`	string	原始数据，base64编码	v3.2.6

fail 回调参数

属性	类型	说明
`errorMsg`	string	错误信息
`errorCode`	string \| number	错误码
		错误扩展

返回值

无

示例代码

import { scanCode } from '@ray-js/ray'

// 调起客户端扫码界面，扫码后回调返回内容与类型（Android 仅 result 字段有效）
scanCode({
  onlyFromCamera: false,
  isShowActionTitle: true,
  isShowTorch: false,
  isShowKeyboard: false,
  scanType: ["barCode", "qrCode"],
  success: data => console.log("扫码结果：", data.result, data.scanType),
  fail: error => console.error(error),
});