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

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 +984 -99
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -225,6 +225,731 @@ 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
+
228
953
  /**
229
954
  * IEG上报
230
955
  */
@@ -1683,27 +2408,20 @@ namespace app {
1683
2408
  }
1684
2409
 
1685
2410
  /**
1686
- * 监听加载完成
2411
+ * 扩展加载完成回调
1687
2412
  * @param callback - 回调函数
1688
- * @returns 调用结果
1689
2413
  */
1690
2414
  function onLoad(callback: (...params: any[]) => any): void;
1691
2415
 
1692
- /**
1693
- * 监听取消加载
1694
- * @returns 调用结果
1695
- */
1696
2416
  function onUnload(callback: (...params: any[]) => any): void;
1697
2417
 
1698
2418
  /**
1699
2419
  * 注册App进入前台时回调
1700
- * @returns 调用结果
1701
2420
  */
1702
2421
  function onEnterForeground(callback: (...params: any[]) => any): void;
1703
2422
 
1704
2423
  /**
1705
2424
  * 注册App进入后台时回调
1706
- * @returns 调用结果
1707
2425
  */
1708
2426
  function onLeaveForeground(callback: (...params: any[]) => any): void;
1709
2427
 
@@ -1714,15 +2432,13 @@ type LifeCallback = () => void;
1714
2432
 
1715
2433
  /**
1716
2434
  * 小程序显示的生命周期
1717
- * @returns 调用结果
1718
2435
  */
1719
- function onAppear(callback: LifeCallback): void;
2436
+ function onAppear(callback: (...params: any[]) => any): void;
1720
2437
 
1721
2438
  /**
1722
2439
  * 小程序隐藏的生命周期
1723
- * @returns 调用结果
1724
2440
  */
1725
- function onDisappear(callback: LifeCallback): void;
2441
+ function onDisappear(callback: (...params: any[]) => any): void;
1726
2442
 
1727
2443
  /**
1728
2444
  * auth模块
@@ -1753,15 +2469,27 @@ type RequestAuthRsp = {
1753
2469
  };
1754
2470
 
1755
2471
  /**
1756
- * 后台模块
2472
+ * 后台
1757
2473
  */
1758
2474
  namespace backend {
1759
2475
  /**
1760
2476
  * 通用查询后台状态接口
1761
- * @param params - 参数
1762
- * @returns // key传入getServerTime参数时,返回GetServerTimeRsp,传入getPKInfo参数时, 返回GetPKInfoRsp
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 - 参数
1763
2488
  */
1764
- function commonQuery(params: SearchOptions): Promise<CommonQueryResp>;
2489
+ function commonQuery(params: {
2490
+ key: string;
2491
+ param: any;
2492
+ }): void;
1765
2493
  /**
1766
2494
  * 通用上行接口
1767
2495
  * @param params - 操作选项
@@ -2018,38 +2746,91 @@ type consts = Consts;
2018
2746
  namespace context {
2019
2747
  /**
2020
2748
  * 监听直播间消息
2021
- * @param topic - 宿主消息名, activated-小程序激活, subscribeSubmit-【观众端】当前观众订阅状态发生变化, giftSubmit-【观众端】当前观众送礼, barrageSubmit-当前用户发送弹幕, unzipProgress-每个任务的解压进度, userInteract-用户交互信息, openCoinPanelClosed-能量豆弹窗关闭, uiVisibilityStateChange-工具栏状态
2749
+ * @param topic - 消息名
2022
2750
  * @param callback - 收到消息时回调 返回消息内容
2023
- * @returns 调用结果
2024
2751
  */
2025
- function on(topic: string, callback: ContextOnCallback): void;
2752
+ function on(topic: string, callback: (...params: any[]) => any): void;
2026
2753
  /**
2027
2754
  * 取消监听直播间消息
2028
- * @param topic - 宿主消息名, activated-小程序激活, subscribeSubmit-【观众端】当前观众订阅状态发生变化, giftSubmit-【观众端】当前观众送礼, barrageSubmit-当前用户发送弹幕, unzipProgress-每个任务的解压进度, userInteract-用户交互信息, openCoinPanelClosed-能量豆弹窗关闭, uiVisibilityStateChange-工具栏状态
2029
- * @param [callback] - 收到消息时回调 返回消息内容
2030
- * @returns 调用结果
2755
+ * @param topic - 消息名
2756
+ * @param callback - 收到消息时回调 返回消息内容
2031
2757
  */
2032
- function off(topic: string, callback?: ContextOnCallback): void;
2758
+ function off(topic: string, callback: (...params: any[]) => any): void;
2033
2759
  /**
2034
- * 显示互动通道入口红点
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 - 消息名
2805
+ * @param callback - 收到消息时回调 返回消息内容
2806
+ */
2807
+ function on(topic: string, callback: (...params: any[]) => any): void;
2808
+ /**
2809
+ * 取消监听直播间消息
2810
+ * @param topic - 消息名
2811
+ * @param callback - 收到消息时回调 返回消息内容
2812
+ */
2813
+ function off(topic: string, callback: (...params: any[]) => any): void;
2814
+ /**
2815
+ * 显示红点
2035
2816
  * @returns 返回是否显示成功
2036
2817
  */
2037
- function showActivityBadge(): Promise<void>;
2818
+ function showActivityBadge(): Promise<object>;
2038
2819
  /**
2039
2820
  * 显示toast
2040
2821
  * @param message - toast中显示的消息
2822
+ * @returns 返回toast是否显示成功
2041
2823
  */
2042
- function showToast(message: string): Promise<void>;
2824
+ function showToast(message: string): Promise<object>;
2043
2825
  /**
2044
2826
  * 获取安全区域的位置
2045
- * @returns 返回安全区域位置信息
2827
+ * @returns 返回安全区域位置 left, top, right, bottom
2046
2828
  */
2047
- function getSafeAreaPosition(): Promise<PositionInfo>;
2829
+ function getSafeAreaPosition(): Promise<object>;
2048
2830
  /**
2049
2831
  * 监听当前直播间小程序容器布局变化消息
2050
- * @param callback - 小程序容器布局变化回调
2051
2832
  */
2052
- function onLayoutChange(callback: LayoutChange): Promise<void>;
2833
+ function onLayoutChange(callback: LayoutChange): void;
2053
2834
  /**
2054
2835
  * 引导订阅
2055
2836
  */
@@ -2088,14 +2869,22 @@ namespace context {
2088
2869
  function leadBarrage(): Promise<void>;
2089
2870
  /**
2090
2871
  * 监听所有弹幕
2091
- * @param options - 弹幕筛选条件
2092
- * @param callback - 弹幕信息回调
2093
- */
2094
- function onBarrageChange(options: OnBarrageChangeOptions, callback: BarrageCallback): Promise<void>;
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;
2095
2884
  /**
2096
2885
  * 关闭监听所有弹幕
2097
2886
  */
2098
- function offBarrageChange(): Promise<void>;
2887
+ function offBarrageChange(): void;
2099
2888
  /**
2100
2889
  * 监听开通守护
2101
2890
  * @param params - 监听开通守护参数
@@ -2153,10 +2942,10 @@ namespace context {
2153
2942
  */
2154
2943
  function getLiveInfo(): Promise<RespLiveInfo>;
2155
2944
  /**
2156
- * 获取用户信息
2157
- * @returns 返回用户信息
2945
+ * 获取用户信息,目前返回昵称、头像信息
2946
+ * @returns 返回用户信息,{ userNick, userAvatar }
2158
2947
  */
2159
- function getUserInfo(): Promise<UserInfo>;
2948
+ function getUserInfo(): Promise<object>;
2160
2949
  /**
2161
2950
  * 获取直播间的粉丝榜信息
2162
2951
  * @returns 返回直播间粉丝榜信息
@@ -2231,10 +3020,10 @@ namespace context {
2231
3020
  function setBarrageInputPlaceholder(params: SetBarrageInputPlaceholderReq): Promise<void>;
2232
3021
  /**
2233
3022
  * 获取登录凭证
2234
- * @param params - 请求参数
3023
+ * @param [params] - 请求参数
2235
3024
  * @returns 返回结果
2236
3025
  */
2237
- function login(params: LoginReq): Promise<LoginRsp>;
3026
+ function login(params?: LoginReq): Promise<LoginRsp>;
2238
3027
  /**
2239
3028
  * 检查登录态是否过期
2240
3029
  * @returns 调起成功
@@ -2262,7 +3051,6 @@ type PositionInfo = {
2262
3051
  };
2263
3052
 
2264
3053
  /**
2265
- * 容器变化消息
2266
3054
  * @property screenWidth - 容器宽度
2267
3055
  * @property screenHeight - 容器高度
2268
3056
  * @property isLandscape - 是否横屏,web端固定为true
@@ -2273,10 +3061,6 @@ type LayoutInfo = {
2273
3061
  isLandscape: boolean;
2274
3062
  };
2275
3063
 
2276
- /**
2277
- * 小程序容器布局变化回调
2278
- * @param info - 容器变化消息
2279
- */
2280
3064
  type LayoutChange = (info: LayoutInfo) => void;
2281
3065
 
2282
3066
  /**
@@ -2383,9 +3167,9 @@ type BarragerInfo = {
2383
3167
 
2384
3168
  /**
2385
3169
  * 弹幕信息回调
2386
- * @param barrageInfo - 弹幕消息
3170
+ * @param data - 参数
2387
3171
  */
2388
- type BarrageCallback = (barrageInfo: BarragerInfo) => void;
3172
+ type BarrageCallback = (data: BarrageData) => boolean;
2389
3173
 
2390
3174
  /**
2391
3175
  * 弹幕筛选条件
@@ -3602,29 +4386,47 @@ type OffOrientationChangeReq = {
3602
4386
  function requestEbs(options: any): void;
3603
4387
 
3604
4388
  /**
3605
- * 环境相关
4389
+ * 环境信息
3606
4390
  */
3607
4391
  namespace env {
3608
4392
  /**
3609
4393
  * 获取当前版本类型
3610
- * @returns 返回当前版本类型
3611
4394
  */
3612
- function getVersionType(): Promise<GetVersionTypeRsp>;
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>;
3613
4415
  /**
3614
4416
  * 获取初始化参数
3615
4417
  * @returns 初始化参数
3616
4418
  */
3617
4419
  function getInitialParam(): Promise<object>;
3618
4420
  /**
3619
- * 获取小程序参数
3620
- * @returns 小程序参数
4421
+ * 获取小程序启动参数
4422
+ * @returns 小程序启动参数
3621
4423
  */
3622
- function getExtInfo(): Promise<GetExtInfoRsp>;
4424
+ function getExtInfo(): Promise<object>;
3623
4425
  /**
3624
- * 获取宿主信息接口
3625
- * @returns 返回宿主信息
4426
+ * 获取宿主信息接口,使用querystring解析rn bundle的查询串参数,返回给小程序
4427
+ * @returns 宿主信息
3626
4428
  */
3627
- function getHostInfo(): Promise<GetHostInfoRsp>;
4429
+ function getHostInfo(): Promise<object>;
3628
4430
  /**
3629
4431
  * 获取性能数据
3630
4432
  * @returns 调用结果
@@ -3970,16 +4772,27 @@ type FeedbackParams = {
3970
4772
  */
3971
4773
  namespace fs {
3972
4774
  /**
3973
- * 上传图片
3974
- * @returns 调用结果
4775
+ * 调取本地相册
3975
4776
  */
3976
- function uploadImg(): Promise<UrlInfo>;
4777
+ function uploadImg(): void;
3977
4778
  /**
3978
- * 离线资源是否下载完成
3979
- * @param params - 监听参数
3980
- * @returns 调用结果
4779
+ * 监听离线资源是否下载完成消息
4780
+ * @param params.url - 资源地址
4781
+ */
4782
+ function offlineFileReady(params: {
4783
+ url: string;
4784
+ }): Promise<string>;
4785
+ /**
4786
+ * 调取本地相册
4787
+ */
4788
+ function uploadImg(): void;
4789
+ /**
4790
+ * 监听离线资源是否下载完成消息
4791
+ * @param params.url - 资源地址
3981
4792
  */
3982
- function offlineFileReady(params: UrlInfo): Promise<void>;
4793
+ function offlineFileReady(params: {
4794
+ url: string;
4795
+ }): Promise<string>;
3983
4796
  /**
3984
4797
  * 通用上传文件接口
3985
4798
  * @returns 调用结果
@@ -5153,41 +5966,85 @@ type OBCallback = (content: any) => void;
5153
5966
  */
5154
5967
  namespace observer {
5155
5968
  /**
5156
- * 监听小程序消息
5969
+ * 监听后台消息
5157
5970
  * @param topic - 消息名
5158
5971
  * @param callback - 收到消息时回调 返回对应消息名的后台消息content
5159
- * @returns 调用结果
5160
5972
  */
5161
- function on(topic: string, callback: ObserverCallback): void;
5973
+ function on(topic: string, callback: (...params: any[]) => any): void;
5162
5974
  /**
5163
5975
  * 取消监听后台消息
5164
5976
  * @param topic - 消息名
5165
- * @param [callback] - 消息回调
5166
- * @returns 调用结果
5167
5977
  */
5168
- function off(topic: string, callback?: ObserverCallback): void;
5978
+ function off(topic: string, callback: (...params: any[]) => any): void;
5169
5979
  /**
5170
5980
  * 触发小程序消息
5171
- * @param topic - 小程序消息名
5172
- * @param message - 小程序消息内容
5173
5981
  */
5174
- function emit(topic: string, message: string): Promise<void>;
5982
+ function emit(topic: string, message: string): Promise<any>;
5175
5983
  /**
5176
- * 监听本地小程序消息
5177
- * @param params - 监听本地小程序参数
5984
+ * 监听自身小程序消息
5985
+ * @param params.eventName - 消息名
5986
+ * @param params.callback - 回调
5178
5987
  */
5179
- function onLocalMessage(params: LocalMessageParams): Promise<void>;
5988
+ function onLocalMessage(params: {
5989
+ eventName: string;
5990
+ callback: (...params: any[]) => any;
5991
+ }): void;
5180
5992
  /**
5181
5993
  * 取消监听自身小程序消息
5182
- * @param params - 取消监听参数
5994
+ * @param params.eventName - 消息名
5183
5995
  */
5184
- function offLocalMessage(params: OffLocalMessageParams): Promise<void>;
5996
+ function offLocalMessage(params: {
5997
+ eventName: string;
5998
+ }): void;
5185
5999
  /**
5186
- * 触发小程序本地消息
5187
- * @param params - 本地消息参数
5188
- * @returns 调用结果
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
+ * 监听后台消息
6010
+ * @param topic - 消息名
6011
+ * @param callback - 收到消息时回调 返回对应消息名的后台消息content
6012
+ */
6013
+ function on(topic: string, callback: (...params: any[]) => any): void;
6014
+ /**
6015
+ * 取消监听后台消息
6016
+ * @param topic - 消息名
6017
+ */
6018
+ function off(topic: string, callback: (...params: any[]) => any): void;
6019
+ /**
6020
+ * 触发小程序消息
6021
+ */
6022
+ function emit(topic: string, message: string): Promise<any>;
6023
+ /**
6024
+ * 监听自身小程序消息
6025
+ * @param params.eventName - 消息名
6026
+ * @param params.callback - 回调
6027
+ */
6028
+ function onLocalMessage(params: {
6029
+ eventName: string;
6030
+ callback: (...params: any[]) => any;
6031
+ }): void;
6032
+ /**
6033
+ * 取消监听自身小程序消息
6034
+ * @param params.eventName - 消息名
6035
+ */
6036
+ function offLocalMessage(params: {
6037
+ eventName: string;
6038
+ }): void;
6039
+ /**
6040
+ * 发送小程序消息
6041
+ * @param params.eventName - 消息名
6042
+ * @param params.callback - 回调
5189
6043
  */
5190
- function postLocalMessage(params: PostLocalMessageParams): Promise<void>;
6044
+ function postLocalMessage(params: {
6045
+ eventName: string;
6046
+ callback: (...params: any[]) => any;
6047
+ }): Promise<any>;
5191
6048
  /**
5192
6049
  * 广播开发者维度的本地消息
5193
6050
  * @param params - 本地消息参数
@@ -5249,15 +6106,25 @@ type PostLocalMessageParams = {
5249
6106
  };
5250
6107
 
5251
6108
  /**
5252
- * 秩序相关
6109
+ * 秩序
5253
6110
  */
5254
6111
  namespace order {
5255
6112
  /**
5256
6113
  * 发起小程序文本的秩序审核
5257
- * @param param - 文本秩序审核参数
5258
- * @returns 调用结果,reject为审核失败
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 - 要检查的字符串
5259
6124
  */
5260
- function reportText(param: ReportTextParams): Promise<void>;
6125
+ function reportText(param: {
6126
+ text: string;
6127
+ }): void;
5261
6128
  }
5262
6129
 
5263
6130
  /**
@@ -5626,16 +6493,33 @@ type OnInviteMessageParams = {
5626
6493
  */
5627
6494
  namespace panel {
5628
6495
  /**
5629
- * 设置小程序布局
5630
- * @param params - 布局信息
5631
- * @returns 调用结果
6496
+ * 改变小程序面板的布局,包括显示位置和显示大小
6497
+ * @param visible - 是否可见,默认true,
6498
+ * @param res - 取值 'PLAYER'
6499
+ * @param x - 横坐标
6500
+ * @param y - 纵坐标
6501
+ * @param width - 宽度
6502
+ * @param height - 高度
5632
6503
  */
5633
- function setLayout(params: LayoutData): Promise<void>;
6504
+ function setLayout(visible: boolean, res: string, x: number, y: number, width: number, height: number): void;
5634
6505
  /**
5635
- * 主动销毁当前小程序
5636
- * @returns 调用结果
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 - 高度
6517
+ */
6518
+ function setLayout(visible: boolean, res: string, x: number, y: number, width: number, height: number): void;
6519
+ /**
6520
+ * 销毁当前小程序
5637
6521
  */
5638
- function disposal(): Promise<void>;
6522
+ function disposal(): void;
5639
6523
  /**
5640
6524
  * 设置浮窗小程序的关闭按钮
5641
6525
  * @param params - 设置关闭按钮参数
@@ -8760,16 +9644,17 @@ type PopupParams = {
8760
9644
  param?: any;
8761
9645
  };
8762
9646
 
8763
- /**
8764
- * vip
8765
- */
8766
9647
  namespace vip {
8767
9648
  /**
8768
- * 获取当前用户Token
8769
- * @param [params] - 参数
8770
- * @returns 返回凭证信息
9649
+ * 获取小程序授权token
9650
+ * @returns 返回小程序授权token
9651
+ */
9652
+ function getJWT(): Promise<object>;
9653
+ /**
9654
+ * 获取小程序授权token
9655
+ * @returns 返回小程序授权token
8771
9656
  */
8772
- function getJWT(params?: GetJWTReq): Promise<JWTInfo>;
9657
+ function getJWT(): Promise<object>;
8773
9658
  }
8774
9659
 
8775
9660
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hyext/types-ext-sdk-hy",
3
- "version": "3.16.0-beta.6",
3
+ "version": "3.16.0",
4
4
  "description": "TypeScript definitions for sdk",
5
5
  "types": "./index.d.ts",
6
6
  "main": "",