@ray-js/api 0.5.7-beta-2 → 0.5.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/@types/BaseKit.d.ts +88 -1008
  2. package/@types/DeviceKit.d.ts +152 -1488
  3. package/@types/MiniKit.d.ts +26 -381
  4. package/@types/{BizKit.d.ts → TYKit.d.ts} +41 -104
  5. package/@types/all-kits.d.ts +1 -1
  6. package/lib/{BaseKit-3.0.0.d.ts → BaseKit-2.3.11.d.ts} +2 -18
  7. package/lib/{BaseKit-3.0.0.js → BaseKit-2.3.11.js} +2 -18
  8. package/lib/{DeviceKit-3.0.0.d.ts → DeviceKit-2.3.3.d.ts} +18 -58
  9. package/lib/{DeviceKit-3.0.0.js → DeviceKit-2.3.3.js} +20 -140
  10. package/lib/{MiniKit-3.0.0.d.ts → MiniKit-2.4.3.d.ts} +0 -14
  11. package/lib/{MiniKit-3.0.0.js → MiniKit-2.4.3.js} +0 -14
  12. package/lib/{BizKit-3.0.1.d.ts → TYKit-2.2.6.d.ts} +1 -2
  13. package/lib/{BizKit-3.0.1.js → TYKit-2.2.6.js} +1 -2
  14. package/lib/all-kits.d.ts +5 -5
  15. package/lib/all-kits.js +5 -5
  16. package/lib/getApp/{index.thing.d.ts → index.tuya.d.ts} +0 -0
  17. package/lib/getApp/{index.thing.js → index.tuya.js} +0 -0
  18. package/lib/getBoundingClientRect/{index.thing.d.ts → index.tuya.d.ts} +0 -0
  19. package/lib/getBoundingClientRect/{index.thing.js → index.tuya.js} +0 -0
  20. package/lib/getCurrentPages/{index.thing.d.ts → index.tuya.d.ts} +0 -0
  21. package/lib/getCurrentPages/{index.thing.js → index.tuya.js} +0 -0
  22. package/lib/getElementById/{index.thing.d.ts → index.tuya.d.ts} +0 -0
  23. package/lib/getElementById/{index.thing.js → index.tuya.js} +0 -0
  24. package/lib/getI18nInfo/{index.thing.d.ts → index.tuya.d.ts} +0 -0
  25. package/lib/getI18nInfo/{index.thing.js → index.tuya.js} +0 -0
  26. package/lib/hideTabBar/index.d.ts +7 -1
  27. package/lib/hideTabBar/{index.thing.d.ts → index.tuya.d.ts} +0 -0
  28. package/lib/hideTabBar/{index.thing.js → index.tuya.js} +0 -0
  29. package/lib/navigateBack/{index.thing.d.ts → index.tuya.d.ts} +0 -0
  30. package/lib/navigateBack/{index.thing.js → index.tuya.js} +0 -0
  31. package/lib/navigateTo/{index.thing.d.ts → index.tuya.d.ts} +0 -0
  32. package/lib/navigateTo/{index.thing.js → index.tuya.js} +0 -0
  33. package/lib/reLaunch/{index.thing.d.ts → index.tuya.d.ts} +0 -0
  34. package/lib/reLaunch/{index.thing.js → index.tuya.js} +0 -0
  35. package/lib/readFileSync/{index.native.d.ts → index.tuya.d.ts} +0 -0
  36. package/lib/readFileSync/{index.native.js → index.tuya.js} +0 -0
  37. package/lib/redirectTo/{index.thing.d.ts → index.tuya.d.ts} +0 -0
  38. package/lib/redirectTo/{index.thing.js → index.tuya.js} +0 -0
  39. package/lib/{readFileSync/index.thing.d.ts → requestCloud/index.tuya.d.ts} +0 -0
  40. package/lib/requestCloud/{index.native.js → index.tuya.js} +0 -0
  41. package/lib/{requestCloud/index.native.d.ts → setNavigationBarColor/index.tuya.d.ts} +0 -0
  42. package/lib/setNavigationBarColor/{index.thing.js → index.tuya.js} +0 -0
  43. package/lib/{requestCloud/index.thing.d.ts → setNavigationBarTitle/index.tuya.d.ts} +0 -0
  44. package/lib/setNavigationBarTitle/{index.thing.js → index.tuya.js} +0 -0
  45. package/lib/showTabBar/index.d.ts +7 -1
  46. package/lib/showTabBar/{index.thing.d.ts → index.tuya.d.ts} +0 -0
  47. package/lib/showTabBar/{index.thing.js → index.tuya.js} +0 -0
  48. package/lib/switchTab/{index.thing.d.ts → index.tuya.d.ts} +0 -0
  49. package/lib/switchTab/{index.thing.js → index.tuya.js} +0 -0
  50. package/package.json +9 -8
  51. package/lib/getApp/index.native.d.ts +0 -2
  52. package/lib/getApp/index.native.js +0 -4
  53. package/lib/getCurrentPages/index.native.d.ts +0 -1
  54. package/lib/getCurrentPages/index.native.js +0 -5
  55. package/lib/getElementById/index.native.d.ts +0 -1
  56. package/lib/getElementById/index.native.js +0 -13
  57. package/lib/getI18nInfo/index.native.js +0 -9
  58. package/lib/hideNotification/index.native.d.ts +0 -2
  59. package/lib/hideNotification/index.native.js +0 -7
  60. package/lib/hideTabBar/index.native.d.ts +0 -2
  61. package/lib/hideTabBar/index.native.js +0 -2
  62. package/lib/navigateBack/index.native.d.ts +0 -2
  63. package/lib/navigateBack/index.native.js +0 -2
  64. package/lib/navigateTo/index.native.d.ts +0 -2
  65. package/lib/navigateTo/index.native.js +0 -2
  66. package/lib/reLaunch/index.native.d.ts +0 -2
  67. package/lib/reLaunch/index.native.js +0 -2
  68. package/lib/readFileSync/index.thing.js +0 -8
  69. package/lib/redirectTo/index.native.d.ts +0 -2
  70. package/lib/redirectTo/index.native.js +0 -2
  71. package/lib/requestCloud/index.thing.js +0 -8
  72. package/lib/setNavigationBarColor/index.native.d.ts +0 -2
  73. package/lib/setNavigationBarColor/index.native.js +0 -2
  74. package/lib/setNavigationBarColor/index.thing.d.ts +0 -1
  75. package/lib/setNavigationBarTitle/index.native.d.ts +0 -2
  76. package/lib/setNavigationBarTitle/index.native.js +0 -2
  77. package/lib/setNavigationBarTitle/index.thing.d.ts +0 -1
  78. package/lib/showTabBar/index.native.d.ts +0 -2
  79. package/lib/showTabBar/index.native.js +0 -2
  80. package/lib/switchTab/index.native.d.ts +0 -2
  81. package/lib/switchTab/index.native.js +0 -2
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * BaseKit
3
3
  *
4
- * @version 3.0.0
4
+ * @version 2.3.11
5
5
  */
6
6
  declare namespace ty {
7
7
  /**
@@ -38,27 +38,6 @@ declare namespace ty {
38
38
  }) => void
39
39
  }): void
40
40
 
41
- /**
42
- * 获取音频文件时长信息
43
- */
44
- export function getAudioFileDuration(params: {
45
- /** 音频文件路径 */
46
- path: string
47
- complete?: () => void
48
- success?: (params: {
49
- /** 音频时长 */
50
- duration: number
51
- }) => void
52
- fail?: (params: {
53
- errorMsg: string
54
- errorCode: string | number
55
- innerError: {
56
- errorCode: string | number
57
- errorMsg: string
58
- }
59
- }) => void
60
- }): void
61
-
62
41
  /**
63
42
  * 权限请求方法
64
43
  */
@@ -123,8 +102,6 @@ declare namespace ty {
123
102
  appId?: string
124
103
  /** 打开的页面路径,如果为空则打开首页,path 中 ? 后面的部分会成为 query,在小程序的 `App.onLaunch`、`App.onShow` 和 `Page.onLoad` 的回调函数 */
125
104
  path?: string
126
- /** 打开小程序的转场方式,分为right|bottom,指代水平和竖直方向 */
127
- position?: string
128
105
  /** 传递给目标小程序的数据,目标小程序可在 `App.onLaunch`,`App.onShow` 中获取到这份数据 */
129
106
  extraData?: Record<string, any>
130
107
  /** 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版,则打开的小程序必定是正式版 */
@@ -209,6 +186,52 @@ declare namespace ty {
209
186
  }) => void
210
187
  }): void
211
188
 
189
+ /**
190
+ * 读取本地文件内容
191
+ */
192
+ export function readFile(params: {
193
+ /** 要写入的文件路径 (本地路径) */
194
+ filePath: string
195
+ /** 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容 */
196
+ encoding: string
197
+ /** 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
198
+ position: number
199
+ /** 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
200
+ length: number
201
+ complete?: () => void
202
+ success?: (params: {
203
+ /** 文件内容 */
204
+ data: string
205
+ }) => void
206
+ fail?: (params: {
207
+ errorMsg: string
208
+ errorCode: string | number
209
+ innerError: {
210
+ errorCode: string | number
211
+ errorMsg: string
212
+ }
213
+ }) => void
214
+ }): void
215
+
216
+ /**
217
+ * 获取通用缓存路径
218
+ */
219
+ export function getTempDirectory(params?: {
220
+ complete?: () => void
221
+ success?: (params: {
222
+ /** 【待废弃, 不建议使用】临时文件夹路径 */
223
+ tempDirectory: string
224
+ }) => void
225
+ fail?: (params: {
226
+ errorMsg: string
227
+ errorCode: string | number
228
+ innerError: {
229
+ errorCode: string | number
230
+ errorMsg: string
231
+ }
232
+ }) => void
233
+ }): void
234
+
212
235
  /**
213
236
  * 开始监听陀螺仪数据。
214
237
  */
@@ -244,10 +267,7 @@ declare namespace ty {
244
267
  }): void
245
268
 
246
269
  /**
247
- * 从本地相册选择图片或使用相机拍照, 可用chooseMedia替代此方法
248
- *
249
- *权限:[scope.camera, scope.writePhotosAlbum]
250
- *关联API:[chooseMedia]
270
+ * 从本地相册选择图片或使用相机拍照。
251
271
  */
252
272
  export function chooseImage(params?: {
253
273
  /** 最多可以选择的图片张数 */
@@ -273,52 +293,6 @@ declare namespace ty {
273
293
  }) => void
274
294
  }): void
275
295
 
276
- /**
277
- * 拍摄或从手机相册中选择图片或视频
278
- *
279
- *权限:[scope.camera, scope.writePhotosAlbum]
280
- */
281
- export function chooseMedia(params?: {
282
- /** 最多可以选择的文件数 */
283
- count?: number
284
- /**
285
- * 选择类型, 默认图片
286
- * 'image' 只能拍摄图片或从相册选择图片
287
- * 'video' 只能拍摄视频或从相册选择视频
288
- */
289
- mediaType?: string
290
- /**
291
- * 图片和视频选择的来源, 默认['album', 'camera']
292
- * 'album' 从相册选择
293
- * 'camera' 使用相机拍摄
294
- */
295
- sourceType?: string[]
296
- /**
297
- * 拍摄视频最长拍摄时间,单位秒。默认10s
298
- * 时间范围为 3s 至 60s 之间。不限制相册。
299
- */
300
- maxDuration?: number
301
- complete?: () => void
302
- success?: (params: {
303
- /**
304
- * 文件类型
305
- * 'image' 图片
306
- * 'video' 视频
307
- */
308
- type: string
309
- /** 本地临时文件列表 */
310
- tempFiles?: TempMediaFileCB[]
311
- }) => void
312
- fail?: (params: {
313
- errorMsg: string
314
- errorCode: string | number
315
- innerError: {
316
- errorCode: string | number
317
- errorMsg: string
318
- }
319
- }) => void
320
- }): void
321
-
322
296
  /**
323
297
  * 从本地相册选择图片或使用相机拍照(可裁剪)
324
298
  */
@@ -360,116 +334,6 @@ declare namespace ty {
360
334
  }) => void
361
335
  }): void
362
336
 
363
- /**
364
- * 获取图片信息
365
- */
366
- export function getImageInfo(params: {
367
- /** 图片的路径,支持网络路径、本地路径 */
368
- src: string
369
- complete?: () => void
370
- success?: (params: {
371
- /** 图片原始宽度,单位px。不考虑旋转。 */
372
- width: number
373
- /** 图片原始高度,单位px。不考虑旋转。 */
374
- height: number
375
- /**
376
- * 拍照时设备方向
377
- * 合法值 说明
378
- * up 默认方向(手机横持拍照),对应 Exif 中的 1。或无 orientation 信息。
379
- * up-mirrored 同 up,但镜像翻转,对应 Exif 中的 2
380
- * down 旋转180度,对应 Exif 中的 3
381
- * down-mirrored 同 down,但镜像翻转,对应 Exif 中的 4
382
- * left-mirrored 同 left,但镜像翻转,对应 Exif 中的 5
383
- * right 顺时针旋转90度,对应 Exif 中的 6
384
- * right-mirrored 同 right,但镜像翻转,对应 Exif 中的 7
385
- * left 逆时针旋转90度,对应 Exif 中的 8
386
- */
387
- orientation: string
388
- /**
389
- * 图片格式。
390
- * 合法值 说明
391
- * unknown 未知格式
392
- * jpeg jpeg压缩格式
393
- * png png压缩格式
394
- * gif gif压缩格式
395
- * tiff tiff压缩格式
396
- */
397
- type: string
398
- }) => void
399
- fail?: (params: {
400
- errorMsg: string
401
- errorCode: string | number
402
- innerError: {
403
- errorCode: string | number
404
- errorMsg: string
405
- }
406
- }) => void
407
- }): void
408
-
409
- /**
410
- * 获取视频信息
411
- */
412
- export function getVideoInfo(params: {
413
- /** 视频文件路径,可以是临时文件路径也可以是永久文件路径 */
414
- src: string
415
- complete?: () => void
416
- success?: (params: {
417
- /** 图片原始宽度,单位px。不考虑旋转。 */
418
- width: number
419
- /** 图片原始高度,单位px。不考虑旋转。 */
420
- height: number
421
- /**
422
- * 画面方向
423
- * 合法值 说明
424
- * up 默认方向(手机横持拍照),对应 Exif 中的 1。或无 orientation 信息。
425
- * up-mirrored 同 up,但镜像翻转,对应 Exif 中的 2
426
- * down 旋转180度,对应 Exif 中的 3
427
- * down-mirrored 同 down,但镜像翻转,对应 Exif 中的 4
428
- * left-mirrored 同 left,但镜像翻转,对应 Exif 中的 5
429
- * right 顺时针旋转90度,对应 Exif 中的 6
430
- * right-mirrored 同 right,但镜像翻转,对应 Exif 中的 7
431
- * left 逆时针旋转90度,对应 Exif 中的 8
432
- */
433
- orientation: string
434
- /** 视频格式 */
435
- type: string
436
- /** 视频时长 */
437
- duration: number
438
- /** 视频大小,单位 kB */
439
- size: number
440
- /** 视频帧率 */
441
- fps: number
442
- /** 视频码率,单位 kbps */
443
- bitrate: number
444
- }) => void
445
- fail?: (params: {
446
- errorMsg: string
447
- errorCode: string | number
448
- innerError: {
449
- errorCode: string | number
450
- errorMsg: string
451
- }
452
- }) => void
453
- }): void
454
-
455
- /**
456
- * 保存视频到系统相册,支持mp4视频格式
457
- */
458
- export function saveVideoToPhotosAlbum(params: {
459
- /** 视频文件路径,可以是临时文件路径也可以是永久文件路径 (本地路径) */
460
- filePath: string
461
- complete?: () => void
462
- success?: (params: null) => void
463
- fail?: (params: {
464
- errorMsg: string
465
- errorCode: string | number
466
- innerError: {
467
- errorCode: string | number
468
- errorMsg: string
469
- }
470
- }) => void
471
- }): void
472
-
473
337
  /**
474
338
  * 显示消息提示框
475
339
  */
@@ -516,6 +380,8 @@ declare namespace ty {
516
380
  confirmColor?: string
517
381
  complete?: () => void
518
382
  success?: (params: {
383
+ /** editable 为 true 时,用户输入的文本 */
384
+ content?: string
519
385
  /** 为 true 时,表示用户点击了确定按钮 */
520
386
  confirm: boolean
521
387
  /** 为 true 时,表示用户点击了取消(用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭) */
@@ -532,7 +398,7 @@ declare namespace ty {
532
398
  }): void
533
399
 
534
400
  /**
535
- * 显示 loading 提示框。需主动调用 thing.hideLoading 才能关闭提示框
401
+ * 显示 loading 提示框。需主动调用 ty.hideLoading 才能关闭提示框
536
402
  */
537
403
  export function showLoading(params: {
538
404
  /** 提示的内容 */
@@ -616,14 +482,7 @@ declare namespace ty {
616
482
  phoneNumber: string
617
483
  complete?: () => void
618
484
  success?: (params: null) => void
619
- fail?: (params: {
620
- errorMsg: string
621
- errorCode: string | number
622
- innerError: {
623
- errorCode: string | number
624
- errorMsg: string
625
- }
626
- }) => void
485
+ fail?: (params: {}) => void
627
486
  }): void
628
487
 
629
488
  /**
@@ -634,14 +493,7 @@ declare namespace ty {
634
493
  data: string
635
494
  complete?: () => void
636
495
  success?: (params: null) => void
637
- fail?: (params: {
638
- errorMsg: string
639
- errorCode: string | number
640
- innerError: {
641
- errorCode: string | number
642
- errorMsg: string
643
- }
644
- }) => void
496
+ fail?: (params: {}) => void
645
497
  }): void
646
498
 
647
499
  /**
@@ -653,145 +505,7 @@ declare namespace ty {
653
505
  /** 剪贴板的内容 */
654
506
  data: string
655
507
  }) => void
656
- fail?: (params: {
657
- errorMsg: string
658
- errorCode: string | number
659
- innerError: {
660
- errorCode: string | number
661
- errorMsg: string
662
- }
663
- }) => void
664
- }): void
665
-
666
- /**
667
- * 设置系统音量
668
- *
669
- *错误码标注
670
- *入参值范围超出 errorCode = 6, The volume value is invalid, it should be [0 - 1]
671
- */
672
- export function updateVolume(params: {
673
- /** 音量,阈值【0 - 1】 */
674
- value: number
675
- complete?: () => void
676
- success?: (params: null) => void
677
- fail?: (params: {
678
- errorMsg: string
679
- errorCode: string | number
680
- innerError: {
681
- errorCode: string | number
682
- errorMsg: string
683
- }
684
- }) => void
685
- }): void
686
-
687
- /**
688
- * 获取当前系统音量
689
- */
690
- export function getCurrentVolume(params?: {
691
- complete?: () => void
692
- success?: (params: {
693
- /** 音量,阈值【0 - 1】 */
694
- value: number
695
- }) => void
696
- fail?: (params: {
697
- errorMsg: string
698
- errorCode: string | number
699
- innerError: {
700
- errorCode: string | number
701
- errorMsg: string
702
- }
703
- }) => void
704
- }): void
705
-
706
- /**
707
- * 注册系统音量监听
708
- *
709
- *关联API:[onSystemVolumeChangeEvent, unRegisterSystemVolumeChange]
710
- */
711
- export function registerSystemVolumeChange(params?: {
712
- complete?: () => void
713
- success?: (params: null) => void
714
- fail?: (params: {
715
- errorMsg: string
716
- errorCode: string | number
717
- innerError: {
718
- errorCode: string | number
719
- errorMsg: string
720
- }
721
- }) => void
722
- }): void
723
-
724
- /**
725
- * 取消注册系统音量监听
726
- *
727
- *关联API:[onSystemVolumeChangeEvent, registerSystemVolumeChange]
728
- */
729
- export function unRegisterSystemVolumeChange(params?: {
730
- complete?: () => void
731
- success?: (params: null) => void
732
- fail?: (params: {
733
- errorMsg: string
734
- errorCode: string | number
735
- innerError: {
736
- errorCode: string | number
737
- errorMsg: string
738
- }
739
- }) => void
740
- }): void
741
-
742
- /**
743
- * 获取设备设置
744
- */
745
- export function getSystemSetting(params?: {
746
- complete?: () => void
747
- success?: (params: {
748
- /** 蓝牙的系统开关,默认false */
749
- bluetoothEnabled?: boolean
750
- /** 地理位置的系统开关,默认false */
751
- locationEnabled?: boolean
752
- /** Wi-Fi 的系统开关,默认false */
753
- wifiEnabled?: boolean
754
- /**
755
- * 设备方向, 默认竖屏
756
- * 竖屏 = "portrait", 横屏 = "landscape"
757
- */
758
- deviceOrientation?: string
759
- }) => void
760
- fail?: (params: {
761
- errorMsg: string
762
- errorCode: string | number
763
- innerError: {
764
- errorCode: string | number
765
- errorMsg: string
766
- }
767
- }) => void
768
- }): void
769
-
770
- /**
771
- * 获取设备基础信息
772
- */
773
- export function getDeviceInfo(params?: {
774
- complete?: () => void
775
- success?: (params: {
776
- /** 应用二进制接口类型(仅 Android 支持) */
777
- abi: string
778
- /** 设备品牌 */
779
- brand: string
780
- /** 设备型号。新机型刚推出一段时间会显示unknown。 */
781
- model: string
782
- /** 操作系统及版本 */
783
- system: string
784
- /** 客户端平台 */
785
- platform: string
786
- }) => void
787
- fail?: (params: {
788
- errorMsg: string
789
- errorCode: string | number
790
- innerError: {
791
- errorCode: string | number
792
- errorMsg: string
793
- }
794
- }) => void
508
+ fail?: (params: {}) => void
795
509
  }): void
796
510
 
797
511
  /**
@@ -871,76 +585,6 @@ declare namespace ty {
871
585
  deviceOrientation?: Orientation
872
586
  }
873
587
 
874
- /**
875
- * 获取手机附近的Wi-Fi列表;列表数据通过onGetWifiList事件发送
876
- */
877
- export function getWifiList(params?: {
878
- complete?: () => void
879
- success?: (params: null) => void
880
- fail?: (params: {
881
- errorMsg: string
882
- errorCode: string | number
883
- innerError: {
884
- errorCode: string | number
885
- errorMsg: string
886
- }
887
- }) => void
888
- }): void
889
-
890
- /**
891
- * 获取当前连接的wifi信息
892
- *iOS: 返回SSID和BSSID
893
- */
894
- export function getConnectedWifi(params?: {
895
- /**
896
- * 是否需要返回部分 Wi-Fi 信息
897
- * 安卓 thing.getConnectedWifi 若设置了 partialInfo:true ,将会返回只包含 SSID 属性的 WifiInfo 对象。
898
- * iOS thing.getConnectedWifi 若设置了 partialInfo:true ,将会返回只包含 SSID、BSSID 属性的 WifiInfo 对象,且需要用户开启微信定位权限才能正确返回结果。
899
- * 默认值:false
900
- */
901
- partialInfo?: boolean
902
- complete?: () => void
903
- success?: (params: {
904
- /** wifi的SSID */
905
- SSID: string
906
- /** wifi的BSSID */
907
- BSSID: string
908
- /** Wi-Fi 信号强度, 安卓取值 0 ~ 100 ,iOS 取值 0 ~ 1 ,值越大强度越大 */
909
- signalStrength: number
910
- /**
911
- * Wi-Fi是否安全
912
- * Android:Android系统12开始支持。
913
- */
914
- secure: boolean
915
- /** Wi-Fi 频段单位 MHz */
916
- frequency: number
917
- }) => void
918
- fail?: (params: {
919
- errorMsg: string
920
- errorCode: string | number
921
- innerError: {
922
- errorCode: string | number
923
- errorMsg: string
924
- }
925
- }) => void
926
- }): void
927
-
928
- /**
929
- * 跳转系统蓝牙设置页 (仅Android)
930
- */
931
- export function openSystemBluetoothSetting(params?: {
932
- complete?: () => void
933
- success?: (params: null) => void
934
- fail?: (params: {
935
- errorMsg: string
936
- errorCode: string | number
937
- innerError: {
938
- errorCode: string | number
939
- errorMsg: string
940
- }
941
- }) => void
942
- }): void
943
-
944
588
  /**
945
589
  * 获取网络类型
946
590
  */
@@ -952,14 +596,7 @@ declare namespace ty {
952
596
  /** 信号强弱,单位 dbm */
953
597
  signalStrength: number
954
598
  }) => void
955
- fail?: (params: {
956
- errorMsg: string
957
- errorCode: string | number
958
- innerError: {
959
- errorCode: string | number
960
- errorMsg: string
961
- }
962
- }) => void
599
+ fail?: (params: {}) => void
963
600
  }): void
964
601
 
965
602
  /**
@@ -1180,39 +817,13 @@ declare namespace ty {
1180
817
  */
1181
818
  export function clearStorageSync(): null
1182
819
 
1183
- /**
1184
- * 系统音量监听通知事件
1185
- *
1186
- *关联API:[registerSystemVolumeChange, unRegisterSystemVolumeChange]
1187
- */
1188
- export function onSystemVolumeChangeEvent(listener: (params: CurrentVolumeResponse) => void): void
1189
-
1190
- /**
1191
- * 取消监听:系统音量监听通知事件
1192
- *
1193
- *关联API:[registerSystemVolumeChange, unRegisterSystemVolumeChange]
1194
- */
1195
- export function offSystemVolumeChangeEvent(
1196
- listener: (params: CurrentVolumeResponse) => void
1197
- ): void
1198
-
1199
- /**
1200
- * 监听获取到 Wi-Fi 列表数据事件
1201
- */
1202
- export function onGetWifiList(listener: (params: WifiListResponse) => void): void
1203
-
1204
- /**
1205
- * 取消监听:监听获取到 Wi-Fi 列表数据事件
1206
- */
1207
- export function offGetWifiList(listener: (params: WifiListResponse) => void): void
1208
-
1209
820
  /**
1210
821
  * 持续录音事件
1211
822
  */
1212
823
  export function onRecordingEvent(listener: (params: AudioRecordBufferBean) => void): void
1213
824
 
1214
825
  /**
1215
- * 取消监听:持续录音事件
826
+ * 持续录音事件
1216
827
  */
1217
828
  export function offRecordingEvent(listener: (params: AudioRecordBufferBean) => void): void
1218
829
 
@@ -1456,93 +1067,6 @@ declare namespace ty {
1456
1067
  receivedBytedCount: number
1457
1068
  }
1458
1069
 
1459
- export type FileReadFileReqBean = {
1460
- /** 要写入的文件路径 (本地路径) */
1461
- filePath: string
1462
- /**
1463
- * 指定读取文件的字符编码。
1464
- * 支持 utf8/ascii/base64。如果不传 encoding,默认utf8
1465
- */
1466
- encoding?: string
1467
- /** 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
1468
- position?: number
1469
- /** 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
1470
- length?: number
1471
- }
1472
-
1473
- export type SaveFileSyncParams = {
1474
- /** taskId */
1475
- fileId: string
1476
- /** 临时存储文件路径 */
1477
- tempFilePath: string
1478
- /** 要存储的文件路径 */
1479
- filePath: string
1480
- }
1481
-
1482
- export type FileStats = {
1483
- /** 文件的类型和存取的权限 */
1484
- mode: string
1485
- /** 文件大小,单位:B */
1486
- size: number
1487
- /** 文件最近一次被存取或被执行的时间,UNIX 时间戳 */
1488
- lastAccessedTime: number
1489
- /** 文件最后一次被修改的时间,UNIX 时间戳 */
1490
- lastModifiedTime: number
1491
- /** 当前文件是否一个目录 */
1492
- isDirectory: boolean
1493
- /** 当前文件是否一个普通文件 */
1494
- isFile: boolean
1495
- }
1496
-
1497
- export type FileStatsParams = {
1498
- /** taskId */
1499
- fileId: string
1500
- /** 文件/目录路径 (本地路径) */
1501
- path: string
1502
- /**
1503
- * 是否递归获取目录下的每个文件的 Stats 信息
1504
- * 默认值:false
1505
- */
1506
- recursive?: boolean
1507
- }
1508
-
1509
- export type MakeDirParams = {
1510
- /** taskId */
1511
- fileId: string
1512
- /** 创建的目录路径 (本地路径) */
1513
- dirPath: string
1514
- /**
1515
- * 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。
1516
- * 如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,
1517
- * 以此类推直至创建 a/b/c 目录下的 d 目录。
1518
- * 默认值:false
1519
- */
1520
- recursive?: boolean
1521
- }
1522
-
1523
- export type RemoveDirParams = {
1524
- /** taskId */
1525
- fileId: string
1526
- /** 要删除的目录路径 (本地路径) */
1527
- dirPath: string
1528
- /**
1529
- * 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。
1530
- * 默认值:false
1531
- */
1532
- recursive?: boolean
1533
- }
1534
-
1535
- export type WriteFileParams = {
1536
- /** taskId */
1537
- fileId: string
1538
- /** 要写入的文件路径 (本地路径) */
1539
- filePath: string
1540
- /** 要写入的文本数据, 根据encoding编码 */
1541
- data: string
1542
- /** 指定写入文件的字符编码,目前支持【utf8、ascii、base64】, 默认utf8 */
1543
- encoding?: string
1544
- }
1545
-
1546
1070
  export enum HTTPMethod {
1547
1071
  /** HTTP 请求 OPTIONS */
1548
1072
  OPTIONS = 'OPTIONS',
@@ -1609,27 +1133,6 @@ declare namespace ty {
1609
1133
  size?: number
1610
1134
  }
1611
1135
 
1612
- export type TempMediaFileCB = {
1613
- /** 本地临时文件路径 (本地路径) */
1614
- tempFilePath: string
1615
- /** 本地临时文件大小,单位 B */
1616
- size: number
1617
- /** 视频的时间长度 */
1618
- duration: number
1619
- /** 视频的高度 */
1620
- height: number
1621
- /** 视频的宽度 */
1622
- width: number
1623
- /** 视频缩略图临时文件路径 */
1624
- thumbTempFilePath: string
1625
- /**
1626
- * 文件类型
1627
- * 'image' 图片
1628
- * 'video' 视频
1629
- */
1630
- fileType: string
1631
- }
1632
-
1633
1136
  export type SafeArea = {
1634
1137
  left: number
1635
1138
  right: number
@@ -1663,36 +1166,11 @@ declare namespace ty {
1663
1166
  key: string
1664
1167
  }
1665
1168
 
1666
- export type CurrentVolumeResponse = {
1667
- /** 音量,阈值【0 - 1】 */
1668
- value: number
1669
- }
1670
-
1671
- export type WifiListResponse = {
1672
- /** Wi-Fi列表 */
1673
- wifiList: WifiInfo[]
1674
- }
1675
-
1676
1169
  export type AudioRecordBufferBean = {
1677
1170
  /** 数据流 */
1678
1171
  buffer: number[]
1679
1172
  }
1680
1173
 
1681
- export type InnerAudioContext = {
1682
- /** InnerAudioContext 对象 ContextId */
1683
- contextId: string
1684
- }
1685
-
1686
- export type AudioFileParams = {
1687
- /** 音频文件路径 */
1688
- path: string
1689
- }
1690
-
1691
- export type AudioFileResponse = {
1692
- /** 音频时长 */
1693
- duration: number
1694
- }
1695
-
1696
1174
  export type InnerAudioBean = {
1697
1175
  /**
1698
1176
  * InnerAudioContext 对象 contextId
@@ -1716,8 +1194,13 @@ declare namespace ty {
1716
1194
  export type InnerAudioSeekBean = {
1717
1195
  /** InnerAudioContext 对象 ContextId */
1718
1196
  contextId: string
1719
- /** 跳转的时间,单位 s。精确到小数点后 3 位,即支持 ms 级别精确度 */
1720
- position?: number
1197
+ /** 跳转的时间,单位 s。精确到小数点后 3 位,即支持 ms 级别精确度 */
1198
+ position?: number
1199
+ }
1200
+
1201
+ export type InnerAudioContext = {
1202
+ /** InnerAudioContext 对象 ContextId */
1203
+ contextId: string
1721
1204
  }
1722
1205
 
1723
1206
  export type AuthorizeBean = {
@@ -1740,8 +1223,6 @@ declare namespace ty {
1740
1223
  appId?: string
1741
1224
  /** 打开的页面路径,如果为空则打开首页,path 中 ? 后面的部分会成为 query,在小程序的 `App.onLaunch`、`App.onShow` 和 `Page.onLoad` 的回调函数 */
1742
1225
  path?: string
1743
- /** 打开小程序的转场方式,分为right|bottom,指代水平和竖直方向 */
1744
- position?: string
1745
1226
  /** 传递给目标小程序的数据,目标小程序可在 `App.onLaunch`,`App.onShow` 中获取到这份数据 */
1746
1227
  extraData?: Record<string, any>
1747
1228
  /** 要打开的小程序版本。仅在当前小程序为开发版或体验版时此参数有效。如果当前小程序是正式版,则打开的小程序必定是正式版 */
@@ -1784,9 +1265,15 @@ declare namespace ty {
1784
1265
  requestId: string
1785
1266
  }
1786
1267
 
1787
- export type AccessFileParams = {
1788
- /** 要判断是否存在的文件/目录路径 (本地路径) */
1789
- path: string
1268
+ export type FileReadFileReqBean = {
1269
+ /** 要写入的文件路径 (本地路径) */
1270
+ filePath: string
1271
+ /** 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容 */
1272
+ encoding: string
1273
+ /** 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
1274
+ position: number
1275
+ /** 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
1276
+ length: number
1790
1277
  }
1791
1278
 
1792
1279
  export type ReadFileBean = {
@@ -1794,21 +1281,23 @@ declare namespace ty {
1794
1281
  data: string
1795
1282
  }
1796
1283
 
1284
+ export type SaveFileSyncParams = {
1285
+ /** taskId */
1286
+ fileId: string
1287
+ /** 临时存储文件路径 */
1288
+ tempFilePath: string
1289
+ /** 要存储的文件路径 */
1290
+ filePath: string
1291
+ }
1292
+
1797
1293
  export type SaveFileSyncCallback = {
1798
1294
  /** 【待废弃, 不建议使用】存储后的文件路径 */
1799
1295
  savedFilePath: string
1800
1296
  }
1801
1297
 
1802
- export type FileStatsResponse = {
1803
- /** 文件列表 */
1804
- fileStatsList: FileStats[]
1805
- }
1806
-
1807
- export type RemoveFileParams = {
1808
- /** taskId */
1809
- fileId: string
1810
- /** 需要删除的文件路径 (本地路径) */
1811
- filePath: string
1298
+ export type GetTempDirectoryCallback = {
1299
+ /** 【待废弃, 不建议使用】临时文件夹路径 */
1300
+ tempDirectory: string
1812
1301
  }
1813
1302
 
1814
1303
  export type GyroscopeBean = {
@@ -1832,39 +1321,6 @@ declare namespace ty {
1832
1321
  tempFiles?: TempFileCB[]
1833
1322
  }
1834
1323
 
1835
- export type ChooseMediaBean = {
1836
- /** 最多可以选择的文件数 */
1837
- count?: number
1838
- /**
1839
- * 选择类型, 默认图片
1840
- * 'image' 只能拍摄图片或从相册选择图片
1841
- * 'video' 只能拍摄视频或从相册选择视频
1842
- */
1843
- mediaType?: string
1844
- /**
1845
- * 图片和视频选择的来源, 默认['album', 'camera']
1846
- * 'album' 从相册选择
1847
- * 'camera' 使用相机拍摄
1848
- */
1849
- sourceType?: string[]
1850
- /**
1851
- * 拍摄视频最长拍摄时间,单位秒。默认10s
1852
- * 时间范围为 3s 至 60s 之间。不限制相册。
1853
- */
1854
- maxDuration?: number
1855
- }
1856
-
1857
- export type ChooseMediaCB = {
1858
- /**
1859
- * 文件类型
1860
- * 'image' 图片
1861
- * 'video' 视频
1862
- */
1863
- type: string
1864
- /** 本地临时文件列表 */
1865
- tempFiles?: TempMediaFileCB[]
1866
- }
1867
-
1868
1324
  export type ChooseCropImageBean = {
1869
1325
  /** 选择图片的来源 ['album', 'camera'],默认都支持 */
1870
1326
  sourceType?: string[]
@@ -1882,81 +1338,6 @@ declare namespace ty {
1882
1338
  current: number
1883
1339
  }
1884
1340
 
1885
- export type GetImageInfoParams = {
1886
- /** 图片的路径,支持网络路径、本地路径 */
1887
- src: string
1888
- }
1889
-
1890
- export type ImageInfoCB = {
1891
- /** 图片原始宽度,单位px。不考虑旋转。 */
1892
- width: number
1893
- /** 图片原始高度,单位px。不考虑旋转。 */
1894
- height: number
1895
- /**
1896
- * 拍照时设备方向
1897
- * 合法值 说明
1898
- * up 默认方向(手机横持拍照),对应 Exif 中的 1。或无 orientation 信息。
1899
- * up-mirrored 同 up,但镜像翻转,对应 Exif 中的 2
1900
- * down 旋转180度,对应 Exif 中的 3
1901
- * down-mirrored 同 down,但镜像翻转,对应 Exif 中的 4
1902
- * left-mirrored 同 left,但镜像翻转,对应 Exif 中的 5
1903
- * right 顺时针旋转90度,对应 Exif 中的 6
1904
- * right-mirrored 同 right,但镜像翻转,对应 Exif 中的 7
1905
- * left 逆时针旋转90度,对应 Exif 中的 8
1906
- */
1907
- orientation: string
1908
- /**
1909
- * 图片格式。
1910
- * 合法值 说明
1911
- * unknown 未知格式
1912
- * jpeg jpeg压缩格式
1913
- * png png压缩格式
1914
- * gif gif压缩格式
1915
- * tiff tiff压缩格式
1916
- */
1917
- type: string
1918
- }
1919
-
1920
- export type GetVideoInfoParams = {
1921
- /** 视频文件路径,可以是临时文件路径也可以是永久文件路径 */
1922
- src: string
1923
- }
1924
-
1925
- export type VideoInfoCB = {
1926
- /** 图片原始宽度,单位px。不考虑旋转。 */
1927
- width: number
1928
- /** 图片原始高度,单位px。不考虑旋转。 */
1929
- height: number
1930
- /**
1931
- * 画面方向
1932
- * 合法值 说明
1933
- * up 默认方向(手机横持拍照),对应 Exif 中的 1。或无 orientation 信息。
1934
- * up-mirrored 同 up,但镜像翻转,对应 Exif 中的 2
1935
- * down 旋转180度,对应 Exif 中的 3
1936
- * down-mirrored 同 down,但镜像翻转,对应 Exif 中的 4
1937
- * left-mirrored 同 left,但镜像翻转,对应 Exif 中的 5
1938
- * right 顺时针旋转90度,对应 Exif 中的 6
1939
- * right-mirrored 同 right,但镜像翻转,对应 Exif 中的 7
1940
- * left 逆时针旋转90度,对应 Exif 中的 8
1941
- */
1942
- orientation: string
1943
- /** 视频格式 */
1944
- type: string
1945
- /** 视频时长 */
1946
- duration: number
1947
- /** 视频大小,单位 kB */
1948
- size: number
1949
- /** 视频帧率 */
1950
- fps: number
1951
- /** 视频码率,单位 kbps */
1952
- bitrate: number
1953
- }
1954
-
1955
- export type SaveVideoParams = {
1956
- /** 视频文件路径,可以是临时文件路径也可以是永久文件路径 (本地路径) */
1957
- filePath: string
1958
- }
1959
-
1960
1341
  export type ToastBean = {
1961
1342
  /** 提示的内容 */
1962
1343
  title: string
@@ -1988,6 +1369,8 @@ declare namespace ty {
1988
1369
  }
1989
1370
 
1990
1371
  export type ModalCallback = {
1372
+ /** editable 为 true 时,用户输入的文本 */
1373
+ content?: string
1991
1374
  /** 为 true 时,表示用户点击了确定按钮 */
1992
1375
  confirm: boolean
1993
1376
  /** 为 true 时,表示用户点击了取消(用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭) */
@@ -2070,54 +1453,6 @@ declare namespace ty {
2070
1453
  data: string
2071
1454
  }
2072
1455
 
2073
- export type WifiInfo = {
2074
- /** wifi的SSID */
2075
- SSID: string
2076
- /** wifi的BSSID */
2077
- BSSID: string
2078
- /** Wi-Fi 信号强度, 安卓取值 0 ~ 100 ,iOS 取值 0 ~ 1 ,值越大强度越大 */
2079
- signalStrength: number
2080
- /**
2081
- * Wi-Fi是否安全
2082
- * Android:Android系统12开始支持。
2083
- */
2084
- secure: boolean
2085
- /** Wi-Fi 频段单位 MHz */
2086
- frequency: number
2087
- }
2088
-
2089
- export type UpdateVolumeParams = {
2090
- /** 音量,阈值【0 - 1】 */
2091
- value: number
2092
- }
2093
-
2094
- export type SystemSetting = {
2095
- /** 蓝牙的系统开关,默认false */
2096
- bluetoothEnabled?: boolean
2097
- /** 地理位置的系统开关,默认false */
2098
- locationEnabled?: boolean
2099
- /** Wi-Fi 的系统开关,默认false */
2100
- wifiEnabled?: boolean
2101
- /**
2102
- * 设备方向, 默认竖屏
2103
- * 竖屏 = "portrait", 横屏 = "landscape"
2104
- */
2105
- deviceOrientation?: string
2106
- }
2107
-
2108
- export type DeviceInfoResponse = {
2109
- /** 应用二进制接口类型(仅 Android 支持) */
2110
- abi: string
2111
- /** 设备品牌 */
2112
- brand: string
2113
- /** 设备型号。新机型刚推出一段时间会显示unknown。 */
2114
- model: string
2115
- /** 操作系统及版本 */
2116
- system: string
2117
- /** 客户端平台 */
2118
- platform: string
2119
- }
2120
-
2121
1456
  export type SystemInfo = {
2122
1457
  is24Hour: boolean
2123
1458
  system: string
@@ -2148,16 +1483,6 @@ declare namespace ty {
2148
1483
  deviceOrientation?: Orientation
2149
1484
  }
2150
1485
 
2151
- export type GetConnectedWifiParams = {
2152
- /**
2153
- * 是否需要返回部分 Wi-Fi 信息
2154
- * 安卓 thing.getConnectedWifi 若设置了 partialInfo:true ,将会返回只包含 SSID 属性的 WifiInfo 对象。
2155
- * iOS thing.getConnectedWifi 若设置了 partialInfo:true ,将会返回只包含 SSID、BSSID 属性的 WifiInfo 对象,且需要用户开启微信定位权限才能正确返回结果。
2156
- * 默认值:false
2157
- */
2158
- partialInfo?: boolean
2159
- }
2160
-
2161
1486
  export type NetworkTypeCB = {
2162
1487
  /** 网络类型 */
2163
1488
  networkType: string
@@ -2175,7 +1500,7 @@ declare namespace ty {
2175
1500
  keepScreenOn: boolean
2176
1501
  }
2177
1502
 
2178
- export type TUNIVibrateBean = {
1503
+ export type TYUniVibrateBean = {
2179
1504
  /** 震动强度类型,有效值为:heavy、medium、light */
2180
1505
  type: string
2181
1506
  }
@@ -2269,38 +1594,6 @@ declare namespace ty {
2269
1594
  * 创建内部audio上下文InnerAudioContext对象
2270
1595
  */
2271
1596
  interface CreateInnerAudioContextTask {
2272
- /**
2273
- * 暂停
2274
- */
2275
- pause(params: {
2276
- complete?: () => void
2277
- success?: (params: null) => void
2278
- fail?: (params: {
2279
- errorMsg: string
2280
- errorCode: string | number
2281
- innerError: {
2282
- errorCode: string | number
2283
- errorMsg: string
2284
- }
2285
- }) => void
2286
- }): void
2287
-
2288
- /**
2289
- * 恢复
2290
- */
2291
- resume(params: {
2292
- complete?: () => void
2293
- success?: (params: null) => void
2294
- fail?: (params: {
2295
- errorMsg: string
2296
- errorCode: string | number
2297
- innerError: {
2298
- errorCode: string | number
2299
- errorMsg: string
2300
- }
2301
- }) => void
2302
- }): void
2303
-
2304
1597
  /**
2305
1598
  * 播放
2306
1599
  */
@@ -2378,18 +1671,6 @@ declare namespace ty {
2378
1671
  }
2379
1672
  }) => void
2380
1673
  }): void
2381
-
2382
- /**
2383
- * 监听音频播放进度更新事件
2384
- */
2385
- onTimeUpdate(
2386
- listener: (params: {
2387
- /** InnerAudioContext 对象 ContextId */
2388
- contextId: string
2389
- /** 播放进度 【0 - 1】 */
2390
- time: number
2391
- }) => void
2392
- ): void
2393
1674
  }
2394
1675
  export function createInnerAudioContext(params?: {
2395
1676
  complete?: () => void
@@ -2514,66 +1795,10 @@ declare namespace ty {
2514
1795
  * 文件管理器
2515
1796
  */
2516
1797
  interface GetFileSystemManagerTask {
2517
- /**
2518
- * 判断文件/目录是否存在
2519
- */
2520
- access(params: {
2521
- /** 要判断是否存在的文件/目录路径 (本地路径) */
2522
- path: string
2523
- complete?: () => void
2524
- success?: (params: null) => void
2525
- fail?: (params: {
2526
- errorMsg: string
2527
- errorCode: string | number
2528
- innerError: {
2529
- errorCode: string | number
2530
- errorMsg: string
2531
- }
2532
- }) => void
2533
- }): void
2534
-
2535
- /**
2536
- * 读取本地文件内容
2537
- */
2538
- readFile(params: {
2539
- /** 要写入的文件路径 (本地路径) */
2540
- filePath: string
2541
- /**
2542
- * 指定读取文件的字符编码。
2543
- * 支持 utf8/ascii/base64。如果不传 encoding,默认utf8
2544
- */
2545
- encoding?: string
2546
- /** 从文件指定位置开始读,如果不指定,则从文件头开始读。读取的范围应该是左闭右开区间 [position, position+length)。有效范围:[0, fileLength - 1]。单位:byte */
2547
- position?: number
2548
- /** 指定文件的长度,如果不指定,则读到文件末尾。有效范围:[1, fileLength]。单位:byte */
2549
- length?: number
2550
- complete?: () => void
2551
- success?: (params: {
2552
- /** 文件内容 */
2553
- data: string
2554
- }) => void
2555
- fail?: (params: {
2556
- errorMsg: string
2557
- errorCode: string | number
2558
- innerError: {
2559
- errorCode: string | number
2560
- errorMsg: string
2561
- }
2562
- }) => void
2563
- }): void
2564
-
2565
- /**
2566
- * 读取本地文件内容
2567
- */
2568
- readFileSync(req?: FileReadFileReqBean): {
2569
- /** 文件内容 */
2570
- data: string
2571
- }
2572
-
2573
1798
  /**
2574
1799
  * 文件保存的同步方法, 在完成文件保存后调用回调, 需要与getTempDirectory配合使用, 目标路径会校验是否包含getTempDirectory前缀
2575
1800
  */
2576
- saveFile(params: {
1801
+ saveFileSync(params: {
2577
1802
  /** 临时存储文件路径 */
2578
1803
  tempFilePath: string
2579
1804
  /** 要存储的文件路径 */
@@ -2592,151 +1817,6 @@ declare namespace ty {
2592
1817
  }
2593
1818
  }) => void
2594
1819
  }): void
2595
-
2596
- /**
2597
- * 文件保存的同步方法, 在完成文件保存后调用回调, 需要与getTempDirectory配合使用, 目标路径会校验是否包含getTempDirectory前缀
2598
- */
2599
- saveFileSync(params?: SaveFileSyncParams): {
2600
- /** 【待废弃, 不建议使用】存储后的文件路径 */
2601
- savedFilePath: string
2602
- }
2603
-
2604
- /**
2605
- * 获取文件Stats对象,需要文件读写权限
2606
- */
2607
- stat(params: {
2608
- /** 文件/目录路径 (本地路径) */
2609
- path: string
2610
- /**
2611
- * 是否递归获取目录下的每个文件的 Stats 信息
2612
- * 默认值:false
2613
- */
2614
- recursive?: boolean
2615
- complete?: () => void
2616
- success?: (params: {
2617
- /** 文件列表 */
2618
- fileStatsList: FileStats[]
2619
- }) => void
2620
- fail?: (params: {
2621
- errorMsg: string
2622
- errorCode: string | number
2623
- innerError: {
2624
- errorCode: string | number
2625
- errorMsg: string
2626
- }
2627
- }) => void
2628
- }): void
2629
-
2630
- /**
2631
- * 获取文件Stats对象,需要文件读写权限
2632
- */
2633
- statSync(params?: FileStatsParams): {
2634
- /** 文件列表 */
2635
- fileStatsList: FileStats[]
2636
- }
2637
-
2638
- /**
2639
- * 创建目录,需要文件读写权限
2640
- */
2641
- mkdir(params: {
2642
- /** 创建的目录路径 (本地路径) */
2643
- dirPath: string
2644
- /**
2645
- * 是否在递归创建该目录的上级目录后再创建该目录。如果对应的上级目录已经存在,则不创建该上级目录。
2646
- * 如 dirPath 为 a/b/c/d 且 recursive 为 true,将创建 a 目录,再在 a 目录下创建 b 目录,
2647
- * 以此类推直至创建 a/b/c 目录下的 d 目录。
2648
- * 默认值:false
2649
- */
2650
- recursive?: boolean
2651
- complete?: () => void
2652
- success?: (params: null) => void
2653
- fail?: (params: {
2654
- errorMsg: string
2655
- errorCode: string | number
2656
- innerError: {
2657
- errorCode: string | number
2658
- errorMsg: string
2659
- }
2660
- }) => void
2661
- }): void
2662
-
2663
- /**
2664
- * 创建目录,需要文件读写权限
2665
- */
2666
- mkdirSync(params?: MakeDirParams): null
2667
-
2668
- /**
2669
- * 删除目录,需要文件读写权限
2670
- */
2671
- rmdir(params: {
2672
- /** 要删除的目录路径 (本地路径) */
2673
- dirPath: string
2674
- /**
2675
- * 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。
2676
- * 默认值:false
2677
- */
2678
- recursive?: boolean
2679
- complete?: () => void
2680
- success?: (params: null) => void
2681
- fail?: (params: {
2682
- errorMsg: string
2683
- errorCode: string | number
2684
- innerError: {
2685
- errorCode: string | number
2686
- errorMsg: string
2687
- }
2688
- }) => void
2689
- }): void
2690
-
2691
- /**
2692
- * 删除目录,需要文件读写权限
2693
- */
2694
- rmdirSync(params?: RemoveDirParams): null
2695
-
2696
- /**
2697
- * 写文件,需要文件读写权限
2698
- */
2699
- writeFile(params: {
2700
- /** 要写入的文件路径 (本地路径) */
2701
- filePath: string
2702
- /** 要写入的文本数据, 根据encoding编码 */
2703
- data: string
2704
- /** 指定写入文件的字符编码,目前支持【utf8、ascii、base64】, 默认utf8 */
2705
- encoding?: string
2706
- complete?: () => void
2707
- success?: (params: null) => void
2708
- fail?: (params: {
2709
- errorMsg: string
2710
- errorCode: string | number
2711
- innerError: {
2712
- errorCode: string | number
2713
- errorMsg: string
2714
- }
2715
- }) => void
2716
- }): void
2717
-
2718
- /**
2719
- * 写文件,需要文件读写权限
2720
- */
2721
- writeFileSync(params?: WriteFileParams): null
2722
-
2723
- /**
2724
- * 删除已保存的本地缓存文件,需要文件读写权限
2725
- */
2726
- removeSavedFile(params: {
2727
- /** 需要删除的文件路径 (本地路径) */
2728
- filePath: string
2729
- complete?: () => void
2730
- success?: (params: null) => void
2731
- fail?: (params: {
2732
- errorMsg: string
2733
- errorCode: string | number
2734
- innerError: {
2735
- errorCode: string | number
2736
- errorMsg: string
2737
- }
2738
- }) => void
2739
- }): void
2740
1820
  }
2741
1821
  export function getFileSystemManager(params?: {
2742
1822
  complete?: () => void