@hyext/types-ext-sdk-hy 3.16.0 → 3.16.1-beta.1

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 (2) hide show
  1. package/index.d.ts +865 -1020
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -225,731 +225,6 @@ type SysConfig = {
225
225
  */
226
226
  function getConfig(): SysConfig;
227
227
 
228
- /**
229
- * 扩展加载完成回调
230
- * @param callback - 回调函数
231
- */
232
- function onLoad(callback: (...params: any[]) => any): void;
233
-
234
- function onUnload(callback: (...params: any[]) => any): void;
235
-
236
- /**
237
- * 注册App进入前台时回调
238
- */
239
- function onEnterForeground(callback: (...params: any[]) => any): void;
240
-
241
- /**
242
- * 注册App进入后台时回调
243
- */
244
- function onLeaveForeground(callback: (...params: any[]) => any): void;
245
-
246
- /**
247
- * 小程序显示的生命周期
248
- */
249
- function onAppear(callback: (...params: any[]) => any): void;
250
-
251
- /**
252
- * 小程序隐藏的生命周期
253
- */
254
- function onDisappear(callback: (...params: any[]) => any): void;
255
-
256
- /**
257
- * 后台
258
- */
259
- namespace backend {
260
- /**
261
- * 通用查询后台状态接口
262
- * @param params.key - 关键字
263
- * @param params.param - 参数
264
- */
265
- function commonQuery(params: {
266
- key: string;
267
- param: any;
268
- }): void;
269
- /**
270
- * 通用查询后台状态接口
271
- * @param params.key - 关键字
272
- * @param params.param - 参数
273
- */
274
- function commonQuery(params: {
275
- key: string;
276
- param: any;
277
- }): void;
278
- /**
279
- * 通用上行接口
280
- * @param params - 操作选项
281
- * @returns 返回结果
282
- */
283
- function commonOperate(params: DiyOptions): Promise<CommonOperateResp>;
284
- }
285
-
286
- /**
287
- * 直播间事件
288
- */
289
- namespace context {
290
- /**
291
- * 监听直播间消息
292
- * @param topic - 消息名
293
- * @param callback - 收到消息时回调 返回消息内容
294
- */
295
- function on(topic: string, callback: (...params: any[]) => any): void;
296
- /**
297
- * 取消监听直播间消息
298
- * @param topic - 消息名
299
- * @param callback - 收到消息时回调 返回消息内容
300
- */
301
- function off(topic: string, callback: (...params: any[]) => any): void;
302
- /**
303
- * 获取用户信息,目前返回昵称、头像信息
304
- * @returns 返回用户信息,{ userNick, userAvatar }
305
- */
306
- function getUserInfo(): Promise<object>;
307
- /**
308
- * 获取安全区域的位置
309
- * @returns 返回安全区域位置 left, top, right, bottom
310
- */
311
- function getSafeAreaPosition(): Promise<object>;
312
- /**
313
- * 显示红点
314
- * @returns 返回是否显示成功
315
- */
316
- function showActivityBadge(): Promise<object>;
317
- /**
318
- * 显示toast
319
- * @param message - toast中显示的消息
320
- * @returns 返回toast是否显示成功
321
- */
322
- function showToast(message: string): Promise<object>;
323
- /**
324
- * 监听当前直播间小程序容器布局变化消息
325
- */
326
- function onLayoutChange(callback: LayoutChange): void;
327
- /**
328
- * 监听所有弹幕
329
- * @param options - 弹幕筛选
330
- * @param options.sendNick - 用户昵称关键字
331
- * @param options.content - 弹幕内容关键字
332
- * @param options.nobleLevel - 贵族等级
333
- * @param options.fansLevel - 粉丝等级
334
- */
335
- function onBarrageChange(options: {
336
- sendNick: string;
337
- content: string;
338
- nobleLevel: number;
339
- fansLevel: number;
340
- }, callback: BarrageCallback): void;
341
- /**
342
- * 关闭监听所有弹幕
343
- */
344
- function offBarrageChange(): void;
345
- /**
346
- * 监听直播间消息
347
- * @param topic - 消息名
348
- * @param callback - 收到消息时回调 返回消息内容
349
- */
350
- function on(topic: string, callback: (...params: any[]) => any): void;
351
- /**
352
- * 取消监听直播间消息
353
- * @param topic - 消息名
354
- * @param callback - 收到消息时回调 返回消息内容
355
- */
356
- function off(topic: string, callback: (...params: any[]) => any): void;
357
- /**
358
- * 显示红点
359
- * @returns 返回是否显示成功
360
- */
361
- function showActivityBadge(): Promise<object>;
362
- /**
363
- * 显示toast
364
- * @param message - toast中显示的消息
365
- * @returns 返回toast是否显示成功
366
- */
367
- function showToast(message: string): Promise<object>;
368
- /**
369
- * 获取安全区域的位置
370
- * @returns 返回安全区域位置 left, top, right, bottom
371
- */
372
- function getSafeAreaPosition(): Promise<object>;
373
- /**
374
- * 监听当前直播间小程序容器布局变化消息
375
- */
376
- function onLayoutChange(callback: LayoutChange): void;
377
- /**
378
- * 引导订阅
379
- */
380
- function leadSubscribe(): Promise<void>;
381
- /**
382
- * 获取当前直播间礼物配置
383
- * @returns 返回直播间礼物配置
384
- */
385
- function getGiftConf(): Promise<RoomGiftConfig[]>;
386
- /**
387
- * 当前观众送礼
388
- * @param params - 发送礼物信息
389
- */
390
- function sendGift(params: SendGiftInfo): Promise<void>;
391
- /**
392
- * 引导当前观众送礼
393
- * @returns 引导成功返回送礼人信息
394
- */
395
- function leadGift(): Promise<void>;
396
- /**
397
- * 监听当前直播间礼物变化消息
398
- * @param options - 过滤条件
399
- * @param callback - 礼物信息回调
400
- * @returns 操作结果
401
- */
402
- function onGiftChange(options: GiftChangeOptions, callback: GiftChange): Promise<void>;
403
- /**
404
- * 取消监听当前直播间礼物变化消息
405
- * @returns 操作结果
406
- */
407
- function offGiftChange(): Promise<void>;
408
- /**
409
- * 引导当前用户发送弹幕
410
- * @returns 调用结果
411
- */
412
- function leadBarrage(): Promise<void>;
413
- /**
414
- * 监听所有弹幕
415
- * @param options - 弹幕筛选
416
- * @param options.sendNick - 用户昵称关键字
417
- * @param options.content - 弹幕内容关键字
418
- * @param options.nobleLevel - 贵族等级
419
- * @param options.fansLevel - 粉丝等级
420
- */
421
- function onBarrageChange(options: {
422
- sendNick: string;
423
- content: string;
424
- nobleLevel: number;
425
- fansLevel: number;
426
- }, callback: BarrageCallback): void;
427
- /**
428
- * 关闭监听所有弹幕
429
- */
430
- function offBarrageChange(): void;
431
- /**
432
- * 监听开通守护
433
- * @param params - 监听开通守护参数
434
- */
435
- function onOpenGuardianNotice(params: OpenGuardianNoticeParams): Promise<void>;
436
- /**
437
- * 关闭监听开通守护
438
- */
439
- function offOpenGuardianNotice(): Promise<void>;
440
- /**
441
- * 监听开通贵族
442
- * @param params - 监听开通贵族参数
443
- */
444
- function onOpenNobleNotice(params: OnOpenNobleNoticeParams): Promise<void>;
445
- /**
446
- * 关闭监听开通贵族
447
- */
448
- function offOpenNobleNotice(): Promise<void>;
449
- /**
450
- * 监听高级用户进场
451
- * @param params - 参数
452
- */
453
- function onVipEnterBannerNotice(params: VipEnterBannerNoticeParams): Promise<void>;
454
- /**
455
- * 取消监听高级用户进场
456
- */
457
- function offVipEnterBannerNotice(): Promise<void>;
458
- /**
459
- * 监听分享直播间事件
460
- * @param params - 监听分享直播间参数
461
- */
462
- function onShareLiveNotice(params: ShareLiveNoticeParams): Promise<void>;
463
- /**
464
- * 取消监听分享直播间事件
465
- */
466
- function offShareLiveNotice(): Promise<void>;
467
- /**
468
- * 获取当前观众是否订阅当前主播
469
- * @returns 返回是否订阅
470
- */
471
- function getSubscribeInfo(): Promise<boolean>;
472
- /**
473
- * 获取主播信息
474
- * @returns 返回用户信息
475
- */
476
- function getStreamerInfo(): Promise<StreamerInfo>;
477
- /**
478
- * 获取app信息,目前返回app版本、UA(计划废弃)
479
- * @returns 返回app信息
480
- */
481
- function getContextInfo(): Promise<ContextInfo>;
482
- /**
483
- * 获取直播间信息
484
- * @returns 返回直播间信息
485
- */
486
- function getLiveInfo(): Promise<RespLiveInfo>;
487
- /**
488
- * 获取用户信息,目前返回昵称、头像信息
489
- * @returns 返回用户信息,{ userNick, userAvatar }
490
- */
491
- function getUserInfo(): Promise<object>;
492
- /**
493
- * 获取直播间的粉丝榜信息
494
- * @returns 返回直播间粉丝榜信息
495
- */
496
- function getFansRank(): Promise<RankInfo>;
497
- /**
498
- * 获取直播间所有贵宾信息
499
- * @returns 返回直播间所有贵宾信息
500
- */
501
- function getVip(): Promise<VipItem[]>;
502
- /**
503
- * 获取直播间的周贡榜信息
504
- * @returns 返回周贡榜榜单数据
505
- */
506
- function getWeekRank(): Promise<WeekRankItem[]>;
507
- /**
508
- * 设置发送弹幕分组标签
509
- * @param param - 发送弹幕分组标签参数
510
- * @returns 返回设置发送弹幕分组标签是否显示成功
511
- */
512
- function setSendBarrageTag(param: SendBarrageTagParams): Promise<void>;
513
- /**
514
- * 设置显示弹幕分组标签
515
- * @param param - 显示弹幕分组标签参数
516
- * @returns 返回设置显示弹幕分组标签是否显示成功
517
- */
518
- function setDisplayBarrageTags(param: DisplayBarrageTagParams): Promise<void>;
519
- /**
520
- * 分享直播间
521
- * @param params - 分享配置
522
- * @returns 返回分享直播间是否成功
523
- */
524
- function share(params: ShareParams): Promise<void>;
525
- /**
526
- * 获取当前主播的订阅概况
527
- * @returns 订阅者概况
528
- */
529
- function getSubscriberSummary(): Promise<SubscriberSummary>;
530
- /**
531
- * 监听订阅信息改变
532
- * @param options - 订阅信息过滤条件
533
- * @param callback - 订阅信息改变回调
534
- */
535
- function onSubscriberChange(options: SubscriberOptions, callback: SubscriberChangeCallback): Promise<void>;
536
- /**
537
- * 取消监听订阅信息改变
538
- */
539
- function offSubscriberChange(): Promise<void>;
540
- /**
541
- * 获取直播间功能
542
- * @param params - 相关功能的键的数组(可以提供一个或者多个)
543
- * @returns 返回 直播间功能信息(根据参数提供的键会有对应的字段)
544
- */
545
- function getLiveRoomFeatures(params: FeatureKey[]): Promise<Features>;
546
- /**
547
- * 设置直播间功能
548
- * @param params - 相关功能的键以及要设置的参数(可以提供一个键或者多个)
549
- * @returns 功能设置结果(根据参数提供的键会有对应的字段)
550
- */
551
- function setLiveRoomFeatures(params: Features): Promise<FeaturesResp>;
552
- /**
553
- * 使用外部浏览器打开指定URL
554
- * @param params - 请求参数
555
- * @returns 返回结果
556
- */
557
- function openExternalUrl(params: UrlParams): Promise<void>;
558
- /**
559
- * 设置弹幕输入框占位符
560
- * @param params - 请求参数
561
- * @returns 返回结果
562
- */
563
- function setBarrageInputPlaceholder(params: SetBarrageInputPlaceholderReq): Promise<void>;
564
- /**
565
- * 获取登录凭证
566
- * @param [params] - 请求参数
567
- * @returns 返回结果
568
- */
569
- function login(params?: LoginReq): Promise<LoginRsp>;
570
- /**
571
- * 检查登录态是否过期
572
- * @returns 调起成功
573
- */
574
- function checkSession(): Promise<void>;
575
- }
576
-
577
- /**
578
- * @property screenWidth - 容器宽度
579
- * @property screenHeight - 容器高度
580
- * @property isLandscape - 是否横屏,web端固定为true
581
- */
582
- type LayoutInfo = {
583
- screenWidth: number;
584
- screenHeight: number;
585
- isLandscape: boolean;
586
- };
587
-
588
- type LayoutChange = (info: LayoutInfo) => void;
589
-
590
- /**
591
- * @property sendNick - 发言人的昵称
592
- * @property senderAvatarUrl - 发言人的头像地址
593
- * @property senderGender - 发言人的性别
594
- * @property nobleLevel - 发言人的贵族等级
595
- * @property fansLevel - 发言人的粉丝等级
596
- * @property content - 弹幕内容
597
- */
598
- type BarrageData = {
599
- sendNick: string;
600
- senderAvatarUrl: string;
601
- senderGender: number;
602
- nobleLevel: number;
603
- fansLevel: number;
604
- content: string;
605
- };
606
-
607
- /**
608
- * 弹幕信息回调
609
- * @param data - 参数
610
- */
611
- type BarrageCallback = (data: BarrageData) => boolean;
612
-
613
- /**
614
- * 环境信息
615
- */
616
- namespace env {
617
- /**
618
- * 获取当前版本类型
619
- */
620
- function getVersionType(): Promise<VersionInfo>;
621
- /**
622
- * 获取初始化参数
623
- * @returns 初始化参数
624
- */
625
- function getInitialParam(): Promise<object>;
626
- /**
627
- * 获取小程序启动参数
628
- * @returns 小程序启动参数
629
- */
630
- function getExtInfo(): Promise<object>;
631
- /**
632
- * 获取宿主信息接口,使用querystring解析rn bundle的查询串参数,返回给小程序
633
- * @returns 宿主信息
634
- */
635
- function getHostInfo(): Promise<object>;
636
- /**
637
- * 获取当前版本类型
638
- */
639
- function getVersionType(): Promise<VersionInfo>;
640
- /**
641
- * 获取初始化参数
642
- * @returns 初始化参数
643
- */
644
- function getInitialParam(): Promise<object>;
645
- /**
646
- * 获取小程序启动参数
647
- * @returns 小程序启动参数
648
- */
649
- function getExtInfo(): Promise<object>;
650
- /**
651
- * 获取宿主信息接口,使用querystring解析rn bundle的查询串参数,返回给小程序
652
- * @returns 宿主信息
653
- */
654
- function getHostInfo(): Promise<object>;
655
- /**
656
- * 获取性能数据
657
- * @returns 调用结果
658
- */
659
- function getPerformaceData(): Promise<PerformaceDataRsp>;
660
- }
661
-
662
- /**
663
- * @property versionType - 返回当前版本类型,1-开发版本,2-灰度版本,3-正式版本
664
- */
665
- type VersionInfo = {
666
- versionType: number;
667
- };
668
-
669
- /**
670
- * 文件系统
671
- */
672
- namespace fs {
673
- /**
674
- * 调取本地相册
675
- */
676
- function uploadImg(): void;
677
- /**
678
- * 监听离线资源是否下载完成消息
679
- * @param params.url - 资源地址
680
- */
681
- function offlineFileReady(params: {
682
- url: string;
683
- }): Promise<string>;
684
- /**
685
- * 调取本地相册
686
- */
687
- function uploadImg(): void;
688
- /**
689
- * 监听离线资源是否下载完成消息
690
- * @param params.url - 资源地址
691
- */
692
- function offlineFileReady(params: {
693
- url: string;
694
- }): Promise<string>;
695
- /**
696
- * 通用上传文件接口
697
- * @returns 调用结果
698
- */
699
- function uploadFile(): Promise<UrlInfo>;
700
- /**
701
- * 批量下载资源
702
- * @param params - 下载资源信息
703
- * @returns 调用结果
704
- */
705
- function downloadBatchRes(params: BatchRes[]): Promise<void>;
706
- /**
707
- * 删除资源
708
- * @param params - 要删除的资源信息
709
- * @returns 调用结果
710
- */
711
- function removeRes(params: RemoveRes): Promise<void>;
712
- /**
713
- * 判断资源是否存在
714
- * @param params - 要判断的资源信息
715
- * @returns 查询结果结果
716
- */
717
- function isResExists(params: ExistsReq): Promise<ExistsResp>;
718
- /**
719
- * 增强型上传文件
720
- * @param params - 要判断的资源信息
721
- * @returns 查询结果结果
722
- */
723
- function uploadFileExtra(params: FileExtraParams): Promise<FileExtraResp>;
724
- /**
725
- * 批量发起下载共享资源
726
- * @param params - 下载资源信息
727
- * @returns 调用结果
728
- */
729
- function downloadBatchSharedRes(params: BatchSharedRes[]): Promise<void>;
730
- /**
731
- * 判断共享资源是否存在
732
- * @param params - 要判断的资源信息
733
- * @returns 查询结果结果
734
- */
735
- function isSharedResExists(params: BatchSharedRes): Promise<ExistsResp>;
736
- /**
737
- * 清除下载资源
738
- * @param params - 参数
739
- * @returns 结果
740
- */
741
- function cleanRes(params: CleanResParams): Promise<void>;
742
- /**
743
- * 批量保存文件到本地
744
- * @param params - 传入参数
745
- * @returns 调用结果
746
- */
747
- function saveFiles(params: SaveFilesReq): Promise<void>;
748
- /**
749
- * 批量上传文件
750
- * @param params - 参数
751
- * @returns 结果
752
- */
753
- function uploadFiles(params: UploadFilesReq): Promise<void>;
754
- /**
755
- * 选择本地目录
756
- * @param params - 传入参数
757
- * @returns 调用结果
758
- */
759
- function selectDir(params: SelectDirReq): Promise<void>;
760
- /**
761
- * 拍摄或从手机相册中选择图片或视频
762
- * @param params - 传入参数
763
- * @returns 调用结果
764
- */
765
- function chooseMedia(params: ChooseMediaReq): Promise<void>;
766
- }
767
-
768
- /**
769
- * 监听后台消息
770
- */
771
- namespace observer {
772
- /**
773
- * 监听后台消息
774
- * @param topic - 消息名
775
- * @param callback - 收到消息时回调 返回对应消息名的后台消息content
776
- */
777
- function on(topic: string, callback: (...params: any[]) => any): void;
778
- /**
779
- * 取消监听后台消息
780
- * @param topic - 消息名
781
- */
782
- function off(topic: string, callback: (...params: any[]) => any): void;
783
- /**
784
- * 触发小程序消息
785
- */
786
- function emit(topic: string, message: string): Promise<any>;
787
- /**
788
- * 监听自身小程序消息
789
- * @param params.eventName - 消息名
790
- * @param params.callback - 回调
791
- */
792
- function onLocalMessage(params: {
793
- eventName: string;
794
- callback: (...params: any[]) => any;
795
- }): void;
796
- /**
797
- * 取消监听自身小程序消息
798
- * @param params.eventName - 消息名
799
- */
800
- function offLocalMessage(params: {
801
- eventName: string;
802
- }): void;
803
- /**
804
- * 发送小程序消息
805
- * @param params.eventName - 消息名
806
- * @param params.callback - 回调
807
- */
808
- function postLocalMessage(params: {
809
- eventName: string;
810
- callback: (...params: any[]) => any;
811
- }): Promise<any>;
812
- /**
813
- * 监听后台消息
814
- * @param topic - 消息名
815
- * @param callback - 收到消息时回调 返回对应消息名的后台消息content
816
- */
817
- function on(topic: string, callback: (...params: any[]) => any): void;
818
- /**
819
- * 取消监听后台消息
820
- * @param topic - 消息名
821
- */
822
- function off(topic: string, callback: (...params: any[]) => any): void;
823
- /**
824
- * 触发小程序消息
825
- */
826
- function emit(topic: string, message: string): Promise<any>;
827
- /**
828
- * 监听自身小程序消息
829
- * @param params.eventName - 消息名
830
- * @param params.callback - 回调
831
- */
832
- function onLocalMessage(params: {
833
- eventName: string;
834
- callback: (...params: any[]) => any;
835
- }): void;
836
- /**
837
- * 取消监听自身小程序消息
838
- * @param params.eventName - 消息名
839
- */
840
- function offLocalMessage(params: {
841
- eventName: string;
842
- }): void;
843
- /**
844
- * 发送小程序消息
845
- * @param params.eventName - 消息名
846
- * @param params.callback - 回调
847
- */
848
- function postLocalMessage(params: {
849
- eventName: string;
850
- callback: (...params: any[]) => any;
851
- }): Promise<any>;
852
- /**
853
- * 广播开发者维度的本地消息
854
- * @param params - 本地消息参数
855
- * @returns 调用结果
856
- */
857
- function postDevelperLocalMessage(params: PostLocalMessageParams): Promise<void>;
858
- /**
859
- * 监听开发者维度的本地消息
860
- * @param params - 参数
861
- * @returns 调用结果
862
- */
863
- function onDeveloperLocalMessage(params: LocalMessageParams): Promise<void>;
864
- /**
865
- * 取消监听开发者维度的本地消息
866
- * @param params - 参数
867
- * @returns 调用结果
868
- */
869
- function offDeveloperLocalMessage(params: OffLocalMessageParams): Promise<void>;
870
- }
871
-
872
- /**
873
- * 秩序
874
- */
875
- namespace order {
876
- /**
877
- * 发起小程序文本的秩序审核
878
- * @param param - 参数
879
- * @param param.text - 要检查的字符串
880
- */
881
- function reportText(param: {
882
- text: string;
883
- }): void;
884
- /**
885
- * 发起小程序文本的秩序审核
886
- * @param param - 参数
887
- * @param param.text - 要检查的字符串
888
- */
889
- function reportText(param: {
890
- text: string;
891
- }): void;
892
- }
893
-
894
- /**
895
- * 面板
896
- */
897
- namespace panel {
898
- /**
899
- * 改变小程序面板的布局,包括显示位置和显示大小
900
- * @param visible - 是否可见,默认true,
901
- * @param res - 取值 'PLAYER'
902
- * @param x - 横坐标
903
- * @param y - 纵坐标
904
- * @param width - 宽度
905
- * @param height - 高度
906
- */
907
- function setLayout(visible: boolean, res: string, x: number, y: number, width: number, height: number): void;
908
- /**
909
- * 销毁当前小程序
910
- */
911
- function disposal(): void;
912
- /**
913
- * 改变小程序面板的布局,包括显示位置和显示大小
914
- * @param visible - 是否可见,默认true,
915
- * @param res - 取值 'PLAYER'
916
- * @param x - 横坐标
917
- * @param y - 纵坐标
918
- * @param width - 宽度
919
- * @param height - 高度
920
- */
921
- function setLayout(visible: boolean, res: string, x: number, y: number, width: number, height: number): void;
922
- /**
923
- * 销毁当前小程序
924
- */
925
- function disposal(): void;
926
- /**
927
- * 设置浮窗小程序的关闭按钮
928
- * @param params - 设置关闭按钮参数
929
- * @returns 设置结果
930
- */
931
- function setPopupCloseBtn(params: SetBtnParams): Promise<void>;
932
- /**
933
- * 设置面板类型小程序宽高
934
- * @param params - 设置面板类型小程序宽高参数
935
- * @returns 调用结果
936
- */
937
- function setPanelDimensions(params: SetPanelDimParams): Promise<void>;
938
- }
939
-
940
- namespace vip {
941
- /**
942
- * 获取小程序授权token
943
- * @returns 返回小程序授权token
944
- */
945
- function getJWT(): Promise<object>;
946
- /**
947
- * 获取小程序授权token
948
- * @returns 返回小程序授权token
949
- */
950
- function getJWT(): Promise<object>;
951
- }
952
-
953
228
  /**
954
229
  * IEG上报
955
230
  */
@@ -2408,20 +1683,27 @@ namespace app {
2408
1683
  }
2409
1684
 
2410
1685
  /**
2411
- * 扩展加载完成回调
1686
+ * 监听加载完成
2412
1687
  * @param callback - 回调函数
1688
+ * @returns 调用结果
2413
1689
  */
2414
1690
  function onLoad(callback: (...params: any[]) => any): void;
2415
1691
 
1692
+ /**
1693
+ * 监听取消加载
1694
+ * @returns 调用结果
1695
+ */
2416
1696
  function onUnload(callback: (...params: any[]) => any): void;
2417
1697
 
2418
1698
  /**
2419
1699
  * 注册App进入前台时回调
1700
+ * @returns 调用结果
2420
1701
  */
2421
1702
  function onEnterForeground(callback: (...params: any[]) => any): void;
2422
1703
 
2423
1704
  /**
2424
1705
  * 注册App进入后台时回调
1706
+ * @returns 调用结果
2425
1707
  */
2426
1708
  function onLeaveForeground(callback: (...params: any[]) => any): void;
2427
1709
 
@@ -2432,13 +1714,15 @@ type LifeCallback = () => void;
2432
1714
 
2433
1715
  /**
2434
1716
  * 小程序显示的生命周期
1717
+ * @returns 调用结果
2435
1718
  */
2436
- function onAppear(callback: (...params: any[]) => any): void;
1719
+ function onAppear(callback: LifeCallback): void;
2437
1720
 
2438
1721
  /**
2439
1722
  * 小程序隐藏的生命周期
1723
+ * @returns 调用结果
2440
1724
  */
2441
- function onDisappear(callback: (...params: any[]) => any): void;
1725
+ function onDisappear(callback: LifeCallback): void;
2442
1726
 
2443
1727
  /**
2444
1728
  * auth模块
@@ -2469,27 +1753,15 @@ type RequestAuthRsp = {
2469
1753
  };
2470
1754
 
2471
1755
  /**
2472
- * 后台
1756
+ * 后台模块
2473
1757
  */
2474
1758
  namespace backend {
2475
1759
  /**
2476
1760
  * 通用查询后台状态接口
2477
- * @param params.key - 关键字
2478
- * @param params.param - 参数
2479
- */
2480
- function commonQuery(params: {
2481
- key: string;
2482
- param: any;
2483
- }): void;
2484
- /**
2485
- * 通用查询后台状态接口
2486
- * @param params.key - 关键字
2487
- * @param params.param - 参数
1761
+ * @param params - 参数
1762
+ * @returns // key传入getServerTime参数时,返回GetServerTimeRsp,传入getPKInfo参数时, 返回GetPKInfoRsp
2488
1763
  */
2489
- function commonQuery(params: {
2490
- key: string;
2491
- param: any;
2492
- }): void;
1764
+ function commonQuery(params: SearchOptions): Promise<CommonQueryResp>;
2493
1765
  /**
2494
1766
  * 通用上行接口
2495
1767
  * @param params - 操作选项
@@ -2746,91 +2018,38 @@ type consts = Consts;
2746
2018
  namespace context {
2747
2019
  /**
2748
2020
  * 监听直播间消息
2749
- * @param topic - 消息名
2750
- * @param callback - 收到消息时回调 返回消息内容
2751
- */
2752
- function on(topic: string, callback: (...params: any[]) => any): void;
2753
- /**
2754
- * 取消监听直播间消息
2755
- * @param topic - 消息名
2756
- * @param callback - 收到消息时回调 返回消息内容
2757
- */
2758
- function off(topic: string, callback: (...params: any[]) => any): void;
2759
- /**
2760
- * 获取用户信息,目前返回昵称、头像信息
2761
- * @returns 返回用户信息,{ userNick, userAvatar }
2762
- */
2763
- function getUserInfo(): Promise<object>;
2764
- /**
2765
- * 获取安全区域的位置
2766
- * @returns 返回安全区域位置 left, top, right, bottom
2767
- */
2768
- function getSafeAreaPosition(): Promise<object>;
2769
- /**
2770
- * 显示红点
2771
- * @returns 返回是否显示成功
2772
- */
2773
- function showActivityBadge(): Promise<object>;
2774
- /**
2775
- * 显示toast
2776
- * @param message - toast中显示的消息
2777
- * @returns 返回toast是否显示成功
2778
- */
2779
- function showToast(message: string): Promise<object>;
2780
- /**
2781
- * 监听当前直播间小程序容器布局变化消息
2782
- */
2783
- function onLayoutChange(callback: LayoutChange): void;
2784
- /**
2785
- * 监听所有弹幕
2786
- * @param options - 弹幕筛选
2787
- * @param options.sendNick - 用户昵称关键字
2788
- * @param options.content - 弹幕内容关键字
2789
- * @param options.nobleLevel - 贵族等级
2790
- * @param options.fansLevel - 粉丝等级
2791
- */
2792
- function onBarrageChange(options: {
2793
- sendNick: string;
2794
- content: string;
2795
- nobleLevel: number;
2796
- fansLevel: number;
2797
- }, callback: BarrageCallback): void;
2798
- /**
2799
- * 关闭监听所有弹幕
2800
- */
2801
- function offBarrageChange(): void;
2802
- /**
2803
- * 监听直播间消息
2804
- * @param topic - 消息名
2021
+ * @param topic - 宿主消息名, activated-小程序激活, subscribeSubmit-【观众端】当前观众订阅状态发生变化, giftSubmit-【观众端】当前观众送礼, barrageSubmit-当前用户发送弹幕, unzipProgress-每个任务的解压进度, userInteract-用户交互信息, openCoinPanelClosed-能量豆弹窗关闭, uiVisibilityStateChange-工具栏状态
2805
2022
  * @param callback - 收到消息时回调 返回消息内容
2023
+ * @returns 调用结果
2806
2024
  */
2807
- function on(topic: string, callback: (...params: any[]) => any): void;
2025
+ function on(topic: string, callback: ContextOnCallback): void;
2808
2026
  /**
2809
2027
  * 取消监听直播间消息
2810
- * @param topic - 消息名
2811
- * @param callback - 收到消息时回调 返回消息内容
2028
+ * @param topic - 宿主消息名, activated-小程序激活, subscribeSubmit-【观众端】当前观众订阅状态发生变化, giftSubmit-【观众端】当前观众送礼, barrageSubmit-当前用户发送弹幕, unzipProgress-每个任务的解压进度, userInteract-用户交互信息, openCoinPanelClosed-能量豆弹窗关闭, uiVisibilityStateChange-工具栏状态
2029
+ * @param [callback] - 收到消息时回调 返回消息内容
2030
+ * @returns 调用结果
2812
2031
  */
2813
- function off(topic: string, callback: (...params: any[]) => any): void;
2032
+ function off(topic: string, callback?: ContextOnCallback): void;
2814
2033
  /**
2815
- * 显示红点
2034
+ * 显示互动通道入口红点
2816
2035
  * @returns 返回是否显示成功
2817
2036
  */
2818
- function showActivityBadge(): Promise<object>;
2037
+ function showActivityBadge(): Promise<void>;
2819
2038
  /**
2820
2039
  * 显示toast
2821
2040
  * @param message - toast中显示的消息
2822
- * @returns 返回toast是否显示成功
2823
2041
  */
2824
- function showToast(message: string): Promise<object>;
2042
+ function showToast(message: string): Promise<void>;
2825
2043
  /**
2826
2044
  * 获取安全区域的位置
2827
- * @returns 返回安全区域位置 left, top, right, bottom
2045
+ * @returns 返回安全区域位置信息
2828
2046
  */
2829
- function getSafeAreaPosition(): Promise<object>;
2047
+ function getSafeAreaPosition(): Promise<PositionInfo>;
2830
2048
  /**
2831
2049
  * 监听当前直播间小程序容器布局变化消息
2050
+ * @param callback - 小程序容器布局变化回调
2832
2051
  */
2833
- function onLayoutChange(callback: LayoutChange): void;
2052
+ function onLayoutChange(callback: LayoutChange): Promise<void>;
2834
2053
  /**
2835
2054
  * 引导订阅
2836
2055
  */
@@ -2869,22 +2088,14 @@ namespace context {
2869
2088
  function leadBarrage(): Promise<void>;
2870
2089
  /**
2871
2090
  * 监听所有弹幕
2872
- * @param options - 弹幕筛选
2873
- * @param options.sendNick - 用户昵称关键字
2874
- * @param options.content - 弹幕内容关键字
2875
- * @param options.nobleLevel - 贵族等级
2876
- * @param options.fansLevel - 粉丝等级
2877
- */
2878
- function onBarrageChange(options: {
2879
- sendNick: string;
2880
- content: string;
2881
- nobleLevel: number;
2882
- fansLevel: number;
2883
- }, callback: BarrageCallback): void;
2091
+ * @param options - 弹幕筛选条件
2092
+ * @param callback - 弹幕信息回调
2093
+ */
2094
+ function onBarrageChange(options: OnBarrageChangeOptions, callback: BarrageCallback): Promise<void>;
2884
2095
  /**
2885
2096
  * 关闭监听所有弹幕
2886
2097
  */
2887
- function offBarrageChange(): void;
2098
+ function offBarrageChange(): Promise<void>;
2888
2099
  /**
2889
2100
  * 监听开通守护
2890
2101
  * @param params - 监听开通守护参数
@@ -2942,10 +2153,10 @@ namespace context {
2942
2153
  */
2943
2154
  function getLiveInfo(): Promise<RespLiveInfo>;
2944
2155
  /**
2945
- * 获取用户信息,目前返回昵称、头像信息
2946
- * @returns 返回用户信息,{ userNick, userAvatar }
2156
+ * 获取用户信息
2157
+ * @returns 返回用户信息
2947
2158
  */
2948
- function getUserInfo(): Promise<object>;
2159
+ function getUserInfo(): Promise<UserInfo>;
2949
2160
  /**
2950
2161
  * 获取直播间的粉丝榜信息
2951
2162
  * @returns 返回直播间粉丝榜信息
@@ -3029,6 +2240,12 @@ namespace context {
3029
2240
  * @returns 调起成功
3030
2241
  */
3031
2242
  function checkSession(): Promise<void>;
2243
+ /**
2244
+ * 发起支付
2245
+ * @param params - 请求参数
2246
+ * @returns 调起成功
2247
+ */
2248
+ function requestPayment(params: RequestPaymentReq): Promise<void>;
3032
2249
  }
3033
2250
 
3034
2251
  /**
@@ -3051,6 +2268,7 @@ type PositionInfo = {
3051
2268
  };
3052
2269
 
3053
2270
  /**
2271
+ * 容器变化消息
3054
2272
  * @property screenWidth - 容器宽度
3055
2273
  * @property screenHeight - 容器高度
3056
2274
  * @property isLandscape - 是否横屏,web端固定为true
@@ -3061,6 +2279,10 @@ type LayoutInfo = {
3061
2279
  isLandscape: boolean;
3062
2280
  };
3063
2281
 
2282
+ /**
2283
+ * 小程序容器布局变化回调
2284
+ * @param info - 容器变化消息
2285
+ */
3064
2286
  type LayoutChange = (info: LayoutInfo) => void;
3065
2287
 
3066
2288
  /**
@@ -3167,9 +2389,9 @@ type BarragerInfo = {
3167
2389
 
3168
2390
  /**
3169
2391
  * 弹幕信息回调
3170
- * @param data - 参数
2392
+ * @param barrageInfo - 弹幕消息
3171
2393
  */
3172
- type BarrageCallback = (data: BarrageData) => boolean;
2394
+ type BarrageCallback = (barrageInfo: BarragerInfo) => void;
3173
2395
 
3174
2396
  /**
3175
2397
  * 弹幕筛选条件
@@ -3661,6 +2883,21 @@ type LoginReq = {
3661
2883
  timeout?: number;
3662
2884
  };
3663
2885
 
2886
+ /**
2887
+ * @property timeStamp - 时间戳
2888
+ * @property nonceStr - 随机字符串,长度为32个字符以下
2889
+ * @property package - 下单接口返回
2890
+ * @property signType - 签名算法
2891
+ * @property paySign - 签名
2892
+ */
2893
+ type RequestPaymentReq = {
2894
+ timeStamp: number;
2895
+ nonceStr: string;
2896
+ package: string;
2897
+ signType: string;
2898
+ paySign: string;
2899
+ };
2900
+
3664
2901
  /**
3665
2902
  * 下载中心
3666
2903
  */
@@ -4089,6 +3326,10 @@ namespace device {
4089
3326
  * @param [params] - 输入参数
4090
3327
  */
4091
3328
  function offOrientationChange(params?: OffOrientationChangeReq): Promise<void>;
3329
+ /**
3330
+ * 获取窗口信息
3331
+ */
3332
+ function getWindowInfo(): Promise<WindowInfo>;
4092
3333
  }
4093
3334
 
4094
3335
  /**
@@ -4368,16 +3609,58 @@ type OrientationChange = (info: OrientationInfo) => void;
4368
3609
  * 监听屏幕转向切换事件参数
4369
3610
  * @property callback - 监听屏幕转向切换回调
4370
3611
  */
4371
- type OnOrientationChangeReq = {
4372
- callback: OrientationChange;
3612
+ type OnOrientationChangeReq = {
3613
+ callback: OrientationChange;
3614
+ };
3615
+
3616
+ /**
3617
+ * 取消监听屏幕转向切换事件参数
3618
+ * @property [callback] - 监听屏幕转向切换回调
3619
+ */
3620
+ type OffOrientationChangeReq = {
3621
+ callback?: OrientationChange;
3622
+ };
3623
+
3624
+ /**
3625
+ * 安全区域
3626
+ * @property left - 安全区域左上角横坐标
3627
+ * @property right - 安全区域右下角横坐标
3628
+ * @property top - 安全区域左上角纵坐标
3629
+ * @property bottom - 安全区域右下角纵坐标
3630
+ * @property width - 安全区域的宽度,单位逻辑像素
3631
+ * @property height - 安全区域的高度,单位逻辑像素
3632
+ */
3633
+ type SafeArea = {
3634
+ left: number;
3635
+ right: number;
3636
+ top: number;
3637
+ bottom: number;
3638
+ width: number;
3639
+ height: number;
4373
3640
  };
4374
3641
 
4375
3642
  /**
4376
- * 取消监听屏幕转向切换事件参数
4377
- * @property [callback] - 监听屏幕转向切换回调
3643
+ * 窗口信息
3644
+ * @property screenWidth - 屏幕宽度
3645
+ * @property screenHeight - 屏幕高度
3646
+ * @property isLandscape - 屏幕是否是横屏高度
3647
+ * @property pixelRatio - 设备像素比
3648
+ * @property windowWidth - 可使用窗口宽度,单位 px
3649
+ * @property windowHeight - 可使用窗口高度,单位 px
3650
+ * @property statusBarHeight - 状态栏的高度,单位 px
3651
+ * @property screenTop - 窗口上边缘的 y 值
3652
+ * @property [safeArea] - 在竖屏正方向下的安全区域。部分机型没有安全区域概念,则不返回 safeArea 字段
4378
3653
  */
4379
- type OffOrientationChangeReq = {
4380
- callback?: OrientationChange;
3654
+ type WindowInfo = {
3655
+ screenWidth: number;
3656
+ screenHeight: number;
3657
+ isLandscape: boolean;
3658
+ pixelRatio: number;
3659
+ windowWidth: number;
3660
+ windowHeight: number;
3661
+ statusBarHeight: number;
3662
+ screenTop: number;
3663
+ safeArea?: SafeArea;
4381
3664
  };
4382
3665
 
4383
3666
  /**
@@ -4386,47 +3669,29 @@ type OffOrientationChangeReq = {
4386
3669
  function requestEbs(options: any): void;
4387
3670
 
4388
3671
  /**
4389
- * 环境信息
3672
+ * 环境相关
4390
3673
  */
4391
3674
  namespace env {
4392
3675
  /**
4393
3676
  * 获取当前版本类型
3677
+ * @returns 返回当前版本类型
4394
3678
  */
4395
- function getVersionType(): Promise<VersionInfo>;
4396
- /**
4397
- * 获取初始化参数
4398
- * @returns 初始化参数
4399
- */
4400
- function getInitialParam(): Promise<object>;
4401
- /**
4402
- * 获取小程序启动参数
4403
- * @returns 小程序启动参数
4404
- */
4405
- function getExtInfo(): Promise<object>;
4406
- /**
4407
- * 获取宿主信息接口,使用querystring解析rn bundle的查询串参数,返回给小程序
4408
- * @returns 宿主信息
4409
- */
4410
- function getHostInfo(): Promise<object>;
4411
- /**
4412
- * 获取当前版本类型
4413
- */
4414
- function getVersionType(): Promise<VersionInfo>;
3679
+ function getVersionType(): Promise<GetVersionTypeRsp>;
4415
3680
  /**
4416
3681
  * 获取初始化参数
4417
3682
  * @returns 初始化参数
4418
3683
  */
4419
3684
  function getInitialParam(): Promise<object>;
4420
3685
  /**
4421
- * 获取小程序启动参数
4422
- * @returns 小程序启动参数
3686
+ * 获取小程序参数
3687
+ * @returns 小程序参数
4423
3688
  */
4424
- function getExtInfo(): Promise<object>;
3689
+ function getExtInfo(): Promise<GetExtInfoRsp>;
4425
3690
  /**
4426
- * 获取宿主信息接口,使用querystring解析rn bundle的查询串参数,返回给小程序
4427
- * @returns 宿主信息
3691
+ * 获取宿主信息接口
3692
+ * @returns 返回宿主信息
4428
3693
  */
4429
- function getHostInfo(): Promise<object>;
3694
+ function getHostInfo(): Promise<GetHostInfoRsp>;
4430
3695
  /**
4431
3696
  * 获取性能数据
4432
3697
  * @returns 调用结果
@@ -4772,98 +4037,362 @@ type FeedbackParams = {
4772
4037
  */
4773
4038
  namespace fs {
4774
4039
  /**
4775
- * 调取本地相册
4040
+ * 上传图片
4041
+ * @returns 调用结果
4776
4042
  */
4777
- function uploadImg(): void;
4043
+ function uploadImg(): Promise<UrlInfo>;
4778
4044
  /**
4779
- * 监听离线资源是否下载完成消息
4780
- * @param params.url - 资源地址
4045
+ * 离线资源是否下载完成
4046
+ * @param params - 监听参数
4047
+ * @returns 调用结果
4781
4048
  */
4782
- function offlineFileReady(params: {
4783
- url: string;
4784
- }): Promise<string>;
4049
+ function offlineFileReady(params: UrlInfo): Promise<void>;
4785
4050
  /**
4786
- * 调取本地相册
4051
+ * 通用上传文件接口
4052
+ * @returns 调用结果
4787
4053
  */
4788
- function uploadImg(): void;
4054
+ function uploadFile(): Promise<UrlInfo>;
4789
4055
  /**
4790
- * 监听离线资源是否下载完成消息
4791
- * @param params.url - 资源地址
4056
+ * 批量下载资源
4057
+ * @param params - 下载资源信息
4058
+ * @returns 调用结果
4792
4059
  */
4793
- function offlineFileReady(params: {
4794
- url: string;
4795
- }): Promise<string>;
4060
+ function downloadBatchRes(params: BatchRes[]): Promise<void>;
4796
4061
  /**
4797
- * 通用上传文件接口
4062
+ * 删除资源
4063
+ * @param params - 要删除的资源信息
4798
4064
  * @returns 调用结果
4799
4065
  */
4800
- function uploadFile(): Promise<UrlInfo>;
4066
+ function removeRes(params: RemoveRes): Promise<void>;
4801
4067
  /**
4802
- * 批量下载资源
4068
+ * 判断资源是否存在
4069
+ * @param params - 要判断的资源信息
4070
+ * @returns 查询结果结果
4071
+ */
4072
+ function isResExists(params: ExistsReq): Promise<ExistsResp>;
4073
+ /**
4074
+ * 增强型上传文件
4075
+ * @param params - 要判断的资源信息
4076
+ * @returns 查询结果结果
4077
+ */
4078
+ function uploadFileExtra(params: FileExtraParams): Promise<FileExtraResp>;
4079
+ /**
4080
+ * 批量发起下载共享资源
4803
4081
  * @param params - 下载资源信息
4804
4082
  * @returns 调用结果
4805
4083
  */
4806
- function downloadBatchRes(params: BatchRes[]): Promise<void>;
4084
+ function downloadBatchSharedRes(params: BatchSharedRes[]): Promise<void>;
4085
+ /**
4086
+ * 判断共享资源是否存在
4087
+ * @param params - 要判断的资源信息
4088
+ * @returns 查询结果结果
4089
+ */
4090
+ function isSharedResExists(params: BatchSharedRes): Promise<ExistsResp>;
4091
+ /**
4092
+ * 清除下载资源
4093
+ * @param params - 参数
4094
+ * @returns 结果
4095
+ */
4096
+ function cleanRes(params: CleanResParams): Promise<void>;
4097
+ /**
4098
+ * 批量保存文件到本地
4099
+ * @param params - 传入参数
4100
+ * @returns 调用结果
4101
+ */
4102
+ function saveFiles(params: SaveFilesReq): Promise<void>;
4103
+ /**
4104
+ * 批量上传文件
4105
+ * @param params - 参数
4106
+ * @returns 结果
4107
+ */
4108
+ function uploadFiles(params: UploadFilesReq): Promise<void>;
4109
+ /**
4110
+ * 选择本地目录
4111
+ * @param params - 传入参数
4112
+ * @returns 调用结果
4113
+ */
4114
+ function selectDir(params: SelectDirReq): Promise<void>;
4115
+ /**
4116
+ * 拍摄或从手机相册中选择图片或视频
4117
+ * @param params - 传入参数
4118
+ * @returns 调用结果
4119
+ */
4120
+ function chooseMedia(params: ChooseMediaReq): Promise<void>;
4121
+ /**
4122
+ * 下载文件
4123
+ * @param params - 传入参数
4124
+ * @returns 调用结果
4125
+ */
4126
+ function downloadFile(params: DownloadFileReq): Promise<void>;
4127
+ /**
4128
+ * 判断文件/目录是否存在
4129
+ * @param params - 传入参数
4130
+ * @returns 调用结果
4131
+ */
4132
+ function access(params: AccessReq): Promise<void>;
4133
+ /**
4134
+ * 同步判断文件/目录是否存在
4135
+ * @param params - 传入参数
4136
+ * @returns 调用结果
4137
+ */
4138
+ function accessSync(params: AccessReq): void;
4139
+ /**
4140
+ * 在文件结尾追加内容
4141
+ * @param params - 传入参数
4142
+ * @returns 调用结果
4143
+ */
4144
+ function appendFile(params: AppendFileReq): Promise<void>;
4145
+ /**
4146
+ * 同步在文件结尾追加内容
4147
+ * @param params - 传入参数
4148
+ * @returns 调用结果
4149
+ */
4150
+ function appendFileSync(params: AppendFileReq): void;
4151
+ /**
4152
+ * 关闭文件
4153
+ * @param params - 传入参数
4154
+ * @returns 调用结果
4155
+ */
4156
+ function close(params: CloseReq): Promise<void>;
4157
+ /**
4158
+ * 同步关闭文件
4159
+ * @param params - 传入参数
4160
+ * @returns 调用结果
4161
+ */
4162
+ function closeSync(params: CloseReq): void;
4163
+ /**
4164
+ * 复制文件
4165
+ * @param params - 传入参数
4166
+ * @returns 调用结果
4167
+ */
4168
+ function copyFile(params: CopyFileReq): Promise<void>;
4169
+ /**
4170
+ * 同步复制文件
4171
+ * @param params - 传入参数
4172
+ * @returns 调用结果
4173
+ */
4174
+ function copyFileSync(params: CopyFileReq): void;
4175
+ /**
4176
+ * 获取文件信息
4177
+ * @param params - 传入参数
4178
+ * @returns 调用结果
4179
+ */
4180
+ function getFileInfo(params: GetFileInfoReq): Promise<GetFileInfoRsp>;
4181
+ /**
4182
+ * 获取该小程序下已保存的本地缓存文件列表
4183
+ * @returns 调用结果
4184
+ */
4185
+ function getSavedFileList(): Promise<GetSavedFileListRsp>;
4186
+ /**
4187
+ * 创建文件夹
4188
+ * @param params - 传入参数
4189
+ * @returns 调用结果
4190
+ */
4191
+ function mkdir(params: MkdirReq): Promise<void>;
4192
+ /**
4193
+ * 创建文件夹
4194
+ * @param params - 传入参数
4195
+ * @returns 调用结果
4196
+ */
4197
+ function mkdirSync(params: MkdirReq): void;
4198
+ /**
4199
+ * 打开文件,返回文件描述符
4200
+ * @param params - 传入参数
4201
+ * @returns 调用结果
4202
+ */
4203
+ function open(params: OpenReq): Promise<OpenRsp>;
4204
+ /**
4205
+ * 打开文件,返回文件描述符
4206
+ * @param params - 传入参数
4207
+ * @returns 调用结果
4208
+ */
4209
+ function openSync(params: OpenReq): OpenRsp;
4210
+ /**
4211
+ * 读文件
4212
+ * @param params - 传入参数
4213
+ * @returns 调用结果
4214
+ */
4215
+ function read(params: ReadReq): Promise<ReadRsp>;
4216
+ /**
4217
+ * 同步读文件
4218
+ * @param params - 传入参数
4219
+ * @returns 调用结果
4220
+ */
4221
+ function readSync(params: ReadReq): ReadRsp;
4222
+ /**
4223
+ * 读取指定压缩类型的本地文件内容
4224
+ * @param params - 传入参数
4225
+ * @returns 调用结果
4226
+ */
4227
+ function readCompressedFile(params: ReadCompressedFileReq): Promise<ReadCompressedFileRsp>;
4228
+ /**
4229
+ * 同步读取指定压缩类型的本地文件内容
4230
+ * @param params - 传入参数
4231
+ * @returns 调用结果
4232
+ */
4233
+ function readCompressedFileSync(params: ReadCompressedFileReq): ReadCompressedFileRsp;
4234
+ /**
4235
+ * 读取目录内文件列表
4236
+ * @param params - 传入参数
4237
+ * @returns 调用结果
4238
+ */
4239
+ function readdir(params: ReaddirReq): Promise<ReaddirRsp>;
4240
+ /**
4241
+ * 同步读取目录内文件列表
4242
+ * @param params - 传入参数
4243
+ * @returns 调用结果
4244
+ */
4245
+ function readdirSync(params: ReaddirReq): ReaddirRsp;
4246
+ /**
4247
+ * 读取文件
4248
+ * @param params - 传入参数
4249
+ * @returns 调用结果
4250
+ */
4251
+ function readFile(params: ReadFileReq): Promise<ReadFileRsp>;
4252
+ /**
4253
+ * 同步读取文件
4254
+ * @param params - 传入参数
4255
+ * @returns 调用结果
4256
+ */
4257
+ function readFileSync(params: ReadFileReq): ReadFileRsp;
4258
+ /**
4259
+ * 读取压缩包内的文件
4260
+ * @param params - 传入参数
4261
+ * @returns 调用结果
4262
+ */
4263
+ function readZipEntry(params: ReadZipEntryReq): Promise<ReadZipEntryRsp>;
4264
+ /**
4265
+ * 解压文件
4266
+ * @param params - 传入参数
4267
+ * @returns 调用结果
4268
+ */
4269
+ function unzip(params: UnzipReq): Promise<void>;
4270
+ /**
4271
+ * 删除该小程序下已保存的本地缓存文件
4272
+ * @param params - 传入参数
4273
+ * @returns 调用结果
4274
+ */
4275
+ function removeSavedFile(params: RemoveSavedFileReq): Promise<void>;
4276
+ /**
4277
+ * 重命名文件
4278
+ * @param params - 传入参数
4279
+ * @returns 调用结果
4280
+ */
4281
+ function rename(params: RenameReq): Promise<void>;
4282
+ /**
4283
+ * 同步重命名文件
4284
+ * @param params - 传入参数
4285
+ * @returns 调用结果
4286
+ */
4287
+ function renameSync(params: RenameReq): void;
4288
+ /**
4289
+ * 删除目录
4290
+ * @param params - 传入参数
4291
+ * @returns 调用结果
4292
+ */
4293
+ function rmdir(params: RmdirReq): Promise<void>;
4294
+ /**
4295
+ * 同步删除目录
4296
+ * @param params - 传入参数
4297
+ * @returns 调用结果
4298
+ */
4299
+ function rmdirSync(params: RmdirReq): void;
4300
+ /**
4301
+ * 保存临时文件到本地
4302
+ * @param params - 传入参数
4303
+ * @returns 调用结果
4304
+ */
4305
+ function saveFile(params: SaveFileReq): Promise<SaveFileRsp>;
4306
+ /**
4307
+ * 同步保存临时文件到本地
4308
+ * @param params - 传入参数
4309
+ * @returns 调用结果
4310
+ */
4311
+ function saveFileSync(params: SaveFileReq): SaveFileRsp;
4312
+ /**
4313
+ * 获取文件Stats对象
4314
+ * @param params - 传入参数
4315
+ * @returns 调用结果
4316
+ */
4317
+ function stat(params: StatReq): Promise<StatRsp>;
4318
+ /**
4319
+ * 同步获取文件Stats对象
4320
+ * @param params - 传入参数
4321
+ * @returns 调用结果
4322
+ */
4323
+ function statSync(params: StatReq): StatRsp;
4324
+ /**
4325
+ * 对文件内容进行截断操作
4326
+ * @param params - 传入参数
4327
+ * @returns 调用结果
4328
+ */
4329
+ function truncate(params: TruncateReq): Promise<void>;
4330
+ /**
4331
+ * 同步对文件内容进行截断操作
4332
+ * @param params - 传入参数
4333
+ * @returns 调用结果
4334
+ */
4335
+ function truncateSync(params: TruncateReq): void;
4807
4336
  /**
4808
- * 删除资源
4809
- * @param params - 要删除的资源信息
4337
+ * 删除文件
4338
+ * @param params - 传入参数
4810
4339
  * @returns 调用结果
4811
4340
  */
4812
- function removeRes(params: RemoveRes): Promise<void>;
4341
+ function unlink(params: UnlinkReq): Promise<void>;
4813
4342
  /**
4814
- * 判断资源是否存在
4815
- * @param params - 要判断的资源信息
4816
- * @returns 查询结果结果
4343
+ * 同步删除文件
4344
+ * @param params - 传入参数
4345
+ * @returns 调用结果
4817
4346
  */
4818
- function isResExists(params: ExistsReq): Promise<ExistsResp>;
4347
+ function unlinkSync(params: UnlinkReq): void;
4819
4348
  /**
4820
- * 增强型上传文件
4821
- * @param params - 要判断的资源信息
4822
- * @returns 查询结果结果
4349
+ * 写入文件
4350
+ * @param params - 传入参数
4351
+ * @returns 调用结果
4823
4352
  */
4824
- function uploadFileExtra(params: FileExtraParams): Promise<FileExtraResp>;
4353
+ function write(params: WriteReq): Promise<void>;
4825
4354
  /**
4826
- * 批量发起下载共享资源
4827
- * @param params - 下载资源信息
4355
+ * 同步写入文件
4356
+ * @param params - 传入参数
4828
4357
  * @returns 调用结果
4829
4358
  */
4830
- function downloadBatchSharedRes(params: BatchSharedRes[]): Promise<void>;
4359
+ function writeSync(params: WriteReq): void;
4831
4360
  /**
4832
- * 判断共享资源是否存在
4833
- * @param params - 要判断的资源信息
4834
- * @returns 查询结果结果
4361
+ * 写文件
4362
+ * @param params - 传入参数
4363
+ * @returns 调用结果
4835
4364
  */
4836
- function isSharedResExists(params: BatchSharedRes): Promise<ExistsResp>;
4365
+ function writeFile(params: WriteFileReq): Promise<void>;
4837
4366
  /**
4838
- * 清除下载资源
4839
- * @param params - 参数
4840
- * @returns 结果
4367
+ * 同步写文件
4368
+ * @param params - 传入参数
4369
+ * @returns 调用结果
4841
4370
  */
4842
- function cleanRes(params: CleanResParams): Promise<void>;
4371
+ function writeFileSync(params: WriteFileReq): void;
4843
4372
  /**
4844
- * 批量保存文件到本地
4373
+ * 获取文件的状态信息
4845
4374
  * @param params - 传入参数
4846
4375
  * @returns 调用结果
4847
4376
  */
4848
- function saveFiles(params: SaveFilesReq): Promise<void>;
4377
+ function fstat(params: FstatReq): Promise<FstatRsp>;
4849
4378
  /**
4850
- * 批量上传文件
4851
- * @param params - 参数
4852
- * @returns 结果
4379
+ * 同步获取文件的状态信息
4380
+ * @param params - 传入参数
4381
+ * @returns 调用结果
4853
4382
  */
4854
- function uploadFiles(params: UploadFilesReq): Promise<void>;
4383
+ function fstatSync(params: FstatReq): FstatRsp;
4855
4384
  /**
4856
- * 选择本地目录
4385
+ * 对文件内容进行截断操作
4857
4386
  * @param params - 传入参数
4858
4387
  * @returns 调用结果
4859
4388
  */
4860
- function selectDir(params: SelectDirReq): Promise<void>;
4389
+ function ftruncate(params: FtruncateReq): Promise<void>;
4861
4390
  /**
4862
- * 拍摄或从手机相册中选择图片或视频
4391
+ * 同步对文件内容进行截断操作
4863
4392
  * @param params - 传入参数
4864
4393
  * @returns 调用结果
4865
4394
  */
4866
- function chooseMedia(params: ChooseMediaReq): Promise<void>;
4395
+ function ftruncateSync(params: FtruncateReq): void;
4867
4396
  }
4868
4397
 
4869
4398
  /**
@@ -5157,6 +4686,392 @@ type ChooseMediaReq = {
5157
4686
  callback: ChooseCallback;
5158
4687
  };
5159
4688
 
4689
+ /**
4690
+ * 下载文件参数
4691
+ * @property url - 下载资源的 url
4692
+ * @property [header] - HTTP 请求的 Header
4693
+ * @property [timeout] - 超时时间,单位为毫秒,默认值为 60000 即一分钟
4694
+ * @property [filePath] - 指定文件下载后存储的路径 (本地路径)
4695
+ */
4696
+ type DownloadFileReq = {
4697
+ url: string;
4698
+ header?: any;
4699
+ timeout?: number;
4700
+ filePath?: string;
4701
+ };
4702
+
4703
+ /**
4704
+ * 判断文件/目录是否存在参数
4705
+ * @property path - 要判断是否存在的文件/目录路径 (本地路径)
4706
+ */
4707
+ type AccessReq = {
4708
+ path: string;
4709
+ };
4710
+
4711
+ /**
4712
+ * 在文件结尾追加内容参数
4713
+ * @property filePath - 要追加内容的文件路径 (本地路径)
4714
+ * @property data - 要追加的文本或二进制数据
4715
+ * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
4716
+ */
4717
+ type AppendFileReq = {
4718
+ filePath: string;
4719
+ data: string;
4720
+ encoding?: string;
4721
+ };
4722
+
4723
+ /**
4724
+ * 关闭文件参数
4725
+ * @property fd - 需要被关闭的文件描述符
4726
+ */
4727
+ type CloseReq = {
4728
+ fd: string;
4729
+ };
4730
+
4731
+ /**
4732
+ * 复制文件参数
4733
+ * @property srcPath - 源文件路径,支持本地路径
4734
+ * @property destPath - 目标文件路径,支持本地路径
4735
+ */
4736
+ type CopyFileReq = {
4737
+ srcPath: string;
4738
+ destPath: string;
4739
+ };
4740
+
4741
+ /**
4742
+ * 文件信息
4743
+ * @property size - 文件大小,以字节为单位
4744
+ * @property digest - 按照传入的 digestAlgorithm 计算得出的的文件摘要
4745
+ */
4746
+ type GetFileInfoRsp = {
4747
+ size: number;
4748
+ digest: string;
4749
+ };
4750
+
4751
+ /**
4752
+ * 获取文件信息参数
4753
+ * @property filePath - 要读取的文件路径 (本地路径)
4754
+ * @property [digestAlgorithm] - 计算文件摘要的算法, md5-md5算法, sha1-sha1算法
4755
+ */
4756
+ type GetFileInfoReq = {
4757
+ filePath: string;
4758
+ digestAlgorithm?: string;
4759
+ };
4760
+
4761
+ /**
4762
+ * 文件信息
4763
+ * @property filePath - 文件路径 (本地路径)
4764
+ * @property size - 本地文件大小,以字节为单位
4765
+ * @property createTime - 文件保存时的时间戳
4766
+ */
4767
+ type SavedFileInfo = {
4768
+ filePath: string;
4769
+ size: number;
4770
+ createTime: number;
4771
+ };
4772
+
4773
+ /**
4774
+ * 获取该小程序下已保存的本地缓存文件列表
4775
+ * @property fileList - 文件列表
4776
+ */
4777
+ type GetSavedFileListRsp = {
4778
+ fileList: SavedFileInfo[];
4779
+ };
4780
+
4781
+ /**
4782
+ * 创建文件夹参数
4783
+ * @property dirPath - 创建的目录路径 (本地路径)
4784
+ * @property [recursive] - 是否在递归创建该目录的上级目录后再创建该目录
4785
+ */
4786
+ type MkdirReq = {
4787
+ dirPath: string;
4788
+ recursive?: boolean;
4789
+ };
4790
+
4791
+ /**
4792
+ * 文件信息
4793
+ * @property fd - 文件描述符
4794
+ */
4795
+ type OpenRsp = {
4796
+ fd: string;
4797
+ };
4798
+
4799
+ /**
4800
+ * 打开文件参数
4801
+ * @property filePath - 文件路径 (本地路径)
4802
+ * @property [flag] - 文件系统标志,默认值: 'r'
4803
+ */
4804
+ type OpenReq = {
4805
+ filePath: string;
4806
+ flag?: string;
4807
+ };
4808
+
4809
+ /**
4810
+ * 文件信息
4811
+ * @property bytesRead - 实际读取的字节数
4812
+ * @property ArrayBuffer - 被写入的缓存区的对象
4813
+ */
4814
+ type ReadRsp = {
4815
+ bytesRead: number;
4816
+ ArrayBuffer: any;
4817
+ };
4818
+
4819
+ /**
4820
+ * 读文件参数
4821
+ * @property fd - 文件描述符
4822
+ * @property arrayBuffer - 数据写入的缓冲区,必须是 ArrayBuffer 实例
4823
+ * @property [offset] - 缓冲区中的写入偏移量,默认0
4824
+ * @property [length] - 要从文件中读取的字节数,默认0
4825
+ * @property [position] - 文件读取的起始位置
4826
+ */
4827
+ type ReadReq = {
4828
+ fd: string;
4829
+ arrayBuffer: any;
4830
+ offset?: number;
4831
+ length?: number;
4832
+ position?: number;
4833
+ };
4834
+
4835
+ /**
4836
+ * 压缩类型的本地文件内容
4837
+ * @property data - 文件内容
4838
+ */
4839
+ type ReadCompressedFileRsp = {
4840
+ data: any;
4841
+ };
4842
+
4843
+ /**
4844
+ * 读取指定压缩类型的本地文件内容参数
4845
+ * @property filePath - 要读取的文件的路径 (本地用户文件或代码包文件)
4846
+ */
4847
+ type ReadCompressedFileReq = {
4848
+ filePath: string;
4849
+ };
4850
+
4851
+ /**
4852
+ * 读取目录内文件列表
4853
+ * @property files - 指定目录下的文件名数组
4854
+ */
4855
+ type ReaddirRsp = {
4856
+ files: string[];
4857
+ };
4858
+
4859
+ /**
4860
+ * 读取目录内文件列表参数
4861
+ * @property dirPath - 要读取的目录路径 (本地路径)
4862
+ */
4863
+ type ReaddirReq = {
4864
+ dirPath: string;
4865
+ };
4866
+
4867
+ /**
4868
+ * 读取文件结果
4869
+ * @property data - 文件数据
4870
+ */
4871
+ type ReadFileRsp = {
4872
+ data: any;
4873
+ };
4874
+
4875
+ /**
4876
+ * 读取文件参数
4877
+ * @property filePath - 要读取的文件的路径 (本地路径)
4878
+ * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
4879
+ * @property [position] - 从文件指定位置开始读,如果不指定,则从文件头开始读
4880
+ * @property [length] - 指定文件的长度,如果不指定,则读到文件末尾。
4881
+ */
4882
+ type ReadFileReq = {
4883
+ filePath: string;
4884
+ encoding?: string;
4885
+ position?: number;
4886
+ length?: number;
4887
+ };
4888
+
4889
+ /**
4890
+ * 读取压缩包内的文件
4891
+ * @property entries - 文件读取结果,key是文件路径,value是一个对象 FileItem ,表示该文件的读取结果。每个 FileItem 包含 data (文件内容) 和 errMsg (错误信息) 属性。
4892
+ */
4893
+ type ReadZipEntryRsp = {
4894
+ entries: any;
4895
+ };
4896
+
4897
+ /**
4898
+ * 读取压缩包内的文件参数
4899
+ * @property filePath - 要读取的文件的路径 (本地路径)
4900
+ * @property [encoding] - 指定读取文件的字符编码, base64-base64, utf8-utf8
4901
+ * @property entries - 要读取的压缩包内的文件列表(当传入"all" 时表示读取压缩包内所有文件)
4902
+ */
4903
+ type ReadZipEntryReq = {
4904
+ filePath: string;
4905
+ encoding?: string;
4906
+ entries: any;
4907
+ };
4908
+
4909
+ /**
4910
+ * 解压文件参数
4911
+ * @property zipFilePath - 源文件路径,支持本地路径,只可以是 zip 压缩文件
4912
+ * @property targetPath - 目标目录路径,支持本地路径
4913
+ */
4914
+ type UnzipReq = {
4915
+ zipFilePath: string;
4916
+ targetPath: string;
4917
+ };
4918
+
4919
+ /**
4920
+ * 删除该小程序下已保存的本地缓存文件参数
4921
+ * @property filePath - 需要删除的文件路径 (本地路径)
4922
+ */
4923
+ type RemoveSavedFileReq = {
4924
+ filePath: string;
4925
+ };
4926
+
4927
+ /**
4928
+ * 重命名文件参数
4929
+ * @property oldPath - 源文件路径,支持本地路径
4930
+ * @property newPath - 新文件路径,支持本地路径
4931
+ */
4932
+ type RenameReq = {
4933
+ oldPath: string;
4934
+ newPath: string;
4935
+ };
4936
+
4937
+ /**
4938
+ * 删除目录参数
4939
+ * @property dirPath - 要删除的目录路径 (本地路径)
4940
+ * @property [recursive] - 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。
4941
+ */
4942
+ type RmdirReq = {
4943
+ dirPath: string;
4944
+ recursive?: boolean;
4945
+ };
4946
+
4947
+ /**
4948
+ * 保存临时文件到本地结果
4949
+ * @property savedFilePath - 存储后的文件路径 (本地路径)
4950
+ */
4951
+ type SaveFileRsp = {
4952
+ savedFilePath: string;
4953
+ };
4954
+
4955
+ /**
4956
+ * 保存临时文件到本地参数
4957
+ * @property tempFilePath - 临时存储文件路径 (本地路径)
4958
+ * @property [filePath] - 要存储的文件路径 (本地路径)
4959
+ */
4960
+ type SaveFileReq = {
4961
+ tempFilePath: string;
4962
+ filePath?: string;
4963
+ };
4964
+
4965
+ /**
4966
+ * 文件Stats对象结果
4967
+ * @property stats - 当recursive为false时,res.stats是一个Stats对象。当recursive为true且path是一个目录的路径时,res.stats是一个Array,数组的每一项是一个对象,每个对象包含path和stats
4968
+ */
4969
+ type StatRsp = {
4970
+ stats: any;
4971
+ };
4972
+
4973
+ /**
4974
+ * 获取文件Stats对象参数
4975
+ * @property path - 文件/目录路径 (本地路径)
4976
+ * @property [recursive] - 是否递归获取目录下的每个文件的 Stats 信息
4977
+ */
4978
+ type StatReq = {
4979
+ path: string;
4980
+ recursive?: boolean;
4981
+ };
4982
+
4983
+ /**
4984
+ * 对文件内容进行截断操作参数
4985
+ * @property filePath - 要截断的文件路径 (本地路径)
4986
+ * @property [length] - 截断位置,默认0。如果 length 小于文件长度(字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,则会对其进行扩展,并且扩展部分将填充空字节('\0')
4987
+ */
4988
+ type TruncateReq = {
4989
+ filePath: string;
4990
+ length?: number;
4991
+ };
4992
+
4993
+ /**
4994
+ * 删除文件参数
4995
+ * @property filePath - 要删除的文件路径 (本地路径)
4996
+ */
4997
+ type UnlinkReq = {
4998
+ filePath: string;
4999
+ };
5000
+
5001
+ /**
5002
+ * 写文件参数
5003
+ * @property fd - 文件描述符
5004
+ * @property data - 要写入的文本或二进制数据
5005
+ * @property [offset] - 在 data 是 ArrayBuffer 时要写入的 arrayBuffer 中的索引,默认0
5006
+ * @property [length] - 在 data 是 ArrayBuffer 时指定要写入的字节数
5007
+ * @property [encoding] - 指定写入文件的字符编码, base64-base64, utf8-utf8
5008
+ * @property [position] - 指定文件开头的偏移量,即数据要被写入的位置
5009
+ */
5010
+ type WriteReq = {
5011
+ fd: string;
5012
+ data: string;
5013
+ offset?: number;
5014
+ length?: number;
5015
+ encoding?: string;
5016
+ position?: number;
5017
+ };
5018
+
5019
+ /**
5020
+ * 写文件参数
5021
+ * @property filePath - 要写入的文件路径 (本地路径)
5022
+ * @property data - 要写入的文本或二进制数据
5023
+ * @property [encoding] - 指定写入文件的字符编码, base64-base64, utf8-utf8
5024
+ */
5025
+ type WriteFileReq = {
5026
+ filePath: string;
5027
+ data: string;
5028
+ encoding?: string;
5029
+ };
5030
+
5031
+ /**
5032
+ * 文件状态
5033
+ * @property mode - 文件的类型和存取的权限
5034
+ * @property size - 文件大小,单位:B
5035
+ * @property lastAccessedTime - 文件最近一次被存取或被执行的时间戳
5036
+ * @property lastModifiedTime - 文件最后一次被修改的时间戳
5037
+ * @property isDirectory - 判断当前文件是否一个目录
5038
+ * @property isFile - 判断当前文件是否一个普通文件
5039
+ */
5040
+ type FileStats = {
5041
+ mode: number;
5042
+ size: number;
5043
+ lastAccessedTime: number;
5044
+ lastModifiedTime: number;
5045
+ isDirectory: boolean;
5046
+ isFile: boolean;
5047
+ };
5048
+
5049
+ /**
5050
+ * 获取文件的状态信息参数
5051
+ * @property stats - 文件状态
5052
+ */
5053
+ type FstatRsp = {
5054
+ stats: FileStats;
5055
+ };
5056
+
5057
+ /**
5058
+ * 获取文件的状态信息参数
5059
+ * @property fd - 文件描述符
5060
+ */
5061
+ type FstatReq = {
5062
+ fd: string;
5063
+ };
5064
+
5065
+ /**
5066
+ * 对文件内容进行截断操作参数
5067
+ * @property fd - 文件描述符
5068
+ * @property length - 截断位置,默认0,如果 length 小于文件长度(单位:字节),则只有前面 length 个字节会保留在文件中,其余内容会被删除;如果 length 大于文件长度,则会对其进行扩展,并且扩展部分将填充空字节('\0')
5069
+ */
5070
+ type FtruncateReq = {
5071
+ fd: string;
5072
+ length: number;
5073
+ };
5074
+
5160
5075
  /**
5161
5076
  * 游戏相关
5162
5077
  */
@@ -5966,85 +5881,41 @@ type OBCallback = (content: any) => void;
5966
5881
  */
5967
5882
  namespace observer {
5968
5883
  /**
5969
- * 监听后台消息
5970
- * @param topic - 消息名
5971
- * @param callback - 收到消息时回调 返回对应消息名的后台消息content
5972
- */
5973
- function on(topic: string, callback: (...params: any[]) => any): void;
5974
- /**
5975
- * 取消监听后台消息
5976
- * @param topic - 消息名
5977
- */
5978
- function off(topic: string, callback: (...params: any[]) => any): void;
5979
- /**
5980
- * 触发小程序消息
5981
- */
5982
- function emit(topic: string, message: string): Promise<any>;
5983
- /**
5984
- * 监听自身小程序消息
5985
- * @param params.eventName - 消息名
5986
- * @param params.callback - 回调
5987
- */
5988
- function onLocalMessage(params: {
5989
- eventName: string;
5990
- callback: (...params: any[]) => any;
5991
- }): void;
5992
- /**
5993
- * 取消监听自身小程序消息
5994
- * @param params.eventName - 消息名
5995
- */
5996
- function offLocalMessage(params: {
5997
- eventName: string;
5998
- }): void;
5999
- /**
6000
- * 发送小程序消息
6001
- * @param params.eventName - 消息名
6002
- * @param params.callback - 回调
6003
- */
6004
- function postLocalMessage(params: {
6005
- eventName: string;
6006
- callback: (...params: any[]) => any;
6007
- }): Promise<any>;
6008
- /**
6009
- * 监听后台消息
5884
+ * 监听小程序消息
6010
5885
  * @param topic - 消息名
6011
5886
  * @param callback - 收到消息时回调 返回对应消息名的后台消息content
5887
+ * @returns 调用结果
6012
5888
  */
6013
- function on(topic: string, callback: (...params: any[]) => any): void;
5889
+ function on(topic: string, callback: ObserverCallback): void;
6014
5890
  /**
6015
5891
  * 取消监听后台消息
6016
5892
  * @param topic - 消息名
5893
+ * @param [callback] - 消息回调
5894
+ * @returns 调用结果
6017
5895
  */
6018
- function off(topic: string, callback: (...params: any[]) => any): void;
5896
+ function off(topic: string, callback?: ObserverCallback): void;
6019
5897
  /**
6020
5898
  * 触发小程序消息
5899
+ * @param topic - 小程序消息名
5900
+ * @param message - 小程序消息内容
6021
5901
  */
6022
- function emit(topic: string, message: string): Promise<any>;
5902
+ function emit(topic: string, message: string): Promise<void>;
6023
5903
  /**
6024
- * 监听自身小程序消息
6025
- * @param params.eventName - 消息名
6026
- * @param params.callback - 回调
5904
+ * 监听本地小程序消息
5905
+ * @param params - 监听本地小程序参数
6027
5906
  */
6028
- function onLocalMessage(params: {
6029
- eventName: string;
6030
- callback: (...params: any[]) => any;
6031
- }): void;
5907
+ function onLocalMessage(params: LocalMessageParams): Promise<void>;
6032
5908
  /**
6033
5909
  * 取消监听自身小程序消息
6034
- * @param params.eventName - 消息名
5910
+ * @param params - 取消监听参数
6035
5911
  */
6036
- function offLocalMessage(params: {
6037
- eventName: string;
6038
- }): void;
5912
+ function offLocalMessage(params: OffLocalMessageParams): Promise<void>;
6039
5913
  /**
6040
- * 发送小程序消息
6041
- * @param params.eventName - 消息名
6042
- * @param params.callback - 回调
5914
+ * 触发小程序本地消息
5915
+ * @param params - 本地消息参数
5916
+ * @returns 调用结果
6043
5917
  */
6044
- function postLocalMessage(params: {
6045
- eventName: string;
6046
- callback: (...params: any[]) => any;
6047
- }): Promise<any>;
5918
+ function postLocalMessage(params: PostLocalMessageParams): Promise<void>;
6048
5919
  /**
6049
5920
  * 广播开发者维度的本地消息
6050
5921
  * @param params - 本地消息参数
@@ -6106,25 +5977,15 @@ type PostLocalMessageParams = {
6106
5977
  };
6107
5978
 
6108
5979
  /**
6109
- * 秩序
5980
+ * 秩序相关
6110
5981
  */
6111
5982
  namespace order {
6112
5983
  /**
6113
5984
  * 发起小程序文本的秩序审核
6114
- * @param param - 参数
6115
- * @param param.text - 要检查的字符串
6116
- */
6117
- function reportText(param: {
6118
- text: string;
6119
- }): void;
6120
- /**
6121
- * 发起小程序文本的秩序审核
6122
- * @param param - 参数
6123
- * @param param.text - 要检查的字符串
5985
+ * @param param - 文本秩序审核参数
5986
+ * @returns 调用结果,reject为审核失败
6124
5987
  */
6125
- function reportText(param: {
6126
- text: string;
6127
- }): void;
5988
+ function reportText(param: ReportTextParams): Promise<void>;
6128
5989
  }
6129
5990
 
6130
5991
  /**
@@ -6493,33 +6354,16 @@ type OnInviteMessageParams = {
6493
6354
  */
6494
6355
  namespace panel {
6495
6356
  /**
6496
- * 改变小程序面板的布局,包括显示位置和显示大小
6497
- * @param visible - 是否可见,默认true,
6498
- * @param res - 取值 'PLAYER'
6499
- * @param x - 横坐标
6500
- * @param y - 纵坐标
6501
- * @param width - 宽度
6502
- * @param height - 高度
6503
- */
6504
- function setLayout(visible: boolean, res: string, x: number, y: number, width: number, height: number): void;
6505
- /**
6506
- * 销毁当前小程序
6507
- */
6508
- function disposal(): void;
6509
- /**
6510
- * 改变小程序面板的布局,包括显示位置和显示大小
6511
- * @param visible - 是否可见,默认true,
6512
- * @param res - 取值 'PLAYER'
6513
- * @param x - 横坐标
6514
- * @param y - 纵坐标
6515
- * @param width - 宽度
6516
- * @param height - 高度
6357
+ * 设置小程序布局
6358
+ * @param params - 布局信息
6359
+ * @returns 调用结果
6517
6360
  */
6518
- function setLayout(visible: boolean, res: string, x: number, y: number, width: number, height: number): void;
6361
+ function setLayout(params: LayoutData): Promise<void>;
6519
6362
  /**
6520
- * 销毁当前小程序
6363
+ * 主动销毁当前小程序
6364
+ * @returns 调用结果
6521
6365
  */
6522
- function disposal(): void;
6366
+ function disposal(): Promise<void>;
6523
6367
  /**
6524
6368
  * 设置浮窗小程序的关闭按钮
6525
6369
  * @param params - 设置关闭按钮参数
@@ -9371,6 +9215,7 @@ type NativeVideoComponentConfig = {
9371
9215
  /**
9372
9216
  * 创建原生视频组件参数
9373
9217
  * @property [url] - 视频url
9218
+ * @property [coverImgUrl] - 视频首帧画面url
9374
9219
  * @property [autoPlay] - 可选,是否自动播放,默认是否
9375
9220
  * @property [mutePlay] - 可选,是否静音播放,默认是否
9376
9221
  * @property [liveVodMode] - 实时点播模式
@@ -9379,6 +9224,7 @@ type NativeVideoComponentConfig = {
9379
9224
  */
9380
9225
  type CreateNativeVideoComponentReq = {
9381
9226
  url?: string;
9227
+ coverImgUrl?: string;
9382
9228
  autoPlay?: boolean;
9383
9229
  mutePlay?: boolean;
9384
9230
  liveVodMode?: LiveVodModeInfo;
@@ -9644,17 +9490,16 @@ type PopupParams = {
9644
9490
  param?: any;
9645
9491
  };
9646
9492
 
9493
+ /**
9494
+ * vip
9495
+ */
9647
9496
  namespace vip {
9648
9497
  /**
9649
- * 获取小程序授权token
9650
- * @returns 返回小程序授权token
9651
- */
9652
- function getJWT(): Promise<object>;
9653
- /**
9654
- * 获取小程序授权token
9655
- * @returns 返回小程序授权token
9498
+ * 获取当前用户Token
9499
+ * @param [params] - 参数
9500
+ * @returns 返回凭证信息
9656
9501
  */
9657
- function getJWT(): Promise<object>;
9502
+ function getJWT(params?: GetJWTReq): Promise<JWTInfo>;
9658
9503
  }
9659
9504
 
9660
9505
  /**