doc\doc\cmp_doc_all\cmp-barcode-doc.js 文件

/**
 * 二维码模块提供了移动设备相机扫描二维码和制作二维码的调用，开发者可使用该模块进行相机操作的调用，应用场景包括：
 * <ul>
 *     <li>制作二维码</li>
 *     <li>二维码扫描</li>
 * </ul>
 *      <strong>
 *          页面需要导入的文件
 *          <ul>
 *              <li>cmp-barcode.js</li>
 *          </ul>
 *      </strong>
 * @module Barcode
 * @subtitle 二维码模块
 */
/**
 * 二维码
 * @namespace cmp
 * @class barcode
 */
/**
 * 扫描二维码
 * @method scan
 * @namespace cmp.barcode
 * @param options {object} 配置参数对象
 * @param {Function} [options.success] 成功回调函数
 * @param {Function} [options.error] 失败回调函数
 * @example
 * ```
 * 文件导入路径：
 * M3App端
 *  <script  src="http://cmp/v1.0.0/js/cordova/__CMPSHELL_PLATFORM__/cordova.js"></script>
 *  <script  src="http://cmp/v1.0.0/js/cordova/cordova-plugins.js"></script>
 *  <script  src="http://cmp/v/js/cmp.js"></script>
 *  <script  src="http://cmp/v/js/cmp-barcode.js"></script>
 *  ===========================================================================================
 *  微协同端：不支持
 *  =========================================================================================
 *  调用组件
 * <script>
 *      cmp.barcode.scan({
     *          success:function(result){
     *              //result:为扫描到的二维码字符串
     *          },
     *          error:function(){
     *          //do something...
     *          }
     *      });
 * </script>
 * ```
 */

/**
 * 扫描二维码(长扫)<br>
 *     其作用是将扫描结果发给开发者，开发者自行判断结果后，进行开发者传过来的提示，并且根据回调函数保持是否关闭扫描插件
 * @method holdScan
 * @namespace cmp.barcode
 * @param options {object} 配置参数对象
 * @param {Function} [options.success] 成功回调函数
 * @param {Function} [options.error] 失败回调函数
 * @example
 * ```
 * 文件导入路径：
 * M3App端
 *  <script  src="http://cmp/v1.0.0/js/cordova/__CMPSHELL_PLATFORM__/cordova.js"></script>
 *  <script  src="http://cmp/v1.0.0/js/cordova/cordova-plugins.js"></script>
 *  <script  src="http://cmp/v/js/cmp.js"></script>
 *  <script  src="http://cmp/v/js/cmp-barcode.js"></script>
 *  ===========================================================================================
 *  微协同端：不支持
 *  =========================================================================================
 *  调用组件
 * <script>
 *     var I_want_scan_string = "我希望扫描到的二维码结果是这个字符串";
 *      cmp.barcode.holdScan({
     *          success:function(result,callbackObj){
     *                  var closeScanFunction = callbackObj.close;//关闭扫描的回调函数
     *                  var rescanFunction = callbackObj.sendResult;//继续扫描的回调函数
     *                  var scan_string = result.text;//扫描到的字符串
     *                  if(scan_string == I_want_scan_string){//扫描结果是自己想要的结果，调用回调关闭扫描组件，做自己的业务逻辑
     *                      closeScanFunction();     
     *                  }else {//扫描结果不是自己想要的字符串，调用回调，返回提示语，要求组件重新扫描
     *                     rescanFunction("这个扫描结果不是我想要的，请重新扫描");
     *                  }
     *          },
     *          error:function(){
     *          //do something...
     *          }
     *      });
 * </script>
 * ```
 */

/**
 * 制作二维码
 * @method makeBarScan
 * @namespace cmp.barcode
 * @param options {object} 配置项参数
 * @param {String} options.data 被用于制作二维码的字符串数据
 * @param {Function} [options.success] 成功回调函数
 * @param {Function} [options.error] 失败回调函数
 * @example
 * ```
 * 文件导入路径：
 * M3App端
 *  <script  src="http://cmp/v1.0.0/js/cordova/__CMPSHELL_PLATFORM__/cordova.js"></script>
 *  <script  src="http://cmp/v1.0.0/js/cordova/cordova-plugins.js"></script>
 *  <script  src="http://cmp/v/js/cmp.js"></script>
 *  <script  src="http://cmp/v/js/cmp-barcode.js"></script>
 *  ===========================================================================================
 *  微协同端：不支持
 *  =========================================================================================
 *  调用组件
 * <script>
 *     cmp.barcode.makeBarScan({
     *          data:"",
     *          success:function(){
     *                  //do something
     *              },
     *          error:function(){
     *                  //do something
     *              }
     *     });
 * </script>
 * ```
 */
Top