全部产品
云市场

扫码解析

更新时间:2020-04-13 16:44:39

此接口用于调用扫码组件,且仅限于 Android 系统。另外,在使用此接口前,请确认您已经在工程中添加了扫码组件。

三种不同的 actionType 为:

  • 获取码值
  • 用码值路由
  • 获取码值并用码值路由

scan 接口的使用方法

  1. AlipayJSBridge.call('scan', {
  2. type: 'bar',
  3. actionType: 'scanAndRoute'
  4. }, function(result) {
  5. alert(JSON.stringify(result));
  6. });

代码示例

  • 只获取二维码的信息:

    1. <h1>点击扫码后输出码对应的信息</h1>
    2. <a href="#" class="btn read">开始扫码</a>
    3. <script>
    4. function ready(callback) {
    5. // 如果 jsbridge 已经注入则直接调用
    6. if (window.AlipayJSBridge) {
    7. callback && callback();
    8. } else {
    9. // 如果没有注入则监听注入的事件
    10. document.addEventListener('AlipayJSBridgeReady', callback, false);
    11. }
    12. }
    13. ready(function() {
    14. document.querySelector('.read').addEventListener('click', function() {
    15. AlipayJSBridge.call('scan', {
    16. type: 'qr'
    17. }, function(result) {
    18. alert(JSON.stringify(result));
    19. });
    20. });
    21. });
    22. </script>
  • 扫描二维码并发起路由:

    1. <h1>扫码后不输出信息,直接让支付宝解码</h1>
    2. <a href="#" class="btn read">开始扫码</a>
    3. <script>
    4. function ready(callback) {
    5. // 如果 jsbridge 已经注入则直接调用
    6. if (window.AlipayJSBridge) {
    7. callback && callback();
    8. } else {
    9. // 如果没有注入则监听注入的事件
    10. document.addEventListener('AlipayJSBridgeReady', callback, false);
    11. }
    12. }
    13. ready(function() {
    14. document.querySelector('.read').addEventListener('click', function() {
    15. AlipayJSBridge.call('scan', {
    16. type: 'qr',
    17. actionType: 'scanAndRoute'
    18. }, function(result) {
    19. alert(JSON.stringify(result));
    20. });
    21. });
    22. });
    23. </script>

API

  1. AlipayJSBridge.call('scan', {
  2. type, actionType, qrcode
  3. }, fn);

入参

名称 类型 描述 必选 默认值
type string 扫描目标类型,二维码/条形码。 Y “”
actionType string 操作类型:
“scan”只扫码值。
“route”用码值路由。
“scanAndRoute”扫描并路由,类同首页效果。
N “scan”
qrcode string 指定用于“route”操作类型的码值。 N “”
fn function 扫码获取码信息后的回调函数。 N -

出参

回调函数带入的参数 result: {error, barCode, qrCode, cardNumber}。

名称 类型 描述
barCode string 扫描所得条码数据。
qrCode string 扫描所得二维码数据。
error int 错误码(10:用户取消,11:操作失败)