@dcloudio/uni-app-x 0.7.39 → 0.7.41

package/types/uni/uts-plugin-api/lib/uni-scanCode/utssdk/interface.d.ts

@@ -4,19 +4,298 @@
 export type ScanCodeSuccess = {
     result: string,
     scanType: string
+    /**
+     * 所扫码的字符集
+     *
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
+     */
+    charSet?: string | null;
+    /**
+     * 当所扫的码为当前小程序二维码时，会返回此字段，内容为二维码携带的 path
+     *
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
+     */
+    path?: string | null;
+    /**
+     * 原始数据，base64编码
+     *
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
+     */
+    rawData?: string | null;
 }
 
 export type ScanCodeFail = {}
 /**
  * uni.scanCode成功回调函数定义
+ * @uniPlatform {
+ *   "mp": {
+ *     "weixin": {
+ *       "hostVer": "√",
+ *       "uniVer": "√",
+ *       "unixVer": "4.41"
+ *     },
+ *     "alipay": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "baidu": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "toutiao": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "lark": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "qq": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "kuaishou": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "jd": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     }
+ *   }
+ * }
  */
 export type ScanCodeSuccessCallback = (res: ScanCodeSuccess) => void
 /**
  * uni.scanCode失败回调函数定义
+ * @uniPlatform {
+ *   "mp": {
+ *     "weixin": {
+ *       "hostVer": "√",
+ *       "uniVer": "√",
+ *       "unixVer": "4.41"
+ *     },
+ *     "alipay": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "baidu": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "toutiao": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "lark": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "qq": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "kuaishou": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "jd": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     }
+ *   }
+ * }
  */
 export type ScanCodeFailCallback = (res: ScanCodeFail) => void
 /**
  * uni.scanCode完成回调函数定义
+ * @uniPlatform {
+ *   "mp": {
+ *     "weixin": {
+ *       "hostVer": "√",
+ *       "uniVer": "√",
+ *       "unixVer": "4.41"
+ *     },
+ *     "alipay": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "baidu": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "toutiao": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "lark": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "qq": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "kuaishou": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     },
+ *     "jd": {
+ *       "hostVer": "-",
+ *       "uniVer": "-",
+ *       "unixVer": "-"
+ *     }
+ *   }
+ * }
  */
 export type ScanCodeCompleteCallback = (res: any) => void
 
@@ -28,22 +307,242 @@ export type ScanCodeSupportedTypes = 'barCode' | 'qrCode' | 'datamatrix' | 'pdf4
 export type ScanCodeOptions = {
     /**
      * 是否只能从相机扫码，不允许从相册选择图片
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
      */
     onlyFromCamera?: boolean | null,
     /**
      * 扫码类型
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
      */
     scanType?: ScanCodeSupportedTypes[] | null,
     /**
      * 接口调用成功的回调函数
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
      */
     success?: ScanCodeSuccessCallback | null,
     /**
      * 接口调用失败的回调函数
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
      */
     fail?: ScanCodeFailCallback | null,
     /**
      * 接口调用结束的回调函数（调用成功、失败都会执行）
+     * @uniPlatform {
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "lark": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "qq": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     },
+     *     "jd": {
+     *       "hostVer": "-",
+     *       "uniVer": "-",
+     *       "unixVer": "-"
+     *     }
+     *   }
+     * }
      */
     complete?: ScanCodeCompleteCallback | null
 }
@@ -53,61 +552,62 @@ export interface Uni {
     /**
      * 扫码
      * @uniPlatform {
-     *    "app": {
-     *      "harmony": {
-     *        "osVer": "3.0",
-     *        "uniVer": "4.23",
-     *        "unixVer": "x"
-     *      }
-     *  },
-    *  "mp": {
-    *    "weixin": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "4.41"
-    *    },
-    *    "alipay": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    },
-    *    "baidu": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    },
-    *    "toutiao": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    },
-    *    "lark": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    },
-    *    "qq": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    },
-    *    "kuaishou": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    },
-    *    "jd": {
-    *        "hostVer": "√",
-    *        "uniVer": "√",
-    *        "unixVer": "x"
-    *    }
-    *  },
-     *  "web": {
-     *    "uniVer": "x",
-     *    "unixVer": "x"
-     *  }
+     *   "app": {
+     *     "harmony": {
+     *       "osVer": "3.0",
+     *       "uniVer": "4.23",
+     *       "unixVer": "x"
+     *     }
+     *   },
+     *   "mp": {
+     *     "weixin": {
+     *       "hostVer": "1.0.0",
+     *       "uniVer": "√",
+     *       "unixVer": "4.41"
+     *     },
+     *     "alipay": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "baidu": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "toutiao": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "lark": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "qq": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "kuaishou": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     },
+     *     "jd": {
+     *       "hostVer": "√",
+     *       "uniVer": "√",
+     *       "unixVer": "x"
+     *     }
+     *   },
+     *   "web": {
+     *     "uniVer": "x",
+     *     "unixVer": "x"
+     *   }
      * }
      * @uniVueVersion 2,3  //支持的vue版本
+     * @tutorial_weixin https://developers.weixin.qq.com/miniprogram/dev/api/device/scan/wx.scanCode.html
      */
     scanCode(options?: ScanCodeOptions | null): void;
 }