interface.uts 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. export type ScanType =
  2. | 'QR_CODE'
  3. | 'AZTEC'
  4. | 'CODABAR'
  5. | 'CODE_39'
  6. | 'CODE_93'
  7. | 'CODE_128'
  8. | 'DATA_MATRIX'
  9. | 'EAN_8'
  10. | 'EAN_13'
  11. | 'ITF'
  12. | 'MAXICODE'
  13. | 'PDF_417'
  14. | 'RSS_14'
  15. | 'RSS_EXPANDED'
  16. | 'UPC_A'
  17. | 'UPC_E'
  18. | 'UPC_EAN_EXTENSION'
  19. | 'WX_CODE'
  20. | 'CODE_25'
  21. export type GeneralCallbackResult = {
  22. /** 错误信息 */
  23. errMsg : string
  24. }
  25. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  26. export type ScanCodeCompleteCallback = (res : GeneralCallbackResult) => void
  27. /** 接口调用失败的回调函数 */
  28. export type ScanCodeFailCallback = (res : GeneralCallbackResult) => void
  29. export type ScanCodeSuccessCallbackResult = {
  30. /** 所扫码的字符集 */
  31. charSet : string
  32. /** 当所扫的码为当前小程序二维码时,会返回此字段,内容为二维码携带的 path */
  33. path : string
  34. /** 原始数据,base64编码 */
  35. rawData : string
  36. /** 所扫码的内容 */
  37. result : string
  38. /** 所扫码的类型
  39. *
  40. * 可选值:
  41. * - 'QR_CODE': 二维码;
  42. * - 'AZTEC': 一维码;
  43. * - 'CODABAR': 一维码;
  44. * - 'CODE_39': 一维码;
  45. * - 'CODE_93': 一维码;
  46. * - 'CODE_128': 一维码;
  47. * - 'DATA_MATRIX': 二维码;
  48. * - 'EAN_8': 一维码;
  49. * - 'EAN_13': 一维码;
  50. * - 'ITF': 一维码;
  51. * - 'MAXICODE': 一维码;
  52. * - 'PDF_417': 二维码;
  53. * - 'RSS_14': 一维码;
  54. * - 'RSS_EXPANDED': 一维码;
  55. * - 'UPC_A': 一维码;
  56. * - 'UPC_E': 一维码;
  57. * - 'UPC_EAN_EXTENSION': 一维码;
  58. * - 'WX_CODE': 二维码;
  59. * - 'CODE_25': 一维码; */
  60. scanType : ScanType
  61. errMsg : string
  62. }
  63. /** 接口调用成功的回调函数 */
  64. export type ScanCodeSuccessCallback = (
  65. result : ScanCodeSuccessCallbackResult
  66. ) => void
  67. export type ScanCodeOption = {
  68. /** 接口调用结束的回调函数(调用成功、失败都会执行) */
  69. complete ?: ScanCodeCompleteCallback
  70. /** 接口调用失败的回调函数 */
  71. fail ?: ScanCodeFailCallback
  72. /**
  73. *
  74. * 是否只能从相机扫码,不允许从相册选择图片 */
  75. onlyFromCamera ?: boolean
  76. /**
  77. *
  78. * 扫码类型
  79. *
  80. * 可选值:
  81. * - 'barCode': 一维码;
  82. * - 'qrCode': 二维码;
  83. * - 'datamatrix': Data Matrix 码;
  84. * - 'pdf417': PDF417 条码; */
  85. scanType ?: Array<'barCode' | 'qrCode' | 'datamatrix' | 'pdf417'>
  86. /** 接口调用成功的回调函数 */
  87. success ?: ScanCodeSuccessCallback
  88. scanMode?: string
  89. }
  90. // #ifdef APP-ANDROID
  91. export interface HMScanManager {
  92. scanCode(options: ScanCodeOption):void
  93. }
  94. // #endif