@hyext/types-ext-sdk-hy 4.2.5-beta.8 → 4.2.6-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.
- package/index.d.ts +1138 -18
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -582,6 +582,154 @@ namespace ad {
|
|
|
582
582
|
* @returns 调用结果
|
|
583
583
|
*/
|
|
584
584
|
function offAdMessage(): Promise<void>;
|
|
585
|
+
/**
|
|
586
|
+
* 创建原生模板广告组件
|
|
587
|
+
* @param params - 传入参数
|
|
588
|
+
* @returns 调用结果
|
|
589
|
+
*/
|
|
590
|
+
function createCustomAd(params: CreateCustomAdReq): Promise<CreateCustomAdRsp>;
|
|
591
|
+
/**
|
|
592
|
+
* 创建激励视频广告组件
|
|
593
|
+
* @param params - 传入参数
|
|
594
|
+
* @returns 调用结果
|
|
595
|
+
*/
|
|
596
|
+
function createRewardedVideoAd(params: CreateRewardedVideoAdReq): Promise<CreateRewardedVideoAdRsp>;
|
|
597
|
+
/**
|
|
598
|
+
* 销毁原生模板广告组件
|
|
599
|
+
* @param params - 传入参数
|
|
600
|
+
* @returns 调用结果
|
|
601
|
+
*/
|
|
602
|
+
function destroyCustomAd(params: DestroyCustomAdReq): Promise<DestroyCustomAdRsp>;
|
|
603
|
+
/**
|
|
604
|
+
* 销毁激励视频广告组件
|
|
605
|
+
* @param params - 传入参数
|
|
606
|
+
* @returns 调用结果
|
|
607
|
+
*/
|
|
608
|
+
function destroyRewardedVideoAd(params: DestroyRewardedVideoAdReq): Promise<DestroyRewardedVideoAdRsp>;
|
|
609
|
+
/**
|
|
610
|
+
* 获取原生模版广告组件的信息
|
|
611
|
+
* @param params - 传入参数
|
|
612
|
+
* @returns 调用结果
|
|
613
|
+
*/
|
|
614
|
+
function getCustomAdInfo(params: GetCustomAdInfoReq): Promise<GetCustomAdInfoRsp>;
|
|
615
|
+
/**
|
|
616
|
+
* 隐藏原生模版广告组件
|
|
617
|
+
* @param params - 传入参数
|
|
618
|
+
* @returns 调用结果
|
|
619
|
+
*/
|
|
620
|
+
function hideCustomAd(params: HideCustomAdReq): Promise<HideCustomAdRsp>;
|
|
621
|
+
/**
|
|
622
|
+
* 加载激励视频广告组件
|
|
623
|
+
* @param params - 传入参数
|
|
624
|
+
* @returns 调用结果
|
|
625
|
+
*/
|
|
626
|
+
function loadRewardedVideoAd(params: LoadRewardedVideoAdReq): Promise<LoadRewardedVideoAdRsp>;
|
|
627
|
+
/**
|
|
628
|
+
* 监听原生模版广告组件的close消息
|
|
629
|
+
* @param params - 传入参数
|
|
630
|
+
* @returns 调用结果
|
|
631
|
+
*/
|
|
632
|
+
function onCustomAdClose(params: OnCustomAdCloseReq): Promise<void>;
|
|
633
|
+
/**
|
|
634
|
+
* 取消监听原生模版广告组件的close消息
|
|
635
|
+
* @returns 调用结果
|
|
636
|
+
*/
|
|
637
|
+
function offCustomAdClose(): Promise<void>;
|
|
638
|
+
/**
|
|
639
|
+
* 监听原生模版广告组件的error消息
|
|
640
|
+
* @param params - 传入参数
|
|
641
|
+
* @returns 调用结果
|
|
642
|
+
*/
|
|
643
|
+
function onCustomAdError(params: OnCustomAdErrorReq): Promise<void>;
|
|
644
|
+
/**
|
|
645
|
+
* 取消监听原生模版广告组件的error消息
|
|
646
|
+
* @returns 调用结果
|
|
647
|
+
*/
|
|
648
|
+
function offCustomAdError(): Promise<void>;
|
|
649
|
+
/**
|
|
650
|
+
* 监听原生模版广告组件的hide消息
|
|
651
|
+
* @param params - 传入参数
|
|
652
|
+
* @returns 调用结果
|
|
653
|
+
*/
|
|
654
|
+
function onCustomAdHide(params: OnCustomAdHideReq): Promise<void>;
|
|
655
|
+
/**
|
|
656
|
+
* 取消监听原生模版广告组件的hide消息
|
|
657
|
+
* @returns 调用结果
|
|
658
|
+
*/
|
|
659
|
+
function offCustomAdHide(): Promise<void>;
|
|
660
|
+
/**
|
|
661
|
+
* 监听原生模版广告组件的load消息
|
|
662
|
+
* @param params - 传入参数
|
|
663
|
+
* @returns 调用结果
|
|
664
|
+
*/
|
|
665
|
+
function onCustomAdLoad(params: OnCustomAdLoadReq): Promise<void>;
|
|
666
|
+
/**
|
|
667
|
+
* 取消监听原生模版广告组件的load消息
|
|
668
|
+
* @returns 调用结果
|
|
669
|
+
*/
|
|
670
|
+
function offCustomAdLoad(): Promise<void>;
|
|
671
|
+
/**
|
|
672
|
+
* 监听原生模版广告组件的resize消息
|
|
673
|
+
* @param params - 传入参数
|
|
674
|
+
* @returns 调用结果
|
|
675
|
+
*/
|
|
676
|
+
function onCustomAdResize(params: OnCustomAdResizeReq): Promise<void>;
|
|
677
|
+
/**
|
|
678
|
+
* 取消监听原生模版广告组件的resize消息
|
|
679
|
+
* @returns 调用结果
|
|
680
|
+
*/
|
|
681
|
+
function offCustomAdResize(): Promise<void>;
|
|
682
|
+
/**
|
|
683
|
+
* 监听激励视频广告组件的close消息
|
|
684
|
+
* @param params - 传入参数
|
|
685
|
+
* @returns 调用结果
|
|
686
|
+
*/
|
|
687
|
+
function onRewardedVideoAdClose(params: OnRewardedVideoAdCloseReq): Promise<void>;
|
|
688
|
+
/**
|
|
689
|
+
* 取消监听激励视频广告组件的close消息
|
|
690
|
+
* @returns 调用结果
|
|
691
|
+
*/
|
|
692
|
+
function offRewardedVideoAdClose(): Promise<void>;
|
|
693
|
+
/**
|
|
694
|
+
* 监听激励视频广告组件的error消息
|
|
695
|
+
* @param params - 传入参数
|
|
696
|
+
* @returns 调用结果
|
|
697
|
+
*/
|
|
698
|
+
function onRewardedVideoAdError(params: OnRewardedVideoAdErrorReq): Promise<void>;
|
|
699
|
+
/**
|
|
700
|
+
* 取消监听激励视频广告组件的error消息
|
|
701
|
+
* @returns 调用结果
|
|
702
|
+
*/
|
|
703
|
+
function offRewardedVideoAdError(): Promise<void>;
|
|
704
|
+
/**
|
|
705
|
+
* 监听激励视频广告组件的load消息
|
|
706
|
+
* @param params - 传入参数
|
|
707
|
+
* @returns 调用结果
|
|
708
|
+
*/
|
|
709
|
+
function onRewardedVideoAdLoad(params: OnRewardedVideoAdLoadReq): Promise<void>;
|
|
710
|
+
/**
|
|
711
|
+
* 取消监听激励视频广告组件的load消息
|
|
712
|
+
* @returns 调用结果
|
|
713
|
+
*/
|
|
714
|
+
function offRewardedVideoAdLoad(): Promise<void>;
|
|
715
|
+
/**
|
|
716
|
+
* 打开原生模版广告组件落地页
|
|
717
|
+
* @param params - 传入参数
|
|
718
|
+
* @returns 调用结果
|
|
719
|
+
*/
|
|
720
|
+
function openCustomAd(params: OpenCustomAdReq): Promise<OpenCustomAdRsp>;
|
|
721
|
+
/**
|
|
722
|
+
* 显示原生模版广告组件
|
|
723
|
+
* @param params - 传入参数
|
|
724
|
+
* @returns 调用结果
|
|
725
|
+
*/
|
|
726
|
+
function showCustomAd(params: ShowCustomAdReq): Promise<ShowCustomAdRsp>;
|
|
727
|
+
/**
|
|
728
|
+
* 显示激励视频广告组件
|
|
729
|
+
* @param params - 传入参数
|
|
730
|
+
* @returns 调用结果
|
|
731
|
+
*/
|
|
732
|
+
function showRewardedVideoAd(params: ShowRewardedVideoAdReq): Promise<ShowRewardedVideoAdRsp>;
|
|
585
733
|
}
|
|
586
734
|
|
|
587
735
|
/**
|
|
@@ -797,6 +945,416 @@ type OnAdMessageReq = {
|
|
|
797
945
|
callback: AdMessageCallback;
|
|
798
946
|
};
|
|
799
947
|
|
|
948
|
+
/**
|
|
949
|
+
* 原生模板广告组件的样式
|
|
950
|
+
* @property left - 原生模板广告组件的左上角横坐标
|
|
951
|
+
* @property top - 原生模板广告组件的左上角纵坐标
|
|
952
|
+
* @property [width] - 原生模板广告组件的宽度(仅在某些模板生效,如矩阵格子)
|
|
953
|
+
* @property [fixed] - (只对小程序适用) 原生模板广告组件是否固定屏幕位置(不跟随屏幕滚动)
|
|
954
|
+
*/
|
|
955
|
+
type CustomAdStyle = {
|
|
956
|
+
left: number;
|
|
957
|
+
top: number;
|
|
958
|
+
width?: number;
|
|
959
|
+
fixed?: boolean;
|
|
960
|
+
};
|
|
961
|
+
|
|
962
|
+
/**
|
|
963
|
+
* 创建原生模板广告组件参数
|
|
964
|
+
* @property adUnitId - 广告单元 id
|
|
965
|
+
* @property adIntervals - 广告自动刷新的间隔时间,单位为秒,参数值必须大于等于30(仅对支持自动刷新的模板生效)
|
|
966
|
+
* @property style - 原生模板广告组件的样式
|
|
967
|
+
*/
|
|
968
|
+
type CreateCustomAdReq = {
|
|
969
|
+
adUnitId: string;
|
|
970
|
+
adIntervals: number;
|
|
971
|
+
style: CustomAdStyle;
|
|
972
|
+
};
|
|
973
|
+
|
|
974
|
+
/**
|
|
975
|
+
* 创建原生模板广告组件结果
|
|
976
|
+
* @property errMsg - 错误信息,如果调用成功返回 ${apiName}:ok
|
|
977
|
+
* @property errCode - 错误码,成功时为 0,失败时参考错误码说明
|
|
978
|
+
* @property errno - 错误码,成功时为 0,失败时参考错误码说明
|
|
979
|
+
* @property customAdId - 原生模板广告组件id
|
|
980
|
+
*/
|
|
981
|
+
type CreateCustomAdRsp = {
|
|
982
|
+
errMsg: string;
|
|
983
|
+
errCode: number;
|
|
984
|
+
errno: number;
|
|
985
|
+
customAdId: string;
|
|
986
|
+
};
|
|
987
|
+
|
|
988
|
+
/**
|
|
989
|
+
* 创建激励视频广告组件参数
|
|
990
|
+
* @property adUnitId - 广告单元 id
|
|
991
|
+
* @property [multiton] - 是否启用多例模式,默认为false
|
|
992
|
+
* @property [disableFallbackSharePage] - 是否禁用分享页,默认为false
|
|
993
|
+
*/
|
|
994
|
+
type CreateRewardedVideoAdReq = {
|
|
995
|
+
adUnitId: string;
|
|
996
|
+
multiton?: boolean;
|
|
997
|
+
disableFallbackSharePage?: boolean;
|
|
998
|
+
};
|
|
999
|
+
|
|
1000
|
+
/**
|
|
1001
|
+
* 创建激励视频广告组件结果
|
|
1002
|
+
* @property errMsg - 错误信息,如果调用成功返回 ${apiName}:ok
|
|
1003
|
+
* @property errCode - 错误码,成功时为 0,失败时参考错误码说明
|
|
1004
|
+
* @property errno - 错误码,成功时为 0,失败时参考错误码说明
|
|
1005
|
+
* @property rewardedVideoAdId - 激励视频广告组件id
|
|
1006
|
+
*/
|
|
1007
|
+
type CreateRewardedVideoAdRsp = {
|
|
1008
|
+
errMsg: string;
|
|
1009
|
+
errCode: number;
|
|
1010
|
+
errno: number;
|
|
1011
|
+
rewardedVideoAdId: string;
|
|
1012
|
+
};
|
|
1013
|
+
|
|
1014
|
+
/**
|
|
1015
|
+
* 销毁原生模板广告组件参数
|
|
1016
|
+
* @property customAdId - 原生模板广告组件id
|
|
1017
|
+
*/
|
|
1018
|
+
type DestroyCustomAdReq = {
|
|
1019
|
+
customAdId: string;
|
|
1020
|
+
};
|
|
1021
|
+
|
|
1022
|
+
/**
|
|
1023
|
+
* 销毁原生模板广告组件结果
|
|
1024
|
+
* @property errMsg - 错误信息,如果调用成功返回 ${apiName}:ok
|
|
1025
|
+
* @property errCode - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1026
|
+
* @property errno - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1027
|
+
*/
|
|
1028
|
+
type DestroyCustomAdRsp = {
|
|
1029
|
+
errMsg: string;
|
|
1030
|
+
errCode: number;
|
|
1031
|
+
errno: number;
|
|
1032
|
+
};
|
|
1033
|
+
|
|
1034
|
+
/**
|
|
1035
|
+
* 销毁激励视频广告组件参数
|
|
1036
|
+
* @property rewardedVideoAdId - 激励视频广告组件id
|
|
1037
|
+
*/
|
|
1038
|
+
type DestroyRewardedVideoAdReq = {
|
|
1039
|
+
rewardedVideoAdId: string;
|
|
1040
|
+
};
|
|
1041
|
+
|
|
1042
|
+
/**
|
|
1043
|
+
* 销毁激励视频广告组件结果
|
|
1044
|
+
* @property errMsg - 错误信息,如果调用成功返回 ${apiName}:ok
|
|
1045
|
+
* @property errCode - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1046
|
+
* @property errno - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1047
|
+
*/
|
|
1048
|
+
type DestroyRewardedVideoAdRsp = {
|
|
1049
|
+
errMsg: string;
|
|
1050
|
+
errCode: number;
|
|
1051
|
+
errno: number;
|
|
1052
|
+
};
|
|
1053
|
+
|
|
1054
|
+
/**
|
|
1055
|
+
* 获取原生模版广告组件的信息参数
|
|
1056
|
+
* @property customAdId - 原生模版广告组件id
|
|
1057
|
+
*/
|
|
1058
|
+
type GetCustomAdInfoReq = {
|
|
1059
|
+
customAdId: string;
|
|
1060
|
+
};
|
|
1061
|
+
|
|
1062
|
+
/**
|
|
1063
|
+
* 获取原生模版广告组件的信息结果
|
|
1064
|
+
* @property errCode - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1065
|
+
* @property errno - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1066
|
+
* @property isShow - 原生模板广告是否正在展示
|
|
1067
|
+
*/
|
|
1068
|
+
type GetCustomAdInfoRsp = {
|
|
1069
|
+
errCode: number;
|
|
1070
|
+
errno: number;
|
|
1071
|
+
isShow: boolean;
|
|
1072
|
+
};
|
|
1073
|
+
|
|
1074
|
+
/**
|
|
1075
|
+
* 隐藏原生模版广告组件参数
|
|
1076
|
+
* @property customAdId - 原生模版广告组件id
|
|
1077
|
+
*/
|
|
1078
|
+
type HideCustomAdReq = {
|
|
1079
|
+
customAdId: string;
|
|
1080
|
+
};
|
|
1081
|
+
|
|
1082
|
+
/**
|
|
1083
|
+
* 隐藏原生模版广告组件结果
|
|
1084
|
+
* @property errMsg - 错误信息,如果调用成功返回 ${apiName}:ok
|
|
1085
|
+
* @property errCode - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1086
|
+
* @property errno - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1087
|
+
*/
|
|
1088
|
+
type HideCustomAdRsp = {
|
|
1089
|
+
errMsg: string;
|
|
1090
|
+
errCode: number;
|
|
1091
|
+
errno: number;
|
|
1092
|
+
};
|
|
1093
|
+
|
|
1094
|
+
/**
|
|
1095
|
+
* 加载激励视频广告组件参数
|
|
1096
|
+
* @property rewardedVideoAdId - 激励视频广告组件id
|
|
1097
|
+
*/
|
|
1098
|
+
type LoadRewardedVideoAdReq = {
|
|
1099
|
+
rewardedVideoAdId: string;
|
|
1100
|
+
};
|
|
1101
|
+
|
|
1102
|
+
/**
|
|
1103
|
+
* 加载激励视频广告组件结果
|
|
1104
|
+
* @property errMsg - 错误信息,如果调用成功返回 ${apiName}:ok
|
|
1105
|
+
* @property errCode - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1106
|
+
* @property errno - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1107
|
+
*/
|
|
1108
|
+
type LoadRewardedVideoAdRsp = {
|
|
1109
|
+
errMsg: string;
|
|
1110
|
+
errCode: number;
|
|
1111
|
+
errno: number;
|
|
1112
|
+
};
|
|
1113
|
+
|
|
1114
|
+
/**
|
|
1115
|
+
* 原生模版广告组件关闭消息
|
|
1116
|
+
* @property customAdId - 原生模板广告组件id
|
|
1117
|
+
*/
|
|
1118
|
+
type OnCustomAdCloseNotice = {
|
|
1119
|
+
customAdId: string;
|
|
1120
|
+
};
|
|
1121
|
+
|
|
1122
|
+
/**
|
|
1123
|
+
* @param notice - 原生模版广告组件关闭消息
|
|
1124
|
+
*/
|
|
1125
|
+
type OnCustomAdCloseCallback = (notice: OnCustomAdCloseNotice) => void;
|
|
1126
|
+
|
|
1127
|
+
/**
|
|
1128
|
+
* 监听原生模版广告组件的close消息参数
|
|
1129
|
+
* @property callback - 消息回调函数
|
|
1130
|
+
*/
|
|
1131
|
+
type OnCustomAdCloseReq = {
|
|
1132
|
+
callback: OnCustomAdCloseCallback;
|
|
1133
|
+
};
|
|
1134
|
+
|
|
1135
|
+
/**
|
|
1136
|
+
* 原生模版广告组件错误消息
|
|
1137
|
+
* @property customAdId - 原生模板广告组件id
|
|
1138
|
+
* @property errMsg - 错误信息
|
|
1139
|
+
* @property errCode - 错误码(参考下面微信的文档)
|
|
1140
|
+
*/
|
|
1141
|
+
type OnCustomAdErrorNotice = {
|
|
1142
|
+
customAdId: string;
|
|
1143
|
+
errMsg: string;
|
|
1144
|
+
errCode: number;
|
|
1145
|
+
};
|
|
1146
|
+
|
|
1147
|
+
/**
|
|
1148
|
+
* @param notice - 原生模版广告组件错误消息
|
|
1149
|
+
*/
|
|
1150
|
+
type OnCustomAdErrorCallback = (notice: OnCustomAdErrorNotice) => void;
|
|
1151
|
+
|
|
1152
|
+
/**
|
|
1153
|
+
* 监听原生模版广告组件的error消息参数
|
|
1154
|
+
* @property callback - 消息回调函数
|
|
1155
|
+
*/
|
|
1156
|
+
type OnCustomAdErrorReq = {
|
|
1157
|
+
callback: OnCustomAdErrorCallback;
|
|
1158
|
+
};
|
|
1159
|
+
|
|
1160
|
+
/**
|
|
1161
|
+
* 原生模版广告组件隐藏消息
|
|
1162
|
+
* @property customAdId - 原生模板广告组件id
|
|
1163
|
+
*/
|
|
1164
|
+
type OnCustomAdHideNotice = {
|
|
1165
|
+
customAdId: string;
|
|
1166
|
+
};
|
|
1167
|
+
|
|
1168
|
+
/**
|
|
1169
|
+
* @param notice - 原生模版广告组件隐藏消息
|
|
1170
|
+
*/
|
|
1171
|
+
type OnCustomAdHideCallback = (notice: OnCustomAdHideNotice) => void;
|
|
1172
|
+
|
|
1173
|
+
/**
|
|
1174
|
+
* 监听原生模版广告组件的hide消息参数
|
|
1175
|
+
* @property callback - 消息回调函数
|
|
1176
|
+
*/
|
|
1177
|
+
type OnCustomAdHideReq = {
|
|
1178
|
+
callback: OnCustomAdHideCallback;
|
|
1179
|
+
};
|
|
1180
|
+
|
|
1181
|
+
/**
|
|
1182
|
+
* 原生模版广告组件加载消息
|
|
1183
|
+
* @property customAdId - 原生模板广告组件id
|
|
1184
|
+
*/
|
|
1185
|
+
type OnCustomAdLoadNotice = {
|
|
1186
|
+
customAdId: string;
|
|
1187
|
+
};
|
|
1188
|
+
|
|
1189
|
+
/**
|
|
1190
|
+
* @param notice - 原生模版广告组件加载消息
|
|
1191
|
+
*/
|
|
1192
|
+
type OnCustomAdLoadCallback = (notice: OnCustomAdLoadNotice) => void;
|
|
1193
|
+
|
|
1194
|
+
/**
|
|
1195
|
+
* 监听原生模版广告组件的load消息参数
|
|
1196
|
+
* @property callback - 消息回调函数
|
|
1197
|
+
*/
|
|
1198
|
+
type OnCustomAdLoadReq = {
|
|
1199
|
+
callback: OnCustomAdLoadCallback;
|
|
1200
|
+
};
|
|
1201
|
+
|
|
1202
|
+
/**
|
|
1203
|
+
* 原生模版广告组件缩放消息
|
|
1204
|
+
* @property customAdId - 原生模板广告组件id
|
|
1205
|
+
* @property width - 缩放后的宽度
|
|
1206
|
+
* @property height - 缩放后的高度
|
|
1207
|
+
*/
|
|
1208
|
+
type OnCustomAdResizeNotice = {
|
|
1209
|
+
customAdId: string;
|
|
1210
|
+
width: number;
|
|
1211
|
+
height: number;
|
|
1212
|
+
};
|
|
1213
|
+
|
|
1214
|
+
/**
|
|
1215
|
+
* @param notice - 原生模版广告组件缩放消息
|
|
1216
|
+
*/
|
|
1217
|
+
type OnCustomAdResizeCallback = (notice: OnCustomAdResizeNotice) => void;
|
|
1218
|
+
|
|
1219
|
+
/**
|
|
1220
|
+
* 监听原生模版广告组件的resize消息参数
|
|
1221
|
+
* @property callback - 消息回调函数
|
|
1222
|
+
*/
|
|
1223
|
+
type OnCustomAdResizeReq = {
|
|
1224
|
+
callback: OnCustomAdResizeCallback;
|
|
1225
|
+
};
|
|
1226
|
+
|
|
1227
|
+
/**
|
|
1228
|
+
* 激励视频广告组件关闭消息
|
|
1229
|
+
* @property rewardedVideoAdId - 激励视频广告组件id
|
|
1230
|
+
* @property isEnded - 视频是否是在用户完整观看的情况下被关闭的
|
|
1231
|
+
*/
|
|
1232
|
+
type OnRewardedVideoAdCloseNotice = {
|
|
1233
|
+
rewardedVideoAdId: string;
|
|
1234
|
+
isEnded: boolean;
|
|
1235
|
+
};
|
|
1236
|
+
|
|
1237
|
+
/**
|
|
1238
|
+
* @param notice - 激励视频广告组件关闭消息
|
|
1239
|
+
*/
|
|
1240
|
+
type OnRewardedVideoAdCloseCallback = (notice: OnRewardedVideoAdCloseNotice) => void;
|
|
1241
|
+
|
|
1242
|
+
/**
|
|
1243
|
+
* 监听激励视频广告组件的close消息参数
|
|
1244
|
+
* @property callback - 消息回调函数
|
|
1245
|
+
*/
|
|
1246
|
+
type OnRewardedVideoAdCloseReq = {
|
|
1247
|
+
callback: OnRewardedVideoAdCloseCallback;
|
|
1248
|
+
};
|
|
1249
|
+
|
|
1250
|
+
/**
|
|
1251
|
+
* 激励视频广告组件错误消息
|
|
1252
|
+
* @property rewardedVideoAdId - 激励视频广告组件id
|
|
1253
|
+
* @property errMsg - 错误信息
|
|
1254
|
+
* @property errCode - 错误码
|
|
1255
|
+
*/
|
|
1256
|
+
type OnRewardedVideoAdErrorNotice = {
|
|
1257
|
+
rewardedVideoAdId: string;
|
|
1258
|
+
errMsg: string;
|
|
1259
|
+
errCode: number;
|
|
1260
|
+
};
|
|
1261
|
+
|
|
1262
|
+
/**
|
|
1263
|
+
* @param notice - 激励视频广告组件错误消息
|
|
1264
|
+
*/
|
|
1265
|
+
type OnRewardedVideoAdErrorCallback = (notice: OnRewardedVideoAdErrorNotice) => void;
|
|
1266
|
+
|
|
1267
|
+
/**
|
|
1268
|
+
* 监听激励视频广告组件的error消息参数
|
|
1269
|
+
* @property callback - 消息回调函数
|
|
1270
|
+
*/
|
|
1271
|
+
type OnRewardedVideoAdErrorReq = {
|
|
1272
|
+
callback: OnRewardedVideoAdErrorCallback;
|
|
1273
|
+
};
|
|
1274
|
+
|
|
1275
|
+
/**
|
|
1276
|
+
* 激励视频广告组件加载消息
|
|
1277
|
+
* @property rewardedVideoAdId - 激励视频广告组件id
|
|
1278
|
+
* @property useFallbackSharePage - 仅小游戏支持,本次展示使用激励广告分享页
|
|
1279
|
+
*/
|
|
1280
|
+
type OnRewardedVideoAdLoadNotice = {
|
|
1281
|
+
rewardedVideoAdId: string;
|
|
1282
|
+
useFallbackSharePage: boolean;
|
|
1283
|
+
};
|
|
1284
|
+
|
|
1285
|
+
/**
|
|
1286
|
+
* @param notice - 激励视频广告组件加载消息
|
|
1287
|
+
*/
|
|
1288
|
+
type OnRewardedVideoAdLoadCallback = (notice: OnRewardedVideoAdLoadNotice) => void;
|
|
1289
|
+
|
|
1290
|
+
/**
|
|
1291
|
+
* 监听激励视频广告组件的load消息参数
|
|
1292
|
+
* @property callback - 消息回调函数
|
|
1293
|
+
*/
|
|
1294
|
+
type OnRewardedVideoAdLoadReq = {
|
|
1295
|
+
callback: OnRewardedVideoAdLoadCallback;
|
|
1296
|
+
};
|
|
1297
|
+
|
|
1298
|
+
/**
|
|
1299
|
+
* 打开原生模版广告组件落地页参数
|
|
1300
|
+
* @property customAdId - 原生模版广告组件id
|
|
1301
|
+
*/
|
|
1302
|
+
type OpenCustomAdReq = {
|
|
1303
|
+
customAdId: string;
|
|
1304
|
+
};
|
|
1305
|
+
|
|
1306
|
+
/**
|
|
1307
|
+
* 打开原生模版广告组件落地页结果
|
|
1308
|
+
* @property errMsg - 错误信息,如果调用成功返回 ${apiName}:ok
|
|
1309
|
+
* @property errCode - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1310
|
+
* @property errno - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1311
|
+
*/
|
|
1312
|
+
type OpenCustomAdRsp = {
|
|
1313
|
+
errMsg: string;
|
|
1314
|
+
errCode: number;
|
|
1315
|
+
errno: number;
|
|
1316
|
+
};
|
|
1317
|
+
|
|
1318
|
+
/**
|
|
1319
|
+
* 显示原生模版广告组件参数
|
|
1320
|
+
* @property customAdId - 原生模版广告组件id
|
|
1321
|
+
*/
|
|
1322
|
+
type ShowCustomAdReq = {
|
|
1323
|
+
customAdId: string;
|
|
1324
|
+
};
|
|
1325
|
+
|
|
1326
|
+
/**
|
|
1327
|
+
* 显示原生模版广告组件结果
|
|
1328
|
+
* @property errMsg - 错误信息,如果调用成功返回 ${apiName}:ok
|
|
1329
|
+
* @property errCode - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1330
|
+
* @property errno - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1331
|
+
*/
|
|
1332
|
+
type ShowCustomAdRsp = {
|
|
1333
|
+
errMsg: string;
|
|
1334
|
+
errCode: number;
|
|
1335
|
+
errno: number;
|
|
1336
|
+
};
|
|
1337
|
+
|
|
1338
|
+
/**
|
|
1339
|
+
* 显示激励视频广告组件参数
|
|
1340
|
+
* @property rewardedVideoAdId - 激励视频广告组件id
|
|
1341
|
+
*/
|
|
1342
|
+
type ShowRewardedVideoAdReq = {
|
|
1343
|
+
rewardedVideoAdId: string;
|
|
1344
|
+
};
|
|
1345
|
+
|
|
1346
|
+
/**
|
|
1347
|
+
* 显示激励视频广告组件结果
|
|
1348
|
+
* @property errMsg - 错误信息,如果调用成功返回 ${apiName}:ok
|
|
1349
|
+
* @property errCode - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1350
|
+
* @property errno - 错误码,成功时为 0,失败时参考下面的错误码说明
|
|
1351
|
+
*/
|
|
1352
|
+
type ShowRewardedVideoAdRsp = {
|
|
1353
|
+
errMsg: string;
|
|
1354
|
+
errCode: number;
|
|
1355
|
+
errno: number;
|
|
1356
|
+
};
|
|
1357
|
+
|
|
800
1358
|
/**
|
|
801
1359
|
* 高级模块
|
|
802
1360
|
*/
|
|
@@ -4389,43 +4947,145 @@ namespace device {
|
|
|
4389
4947
|
/**
|
|
4390
4948
|
* 获取折叠屏相关状态
|
|
4391
4949
|
*/
|
|
4392
|
-
function getFoldInfo(): Promise<FoldInfoRsp>;
|
|
4950
|
+
function getFoldInfo(): Promise<FoldInfoRsp>;
|
|
4951
|
+
/**
|
|
4952
|
+
* 获取系统音量
|
|
4953
|
+
*/
|
|
4954
|
+
function getSystemVolume(): Promise<GetSystemVolumeRsp>;
|
|
4955
|
+
/**
|
|
4956
|
+
* 监听系统音量变化
|
|
4957
|
+
* @param params - 输入参数
|
|
4958
|
+
*/
|
|
4959
|
+
function onSystemVolumeChange(params: OnSystemVolumeChangeReq): Promise<void>;
|
|
4960
|
+
/**
|
|
4961
|
+
* 取消监听系统音量变化
|
|
4962
|
+
*/
|
|
4963
|
+
function offSystemVolumeChange(): Promise<void>;
|
|
4964
|
+
/**
|
|
4965
|
+
* 监听屏幕转向切换事件
|
|
4966
|
+
* @param params - 输入参数
|
|
4967
|
+
*/
|
|
4968
|
+
function onOrientationChange(params: OnOrientationChangeReq): Promise<void>;
|
|
4969
|
+
/**
|
|
4970
|
+
* 取消监听屏幕转向切换事件
|
|
4971
|
+
* @param [params] - 输入参数
|
|
4972
|
+
*/
|
|
4973
|
+
function offOrientationChange(params?: OffOrientationChangeReq): Promise<void>;
|
|
4974
|
+
/**
|
|
4975
|
+
* 获取窗口信息
|
|
4976
|
+
*/
|
|
4977
|
+
function getWindowInfo(): WindowInfo;
|
|
4978
|
+
/**
|
|
4979
|
+
* 锁定横或竖屏
|
|
4980
|
+
* @param [params] - 输入参数
|
|
4981
|
+
*/
|
|
4982
|
+
function lockOrientation(params?: LockOrientationReq): Promise<void>;
|
|
4983
|
+
/**
|
|
4984
|
+
* 获取系统信息
|
|
4985
|
+
*/
|
|
4986
|
+
function getSystemInfo(): Promise<SystemInfo>;
|
|
4987
|
+
/**
|
|
4988
|
+
* 断开与蓝牙低功耗设备的连接
|
|
4989
|
+
* @param params - 输入参数
|
|
4990
|
+
*/
|
|
4991
|
+
function closeBLEConnection(params: CloseBLEConnectionReq): Promise<CloseBLEConnectionRsp>;
|
|
4992
|
+
/**
|
|
4993
|
+
* 关闭蓝牙模块
|
|
4994
|
+
*/
|
|
4995
|
+
function closeBluetoothAdapter(): Promise<CloseBluetoothAdapterRsp>;
|
|
4996
|
+
/**
|
|
4997
|
+
* 连接蓝牙低功耗设备
|
|
4998
|
+
* @param params - 输入参数
|
|
4999
|
+
*/
|
|
5000
|
+
function createBLEConnection(params: CreateBLEConnectionReq): Promise<CreateBLEConnectionRsp>;
|
|
5001
|
+
/**
|
|
5002
|
+
* 获取蓝牙低功耗设备某个服务中所有特征 (characteristic)
|
|
5003
|
+
* @param params - 输入参数
|
|
5004
|
+
*/
|
|
5005
|
+
function getBLEDeviceCharacteristics(params: GetBLEDeviceCharacteristicsReq): Promise<GetBLEDeviceCharacteristicsRsp>;
|
|
5006
|
+
/**
|
|
5007
|
+
* 获取蓝牙低功耗设备所有服务 (service)
|
|
5008
|
+
* @param params - 输入参数
|
|
5009
|
+
*/
|
|
5010
|
+
function getBLEDeviceServices(params: GetBLEDeviceServicesReq): Promise<GetBLEDeviceServicesRsp>;
|
|
5011
|
+
/**
|
|
5012
|
+
* 获取设备设置
|
|
5013
|
+
*/
|
|
5014
|
+
function getSystemSetting(): Promise<GetSystemSettingRsp>;
|
|
5015
|
+
/**
|
|
5016
|
+
* 请求获取 Wi-Fi 列表。wifiList 数据会在 onGetWifiList 注册的回调中返回
|
|
5017
|
+
*/
|
|
5018
|
+
function getWifiList(): Promise<GetWifiListRsp>;
|
|
5019
|
+
/**
|
|
5020
|
+
* 启用蓝牙低功耗设备特征值变化时的 notify 功能,订阅特征
|
|
5021
|
+
* @param params - 输入参数
|
|
5022
|
+
*/
|
|
5023
|
+
function notifyBLECharacteristicValueChange(params: NotifyBLECharacteristicValueChangeReq): Promise<NotifyBLECharacteristicValueChangeRsp>;
|
|
5024
|
+
/**
|
|
5025
|
+
* 监听蓝牙适配器状态变化事件
|
|
5026
|
+
* @param params - 输入参数
|
|
5027
|
+
*/
|
|
5028
|
+
function onBluetoothAdapterStateChange(params: OnBluetoothAdapterStateChangeReq): Promise<void>;
|
|
5029
|
+
/**
|
|
5030
|
+
* 移除蓝牙适配器状态变化事件的全部监听函数
|
|
5031
|
+
*/
|
|
5032
|
+
function offBluetoothAdapterStateChange(): Promise<void>;
|
|
5033
|
+
/**
|
|
5034
|
+
* 监听搜索到新设备的事件
|
|
5035
|
+
* @param params - 输入参数
|
|
5036
|
+
*/
|
|
5037
|
+
function onBluetoothDeviceFound(params: OnBluetoothDeviceFoundReq): Promise<void>;
|
|
4393
5038
|
/**
|
|
4394
|
-
*
|
|
5039
|
+
* 监听获取到 Wi-Fi 列表数据事件
|
|
5040
|
+
* @param params - 输入参数
|
|
4395
5041
|
*/
|
|
4396
|
-
function
|
|
5042
|
+
function onGetWifiList(params: OnGetWifiListReq): Promise<void>;
|
|
4397
5043
|
/**
|
|
4398
|
-
*
|
|
5044
|
+
* 初始化蓝牙模块
|
|
4399
5045
|
* @param params - 输入参数
|
|
4400
5046
|
*/
|
|
4401
|
-
function
|
|
5047
|
+
function openBluetoothAdapter(params: OpenBluetoothAdapterReq): Promise<OpenBluetoothAdapterRsp>;
|
|
4402
5048
|
/**
|
|
4403
|
-
*
|
|
5049
|
+
* 跳转系统蓝牙设置页
|
|
4404
5050
|
*/
|
|
4405
|
-
function
|
|
5051
|
+
function openSystemBluetoothSetting(): Promise<OpenSystemBluetoothSettingRsp>;
|
|
4406
5052
|
/**
|
|
4407
|
-
*
|
|
5053
|
+
* 读取蓝牙低功耗设备特征值的二进制数据。注意:必须设备的特征支持 read 才可以成功调用
|
|
4408
5054
|
* @param params - 输入参数
|
|
4409
5055
|
*/
|
|
4410
|
-
function
|
|
5056
|
+
function readBLECharacteristicValue(params: ReadBLECharacteristicValueReq): Promise<ReadBLECharacteristicValueRsp>;
|
|
4411
5057
|
/**
|
|
4412
|
-
*
|
|
5058
|
+
* 开始搜寻附近的蓝牙外围设备
|
|
4413
5059
|
* @param [params] - 输入参数
|
|
4414
5060
|
*/
|
|
4415
|
-
function
|
|
5061
|
+
function startBluetoothDevicesDiscovery(params?: StartBluetoothDevicesDiscoveryReq): Promise<StartBluetoothDevicesDiscoveryRsp>;
|
|
4416
5062
|
/**
|
|
4417
|
-
*
|
|
5063
|
+
* 初始化 Wi-Fi 模块
|
|
4418
5064
|
*/
|
|
4419
|
-
function
|
|
5065
|
+
function startWifi(): Promise<StartWifiRsp>;
|
|
4420
5066
|
/**
|
|
4421
|
-
*
|
|
4422
|
-
* @param [params] - 输入参数
|
|
5067
|
+
* 停止搜寻附近的蓝牙外围设备
|
|
4423
5068
|
*/
|
|
4424
|
-
function
|
|
5069
|
+
function stopBluetoothDevicesDiscovery(): Promise<StopBluetoothDevicesDiscoveryRsp>;
|
|
4425
5070
|
/**
|
|
4426
|
-
*
|
|
5071
|
+
* 关闭 Wi-Fi 模块
|
|
4427
5072
|
*/
|
|
4428
|
-
function
|
|
5073
|
+
function stopWifi(): Promise<StopWifiRsp>;
|
|
5074
|
+
/**
|
|
5075
|
+
* 向蓝牙低功耗设备特征值中写入二进制数据。注意:必须设备的特征支持 write 才可以成功调用
|
|
5076
|
+
* @param params - 输入参数
|
|
5077
|
+
*/
|
|
5078
|
+
function writeBLECharacteristicValue(params: WriteBLECharacteristicValueReq): Promise<WriteBLECharacteristicValueRsp>;
|
|
5079
|
+
/**
|
|
5080
|
+
* 监听蓝牙低功耗设备的特征值变化事件
|
|
5081
|
+
* @param params - 输入参数
|
|
5082
|
+
*/
|
|
5083
|
+
function onBLECharacteristicValueChange(params: OnBLECharacteristicValueChangeReq): Promise<void>;
|
|
5084
|
+
/**
|
|
5085
|
+
* 监听蓝牙低功耗连接状态改变事件
|
|
5086
|
+
* @param params - 输入参数
|
|
5087
|
+
*/
|
|
5088
|
+
function onBLEConnectionStateChange(params: OnBLEConnectionStateChangeReq): Promise<void>;
|
|
4429
5089
|
}
|
|
4430
5090
|
|
|
4431
5091
|
/**
|
|
@@ -4815,6 +5475,466 @@ type SystemInfo = {
|
|
|
4815
5475
|
host: HostInfo;
|
|
4816
5476
|
};
|
|
4817
5477
|
|
|
5478
|
+
/**
|
|
5479
|
+
* 断开蓝牙低功耗设备连接参数
|
|
5480
|
+
* @property deviceId - 蓝牙设备 id
|
|
5481
|
+
*/
|
|
5482
|
+
type CloseBLEConnectionReq = {
|
|
5483
|
+
deviceId: string;
|
|
5484
|
+
};
|
|
5485
|
+
|
|
5486
|
+
/**
|
|
5487
|
+
* 断开蓝牙低功耗设备连接结果
|
|
5488
|
+
* @property errMsg - 错误信息,如果调用成功返回 closeBLEConnection:ok
|
|
5489
|
+
* @property errCode - 错误码,成功时为 0
|
|
5490
|
+
*/
|
|
5491
|
+
type CloseBLEConnectionRsp = {
|
|
5492
|
+
errMsg: string;
|
|
5493
|
+
errCode: number;
|
|
5494
|
+
};
|
|
5495
|
+
|
|
5496
|
+
/**
|
|
5497
|
+
* 关闭蓝牙模块结果
|
|
5498
|
+
* @property errMsg - 错误信息,如果调用成功返回 closeBluetoothAdapter:ok
|
|
5499
|
+
* @property errCode - 错误码,成功时为 0
|
|
5500
|
+
*/
|
|
5501
|
+
type CloseBluetoothAdapterRsp = {
|
|
5502
|
+
errMsg: string;
|
|
5503
|
+
errCode: number;
|
|
5504
|
+
};
|
|
5505
|
+
|
|
5506
|
+
/**
|
|
5507
|
+
* 连接蓝牙低功耗设备参数
|
|
5508
|
+
* @property deviceId - 蓝牙设备 id
|
|
5509
|
+
* @property [timeout] - 超时时间,单位 ms,不传表示不会超时
|
|
5510
|
+
*/
|
|
5511
|
+
type CreateBLEConnectionReq = {
|
|
5512
|
+
deviceId: string;
|
|
5513
|
+
timeout?: number;
|
|
5514
|
+
};
|
|
5515
|
+
|
|
5516
|
+
/**
|
|
5517
|
+
* 连接蓝牙低功耗设备结果
|
|
5518
|
+
* @property errMsg - 错误信息,如果调用成功返回 createBLEConnection:ok
|
|
5519
|
+
* @property errCode - 错误码,成功时为 0
|
|
5520
|
+
* @property errno - 错误码,成功时为 0
|
|
5521
|
+
*/
|
|
5522
|
+
type CreateBLEConnectionRsp = {
|
|
5523
|
+
errMsg: string;
|
|
5524
|
+
errCode: number;
|
|
5525
|
+
errno: number;
|
|
5526
|
+
};
|
|
5527
|
+
|
|
5528
|
+
/**
|
|
5529
|
+
* 获取蓝牙低功耗设备特征参数
|
|
5530
|
+
* @property deviceId - 蓝牙设备 id
|
|
5531
|
+
* @property serviceId - 蓝牙服务 UUID,需要使用 getBLEDeviceServices 获取
|
|
5532
|
+
*/
|
|
5533
|
+
type GetBLEDeviceCharacteristicsReq = {
|
|
5534
|
+
deviceId: string;
|
|
5535
|
+
serviceId: string;
|
|
5536
|
+
};
|
|
5537
|
+
|
|
5538
|
+
/**
|
|
5539
|
+
* 蓝牙设备特征支持的操作类型
|
|
5540
|
+
* @property read - 该特征是否支持 read 操作
|
|
5541
|
+
* @property write - 该特征是否支持 write 操作
|
|
5542
|
+
* @property notify - 该特征是否支持 notify 操作
|
|
5543
|
+
* @property indicate - 该特征是否支持 indicate 操作
|
|
5544
|
+
* @property writeNoResponse - 该特征是否支持无回应写操作
|
|
5545
|
+
* @property writeDefault - 该特征是否支持有回应写操作
|
|
5546
|
+
*/
|
|
5547
|
+
type BLECharacteristicProperties = {
|
|
5548
|
+
read: boolean;
|
|
5549
|
+
write: boolean;
|
|
5550
|
+
notify: boolean;
|
|
5551
|
+
indicate: boolean;
|
|
5552
|
+
writeNoResponse: boolean;
|
|
5553
|
+
writeDefault: boolean;
|
|
5554
|
+
};
|
|
5555
|
+
|
|
5556
|
+
/**
|
|
5557
|
+
* 蓝牙设备特征
|
|
5558
|
+
* @property uuid - 蓝牙设备特征的 UUID
|
|
5559
|
+
* @property properties - 该特征支持的操作类型
|
|
5560
|
+
*/
|
|
5561
|
+
type BLECharacteristic = {
|
|
5562
|
+
uuid: string;
|
|
5563
|
+
properties: BLECharacteristicProperties;
|
|
5564
|
+
};
|
|
5565
|
+
|
|
5566
|
+
/**
|
|
5567
|
+
* 获取蓝牙低功耗设备特征结果
|
|
5568
|
+
* @property errMsg - 错误信息,如果调用成功返回 getBLEDeviceCharacteristics:ok
|
|
5569
|
+
* @property errCode - 错误码,成功时为 0
|
|
5570
|
+
* @property characteristics - 设备特征列表
|
|
5571
|
+
*/
|
|
5572
|
+
type GetBLEDeviceCharacteristicsRsp = {
|
|
5573
|
+
errMsg: string;
|
|
5574
|
+
errCode: number;
|
|
5575
|
+
characteristics: BLECharacteristic[];
|
|
5576
|
+
};
|
|
5577
|
+
|
|
5578
|
+
/**
|
|
5579
|
+
* 获取蓝牙低功耗设备服务参数
|
|
5580
|
+
* @property deviceId - 蓝牙设备 id
|
|
5581
|
+
*/
|
|
5582
|
+
type GetBLEDeviceServicesReq = {
|
|
5583
|
+
deviceId: string;
|
|
5584
|
+
};
|
|
5585
|
+
|
|
5586
|
+
/**
|
|
5587
|
+
* 蓝牙设备服务
|
|
5588
|
+
* @property uuid - 蓝牙设备服务的 UUID
|
|
5589
|
+
* @property isPrimary - 该服务是否为主服务
|
|
5590
|
+
*/
|
|
5591
|
+
type BLEService = {
|
|
5592
|
+
uuid: string;
|
|
5593
|
+
isPrimary: boolean;
|
|
5594
|
+
};
|
|
5595
|
+
|
|
5596
|
+
/**
|
|
5597
|
+
* 获取蓝牙低功耗设备服务结果
|
|
5598
|
+
* @property errMsg - 错误信息,如果调用成功返回 getBLEDeviceServices:ok
|
|
5599
|
+
* @property errCode - 错误码,成功时为 0
|
|
5600
|
+
* @property services - 设备服务列表
|
|
5601
|
+
*/
|
|
5602
|
+
type GetBLEDeviceServicesRsp = {
|
|
5603
|
+
errMsg: string;
|
|
5604
|
+
errCode: number;
|
|
5605
|
+
services: BLEService[];
|
|
5606
|
+
};
|
|
5607
|
+
|
|
5608
|
+
/**
|
|
5609
|
+
* 获取设备设置结果
|
|
5610
|
+
* @property bluetoothEnabled - 蓝牙的系统开关
|
|
5611
|
+
* @property locationEnabled - 地理位置的系统开关
|
|
5612
|
+
* @property wifiEnabled - Wi-Fi 的系统开关
|
|
5613
|
+
* @property deviceOrientation - 设备方向,竖屏 portrait、横屏 landscape
|
|
5614
|
+
* @property errMsg - 错误信息,如果调用成功返回 getSystemSetting:ok
|
|
5615
|
+
* @property errCode - 错误码,成功时为 0
|
|
5616
|
+
*/
|
|
5617
|
+
type GetSystemSettingRsp = {
|
|
5618
|
+
bluetoothEnabled: boolean;
|
|
5619
|
+
locationEnabled: boolean;
|
|
5620
|
+
wifiEnabled: boolean;
|
|
5621
|
+
deviceOrientation: string;
|
|
5622
|
+
errMsg: string;
|
|
5623
|
+
errCode: number;
|
|
5624
|
+
};
|
|
5625
|
+
|
|
5626
|
+
/**
|
|
5627
|
+
* 请求获取 Wi-Fi 列表结果
|
|
5628
|
+
* @property errMsg - 错误信息,如果调用成功返回 getWifiList:ok
|
|
5629
|
+
* @property errCode - 错误码,成功时为 0
|
|
5630
|
+
*/
|
|
5631
|
+
type GetWifiListRsp = {
|
|
5632
|
+
errMsg: string;
|
|
5633
|
+
errCode: number;
|
|
5634
|
+
};
|
|
5635
|
+
|
|
5636
|
+
/**
|
|
5637
|
+
* 启用蓝牙低功耗设备特征值变化时的 notify 功能参数
|
|
5638
|
+
* @property deviceId - 蓝牙设备 id
|
|
5639
|
+
* @property serviceId - 蓝牙特征对应服务的 UUID
|
|
5640
|
+
* @property characteristicId - 蓝牙特征的 UUID
|
|
5641
|
+
* @property state - 是否启用 notify,true 为启用,false 为取消
|
|
5642
|
+
* @property [type] - 设置特征订阅类型,有效值有 `notification` 和 `indication`
|
|
5643
|
+
*/
|
|
5644
|
+
type NotifyBLECharacteristicValueChangeReq = {
|
|
5645
|
+
deviceId: string;
|
|
5646
|
+
serviceId: string;
|
|
5647
|
+
characteristicId: string;
|
|
5648
|
+
state: boolean;
|
|
5649
|
+
type?: string;
|
|
5650
|
+
};
|
|
5651
|
+
|
|
5652
|
+
/**
|
|
5653
|
+
* 启用蓝牙低功耗设备特征值变化时的 notify 功能结果
|
|
5654
|
+
* @property errMsg - 错误信息,如果调用成功返回 notifyBLECharacteristicValueChange:ok
|
|
5655
|
+
* @property errCode - 错误码,成功时为 0
|
|
5656
|
+
*/
|
|
5657
|
+
type NotifyBLECharacteristicValueChangeRsp = {
|
|
5658
|
+
errMsg: string;
|
|
5659
|
+
errCode: number;
|
|
5660
|
+
};
|
|
5661
|
+
|
|
5662
|
+
/**
|
|
5663
|
+
* @property available - 蓝牙适配器是否可用
|
|
5664
|
+
* @property discovering - 蓝牙适配器是否处于搜索状态
|
|
5665
|
+
*/
|
|
5666
|
+
type OnBluetoothAdapterStateChangeNotice = {
|
|
5667
|
+
available: boolean;
|
|
5668
|
+
discovering: boolean;
|
|
5669
|
+
};
|
|
5670
|
+
|
|
5671
|
+
/**
|
|
5672
|
+
* @param res - 蓝牙适配器状态变化事件的回调参数
|
|
5673
|
+
*/
|
|
5674
|
+
type OnBluetoothAdapterStateChangeCallback = (res: OnBluetoothAdapterStateChangeNotice) => void;
|
|
5675
|
+
|
|
5676
|
+
/**
|
|
5677
|
+
* @property callback - 蓝牙适配器状态变化事件的回调函数
|
|
5678
|
+
*/
|
|
5679
|
+
type OnBluetoothAdapterStateChangeReq = {
|
|
5680
|
+
callback: OnBluetoothAdapterStateChangeCallback;
|
|
5681
|
+
};
|
|
5682
|
+
|
|
5683
|
+
/**
|
|
5684
|
+
* @property name - 蓝牙设备名称,某些设备可能没有
|
|
5685
|
+
* @property deviceId - 蓝牙设备 id
|
|
5686
|
+
* @property RSSI - 当前蓝牙设备的信号强度,单位 dBm
|
|
5687
|
+
* @property advertisData - 当前蓝牙设备的广播数据段中的 ManufacturerData 数据段
|
|
5688
|
+
* @property advertisServiceUUIDs - 当前蓝牙设备的广播数据段中的 ServiceUUIDs 数据段
|
|
5689
|
+
* @property localName - 当前蓝牙设备的广播数据段中的 LocalName 数据段
|
|
5690
|
+
* @property serviceData - 当前蓝牙设备的广播数据段中的 ServiceData 数据段
|
|
5691
|
+
* @property connectable - 当前蓝牙设备是否可连接(仅 iOS 支持)
|
|
5692
|
+
*/
|
|
5693
|
+
type BluetoothDeviceInfo = {
|
|
5694
|
+
name: string;
|
|
5695
|
+
deviceId: string;
|
|
5696
|
+
RSSI: number;
|
|
5697
|
+
advertisData: ArrayBuffer;
|
|
5698
|
+
advertisServiceUUIDs: string[];
|
|
5699
|
+
localName: string;
|
|
5700
|
+
serviceData: any;
|
|
5701
|
+
connectable: boolean;
|
|
5702
|
+
};
|
|
5703
|
+
|
|
5704
|
+
/**
|
|
5705
|
+
* @property devices - 新搜索到的设备列表
|
|
5706
|
+
*/
|
|
5707
|
+
type OnBluetoothDeviceFoundNotice = {
|
|
5708
|
+
devices: BluetoothDeviceInfo[];
|
|
5709
|
+
};
|
|
5710
|
+
|
|
5711
|
+
/**
|
|
5712
|
+
* @param res - 搜索到新设备事件的回调参数
|
|
5713
|
+
*/
|
|
5714
|
+
type OnBluetoothDeviceFoundCallback = (res: OnBluetoothDeviceFoundNotice) => void;
|
|
5715
|
+
|
|
5716
|
+
/**
|
|
5717
|
+
* @property callback - 搜索到新设备事件的回调函数
|
|
5718
|
+
*/
|
|
5719
|
+
type OnBluetoothDeviceFoundReq = {
|
|
5720
|
+
callback: OnBluetoothDeviceFoundCallback;
|
|
5721
|
+
};
|
|
5722
|
+
|
|
5723
|
+
/**
|
|
5724
|
+
* @property SSID - Wi-Fi 的 SSID
|
|
5725
|
+
* @property BSSID - Wi-Fi 的 BSSID
|
|
5726
|
+
* @property secure - Wi-Fi 是否安全
|
|
5727
|
+
* @property signalStrength - Wi-Fi 信号强度,安卓取值 0 ~ 100 ,iOS 取值 0 ~ 1
|
|
5728
|
+
* @property frequency - Wi-Fi 频段单位 MHz
|
|
5729
|
+
*/
|
|
5730
|
+
type WifiInfo = {
|
|
5731
|
+
SSID: string;
|
|
5732
|
+
BSSID: string;
|
|
5733
|
+
secure: boolean;
|
|
5734
|
+
signalStrength: number;
|
|
5735
|
+
frequency: number;
|
|
5736
|
+
};
|
|
5737
|
+
|
|
5738
|
+
/**
|
|
5739
|
+
* @property wifiList - Wi-Fi 列表数据
|
|
5740
|
+
*/
|
|
5741
|
+
type OnGetWifiListNotice = {
|
|
5742
|
+
wifiList: WifiInfo[];
|
|
5743
|
+
};
|
|
5744
|
+
|
|
5745
|
+
/**
|
|
5746
|
+
* @param notice - 监听获取到 Wi-Fi 列表数据事件的回调参数
|
|
5747
|
+
*/
|
|
5748
|
+
type OnGetWifiListCallback = (notice: OnGetWifiListNotice) => void;
|
|
5749
|
+
|
|
5750
|
+
/**
|
|
5751
|
+
* @property callback - 监听获取到 Wi-Fi 列表数据事件的回调函数
|
|
5752
|
+
*/
|
|
5753
|
+
type OnGetWifiListReq = {
|
|
5754
|
+
callback: OnGetWifiListCallback;
|
|
5755
|
+
};
|
|
5756
|
+
|
|
5757
|
+
/**
|
|
5758
|
+
* @property mode - 蓝牙模式,可作为主/从设备,仅 iOS 需要
|
|
5759
|
+
*/
|
|
5760
|
+
type OpenBluetoothAdapterReq = {
|
|
5761
|
+
mode: string;
|
|
5762
|
+
};
|
|
5763
|
+
|
|
5764
|
+
/**
|
|
5765
|
+
* @property errMsg - 错误信息,如果调用成功返回 ${apiName}:ok
|
|
5766
|
+
* @property errCode - 错误码,成功时为 0,失败时参考错误码说明
|
|
5767
|
+
* @property state - 失败时返回的参数,仅iOS支持,参考state说明
|
|
5768
|
+
* @property errno - 错误码,成功时为 0,失败时参考错误码说明
|
|
5769
|
+
*/
|
|
5770
|
+
type OpenBluetoothAdapterRsp = {
|
|
5771
|
+
errMsg: string;
|
|
5772
|
+
errCode: number;
|
|
5773
|
+
state: number;
|
|
5774
|
+
errno: number;
|
|
5775
|
+
};
|
|
5776
|
+
|
|
5777
|
+
/**
|
|
5778
|
+
* @property errMsg - 错误信息,如果调用成功返回 ${apiName}:ok
|
|
5779
|
+
* @property errCode - 错误码,成功时为 0,失败时参考错误码说明
|
|
5780
|
+
*/
|
|
5781
|
+
type OpenSystemBluetoothSettingRsp = {
|
|
5782
|
+
errMsg: string;
|
|
5783
|
+
errCode: number;
|
|
5784
|
+
};
|
|
5785
|
+
|
|
5786
|
+
/**
|
|
5787
|
+
* 读取蓝牙低功耗设备特征值参数
|
|
5788
|
+
* @property deviceId - 蓝牙设备 id
|
|
5789
|
+
* @property serviceId - 蓝牙特征对应服务的 UUID
|
|
5790
|
+
* @property characteristicId - 蓝牙特征的 UUID
|
|
5791
|
+
*/
|
|
5792
|
+
type ReadBLECharacteristicValueReq = {
|
|
5793
|
+
deviceId: string;
|
|
5794
|
+
serviceId: string;
|
|
5795
|
+
characteristicId: string;
|
|
5796
|
+
};
|
|
5797
|
+
|
|
5798
|
+
/**
|
|
5799
|
+
* 读取蓝牙低功耗设备特征值结果
|
|
5800
|
+
* @property errMsg - 错误信息,如果调用成功返回 readBLECharacteristicValue:ok
|
|
5801
|
+
* @property errCode - 错误码,成功时为 0
|
|
5802
|
+
*/
|
|
5803
|
+
type ReadBLECharacteristicValueRsp = {
|
|
5804
|
+
errMsg: string;
|
|
5805
|
+
errCode: number;
|
|
5806
|
+
};
|
|
5807
|
+
|
|
5808
|
+
/**
|
|
5809
|
+
* 开始搜寻附近的蓝牙外围设备参数
|
|
5810
|
+
* @property [services] - 要搜索的蓝牙设备主服务的 UUID 列表(iOS 平台必填)
|
|
5811
|
+
* @property [allowDuplicatesKey] - 是否允许重复上报同一设备
|
|
5812
|
+
* @property [interval] - 上报设备的间隔,单位 ms。0 表示找到新设备立即上报
|
|
5813
|
+
* @property [powerLevel] - 扫描模式,可选值:"low"、"balanced"、"high"
|
|
5814
|
+
*/
|
|
5815
|
+
type StartBluetoothDevicesDiscoveryReq = {
|
|
5816
|
+
services?: string[];
|
|
5817
|
+
allowDuplicatesKey?: boolean;
|
|
5818
|
+
interval?: number;
|
|
5819
|
+
powerLevel?: string;
|
|
5820
|
+
};
|
|
5821
|
+
|
|
5822
|
+
/**
|
|
5823
|
+
* 开始搜寻附近的蓝牙外围设备结果
|
|
5824
|
+
* @property errMsg - 错误信息,如果调用成功返回 startBluetoothDevicesDiscovery:ok
|
|
5825
|
+
* @property errCode - 错误码,成功时为 0
|
|
5826
|
+
* @property errno - 错误码,成功时为 0
|
|
5827
|
+
*/
|
|
5828
|
+
type StartBluetoothDevicesDiscoveryRsp = {
|
|
5829
|
+
errMsg: string;
|
|
5830
|
+
errCode: number;
|
|
5831
|
+
errno: number;
|
|
5832
|
+
};
|
|
5833
|
+
|
|
5834
|
+
/**
|
|
5835
|
+
* 初始化 Wi-Fi 模块结果
|
|
5836
|
+
* @property errMsg - 错误信息,如果调用成功返回 startWifi:ok
|
|
5837
|
+
* @property errCode - 错误码,成功时为 0
|
|
5838
|
+
*/
|
|
5839
|
+
type StartWifiRsp = {
|
|
5840
|
+
errMsg: string;
|
|
5841
|
+
errCode: number;
|
|
5842
|
+
};
|
|
5843
|
+
|
|
5844
|
+
/**
|
|
5845
|
+
* 停止搜寻附近的蓝牙外围设备结果
|
|
5846
|
+
* @property errMsg - 错误信息,如果调用成功返回 stopBluetoothDevicesDiscovery:ok
|
|
5847
|
+
* @property errCode - 错误码,成功时为 0
|
|
5848
|
+
*/
|
|
5849
|
+
type StopBluetoothDevicesDiscoveryRsp = {
|
|
5850
|
+
errMsg: string;
|
|
5851
|
+
errCode: number;
|
|
5852
|
+
};
|
|
5853
|
+
|
|
5854
|
+
/**
|
|
5855
|
+
* 关闭 Wi-Fi 模块结果
|
|
5856
|
+
* @property errMsg - 错误信息,如果调用成功返回 stopWifi:ok
|
|
5857
|
+
* @property errCode - 错误码,成功时为 0
|
|
5858
|
+
*/
|
|
5859
|
+
type StopWifiRsp = {
|
|
5860
|
+
errMsg: string;
|
|
5861
|
+
errCode: number;
|
|
5862
|
+
};
|
|
5863
|
+
|
|
5864
|
+
/**
|
|
5865
|
+
* 向蓝牙低功耗设备特征值中写入二进制数据参数
|
|
5866
|
+
* @property deviceId - 蓝牙设备 id
|
|
5867
|
+
* @property serviceId - 蓝牙特征对应服务的 UUID
|
|
5868
|
+
* @property characteristicId - 蓝牙特征的 UUID
|
|
5869
|
+
* @property value - 蓝牙设备特征对应的二进制值
|
|
5870
|
+
* @property [writeType] - 蓝牙特征值的写模式设置,有效值有 write(需要从机确认)和 writeNoResponse(不需要从机确认)
|
|
5871
|
+
*/
|
|
5872
|
+
type WriteBLECharacteristicValueReq = {
|
|
5873
|
+
deviceId: string;
|
|
5874
|
+
serviceId: string;
|
|
5875
|
+
characteristicId: string;
|
|
5876
|
+
value: ArrayBuffer;
|
|
5877
|
+
writeType?: string;
|
|
5878
|
+
};
|
|
5879
|
+
|
|
5880
|
+
/**
|
|
5881
|
+
* 向蓝牙低功耗设备特征值中写入二进制数据结果
|
|
5882
|
+
* @property errMsg - 错误信息,如果调用成功返回 writeBLECharacteristicValue:ok
|
|
5883
|
+
* @property errCode - 错误码,成功时为 0
|
|
5884
|
+
*/
|
|
5885
|
+
type WriteBLECharacteristicValueRsp = {
|
|
5886
|
+
errMsg: string;
|
|
5887
|
+
errCode: number;
|
|
5888
|
+
};
|
|
5889
|
+
|
|
5890
|
+
/**
|
|
5891
|
+
* 蓝牙低功耗设备的特征值变化事件通知
|
|
5892
|
+
* @property deviceId - 蓝牙设备 id
|
|
5893
|
+
* @property serviceId - 蓝牙特征对应服务的 UUID
|
|
5894
|
+
* @property characteristicId - 蓝牙特征的 UUID
|
|
5895
|
+
* @property value - 特征值最新的值
|
|
5896
|
+
*/
|
|
5897
|
+
type OnBLECharacteristicValueChangeNotice = {
|
|
5898
|
+
deviceId: string;
|
|
5899
|
+
serviceId: string;
|
|
5900
|
+
characteristicId: string;
|
|
5901
|
+
value: ArrayBuffer;
|
|
5902
|
+
};
|
|
5903
|
+
|
|
5904
|
+
/**
|
|
5905
|
+
* @param res - 蓝牙低功耗设备的特征值变化事件通知
|
|
5906
|
+
*/
|
|
5907
|
+
type OnBLECharacteristicValueChangeCallback = (res: OnBLECharacteristicValueChangeNotice) => void;
|
|
5908
|
+
|
|
5909
|
+
/**
|
|
5910
|
+
* 监听蓝牙低功耗设备的特征值变化事件参数
|
|
5911
|
+
* @property callback - 蓝牙低功耗设备的特征值变化事件的回调函数
|
|
5912
|
+
*/
|
|
5913
|
+
type OnBLECharacteristicValueChangeReq = {
|
|
5914
|
+
callback: OnBLECharacteristicValueChangeCallback;
|
|
5915
|
+
};
|
|
5916
|
+
|
|
5917
|
+
/**
|
|
5918
|
+
* @property deviceId - 蓝牙设备 id
|
|
5919
|
+
* @property connected - 是否处于已连接状态
|
|
5920
|
+
*/
|
|
5921
|
+
type OnBLEConnectionStateChangeNotice = {
|
|
5922
|
+
deviceId: string;
|
|
5923
|
+
connected: boolean;
|
|
5924
|
+
};
|
|
5925
|
+
|
|
5926
|
+
/**
|
|
5927
|
+
* @param res - 蓝牙低功耗连接状态改变事件的回调参数
|
|
5928
|
+
*/
|
|
5929
|
+
type OnBLEConnectionStateChangeCallback = (res: OnBLEConnectionStateChangeNotice) => void;
|
|
5930
|
+
|
|
5931
|
+
/**
|
|
5932
|
+
* @property callback - 蓝牙低功耗连接状态改变事件的回调函数
|
|
5933
|
+
*/
|
|
5934
|
+
type OnBLEConnectionStateChangeReq = {
|
|
5935
|
+
callback: OnBLEConnectionStateChangeCallback;
|
|
5936
|
+
};
|
|
5937
|
+
|
|
4818
5938
|
/**
|
|
4819
5939
|
* 逐步废弃
|
|
4820
5940
|
*/
|