forked from theajack/wxOpenDataContext
-
Notifications
You must be signed in to change notification settings - Fork 0
/
wxmini.d.ts
2087 lines (1882 loc) · 75 KB
/
wxmini.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* 取消一个先前通过调用 requestAnimationFrame 方法添加到计划中的动画帧请求
*/
declare function cancelAnimationFrame(requestID: number): void;
/**
* 在下次进行重绘时执行。
*/
declare function requestAnimationFrame(callback: () => void): number;
/** 输出日志*/
interface Console {
debug(message?: any, ...optionalParams: any[]): void;
error(message?: any, ...optionalParams: any[]): void;
group(groupTitle?: string, ...optionalParams: any[]): void;
groupEnd(): void;
info(message?: any, ...optionalParams: any[]): void;
log(message?: any, ...optionalParams: any[]): void;
warn(message?: any, ...optionalParams: any[]): void;
}
/** 输出日志*/
declare var Console: {
prototype: Console;
new(): Console;
};
declare var console: Console;
/**
* 可取消由 setTimeout() 方法设置的定时器。
*/
declare function clearTimeout(timeoutID: number): void;
/**
* 可取消由 setInterval() 方法设置的定时器。
*/
declare function clearInterval(intervalID: number): void;
/**
* 设定一个定时器,在定时到期以后执行注册的回调函数
* @param callback 回调函数
* @param delay 延迟的时间,函数的调用会在该延迟之后发生,单位 ms。
* @param rest param1, param2, ..., paramN 等附加参数,它们会作为参数传递给回调函数。
* @returns number定时器的编号。这个值可以传递给 clearTimeout 来取消该定时。
*/
declare function setTimeout(callback: () => void, delay: number, ...rest): number;
/**
* 设定一个定时器,按照指定的周期(以毫秒计)来执行注册的回调函数
* @param callback 回调函数
* @param delay 执行回调函数之间的时间间隔,单位 ms。
* @param rest param1, param2, ..., paramN 等附加参数,它们会作为参数传递给回调函数。
* @returns number定时器的编号。这个值可以传递给 clearTimeout 来取消该定时。
*/
declare function setInterval(callback: () => void, delay: number, ...rest): number;
/**
* 微信小游戏命名空间
*/
declare namespace wx {
type systemInfo = {
/** 手机品牌*/
brand: string;
/** 手机型号*/
model: string;
/** 设备像素比 */
pixelRatio: number;
/** 屏幕宽度*/
screenWidth: number;
/** 屏幕高度*/
screenHeight: number;
/** 可使用窗口宽度*/
windowWidth: number;
/** 可使用窗口高度*/
windowHeight: number;
/** 状态栏的高度*/
statusBarHeight: number;
/** 微信设置的语言*/
language: string;
/** 微信版本号*/
version: string;
/** 操作系统版本*/
system: string;
/** 客户端平台*/
platform: string
/** 用户字体大小设置。以“我-设置 - 通用 - 字体大小”中的设置为准,单位 px。*/
fontSizeSetting: number;
/** 客户端基础库版本*/
SDKVersion: string;
/** 性能等级*/
benchmarkLevel: number;
}
type launchOption = {
/** 启动小游戏的场景值*/
scene: number;
/** 启动小游戏的 query 参数 */
query: Object;
/** 当前小游戏是否被显示在聊天顶部*/
referrerInfo: ReferrerInfo
/** shareTicket,详见获取更多转发信息*/
shareTicket: string;
}
type ReferrerInfo = {
/** 来源小程序或公众号或App的 appId */
appId: string,
/** 来源小程序传过来的数据,scene=1037或1038时支持*/
extraData: any
}
/**
* UpdateManager 对象,用来管理更新,可通过 wx.getUpdateManager 接口获取实例。
*/
type UpdateManager = {
/**
* 强制小程序重启并使用新版本。在小程序新版本下载完成后(即收到 onUpdateReady 回调)调用。
*/
applyUpdate(): void;
/**
* 监听向微信后台请求检查更新结果事件。微信在小程序冷启动时自动检查更新,不需由开发者主动触发。
* @param callback 向微信后台请求检查更新结果事件的回调函数
*/
onCheckForUpdate(callback: (res: { hasUpdate: boolean }) => void): void;
/**
* 监听小程序有版本更新事件。客户端主动触发下载(无需开发者触发),下载成功后回调
* @param callback 小程序有版本更新事件的回调函数
*/
onUpdateReady(callback: () => void): void;
/**
* 监听小程序更新失败事件。小程序有新版本,客户端主动触发下载(无需开发者触发),下载失败(可能是网络原因等)后回调
* @param callback 小程序更新失败事件的回调函数
*/
onUpdateFailed(callback: () => void): void;
}
/**
* 在触控设备上的触摸点。通常是指手指或者触控笔在触屏设备或者触摸板上的操作。
*/
type Touch = {
/** Touch 对象的唯一标识符,只读属性。一次触摸动作(我们值的是手指的触摸)在平面上移动的整个过程中, 该标识符不变。可以根据它来判断跟踪的是否是同一次触摸过程。*/
identifier: number
/** 触点相对于屏幕左边沿的 X 坐标。*/
screenX: number
/** 触点相对于屏幕上边沿的 Y 坐标。*/
screenY: number
}
/**
* 性能管理器
*/
type Performance = {
/**
* 可以获取当前时间以微秒为单位的时间戳
*/
now(): number;
}
/**
* 加载分包任务实例,用于获取分包加载状态
*/
type LoadSubpackageTask = {
/**
* 监听分包加载进度变化事件
* @param callback 分包加载进度变化事件的回调函数
*/
onProgressUpdate(callback: (res: {
/** 分包下载进度百分比*/
progress: number
/** 已经下载的数据长度,单位 Bytes */
totalBytesWritten: number
/** 预期需要下载的数据总长度,单位 Bytes*/
totalBytesExpectedToWrite: number
}) => void): void
}
/**
* 通过 Canvas.getContext('2d') 接口可以获取 CanvasRenderingContext2D 对象,实现了 HTML Canvas 2D Context 定义的大部分属性、方法。
* 通过 Canvas.getContext('webgl') 接口可以获取 WebGLRenderingContext 对象,实现了 WebGL 1.0 定义的所有属性、方法、常量。
* 2d 接口支持情况
* iOS/Android 不支持的 2d 属性和接口
* globalCompositeOperation 不支持以下值: source-in source-out destination-atop lighter copy。如果使用,不会报错,但是将得到与预期不符的结果。
* isPointInPath
* WebGL 接口支持情况
* iOS/Android 不支持的 WebGL 接口
* pixelStorei 当第一个参数是 gl.UNPACK_COLORSPACE_CONVERSION_WEBGL 时
* compressedTexImage2D
* compressedTexSubImage2D
* 除此之外 Android 还不支持 WebGL 接口
* getExtension
* getSupportedExtensions
*/
interface RenderingContext { }
interface Canvas {
/** 画布的宽度*/
width: number;
/** 画布的高度*/
height: number;
/**
* 获取画布对象的绘图上下文
*/
getContext(contextType: '2d' | 'webgl', contextAttributes: { antialias?: boolean, preserveDrawingBuffer?: boolean, antialiasSamples?: 2 }): RenderingContext;
/**
* 将当前 Canvas 保存为一个临时文件,并生成相应的临时文件路径。
*/
toTempFilePath(object: { x?: number, y?: number, width?: number, height?: number, destWidth?: number, destHeight?: number, fileType?: 'jpg' | 'png', quality?: number, success?: (res?: any) => void, fail?: (err?: any) => void, complete?: (res?: any) => void }): string;
/**
* 把画布上的绘制内容以一个 data URI 的格式返回
*/
toDataURL(): string;
/**
* Canvas.toTempFilePath 的同步版本
*/
toTempFilePathSync(object: { x?: number, y?: number, width?: number, height?: number, destWidth?: number, destHeight?: number, fileType?: 'jpg' | 'png', quality?: number }): void;
}
/**
* 获取系统信息
*/
function getSystemInfo(object: { success: (res?: systemInfo) => void, fail: (err?: any) => void, complete: (res?: any) => void }): void;
/**
* wx.getSystemInfo 的同步版本
*/
function getSystemInfoSync(): systemInfo;
/**
* 返回值 UpdateManager
*/
function getUpdateManager(): UpdateManager;
/**
* 退出当前小游戏
*/
function exitMiniProgram(object: { success?: () => void, fail?: () => void, complete?: () => void }): void;
/**
* 返回小程序启动参数
*/
function getLaunchOptionsSync(): launchOption;
/**
* 监听小游戏隐藏到后台事件。锁屏、按 HOME 键退到桌面、显示在聊天顶部等操作会触发此事件。
*/
function onHide(callback: () => void): void;
/**
* 取消监听小游戏隐藏到后台事件。锁屏、按 HOME 键退到桌面、显示在聊天顶部等操作会触发此事件。
*/
function offHide(callback: () => void): void;
/**
* 监听小游戏回到前台的事件
*/
function onShow(callback: (res: {
/** 场景值*/
scene: string,
/** 查询参数*/
query: any,
/** shareTicket*/
shareTicket: string,
/** 当场景为由从另一个小程序或公众号或App打开时,返回此字段*/
referrerInfo: ReferrerInfo
}) => void): void;
/**
* 取消监听小游戏回到前台的事件
*/
function offShow(callback: () => void): void;
/**
* 监听音频中断结束,在收到 onAudioInterruptionBegin 事件之后,小程序内所有音频会暂停,收到此事件之后才可再次播放成功
*/
function onAudioInterruptionEnd(callback: () => void): void;
/**
* 取消监听音频中断结束,在收到 onAudioInterruptionBegin 事件之后,小程序内所有音频会暂停,收到此事件之后才可再次播放成功
*/
function offAudioInterruptionEnd(callback: () => void): void;
/**
* 监听音频因为受到系统占用而被中断开始,以下场景会触发此事件:闹钟、电话、FaceTime 通话、微信语音聊天、微信视频聊天。此事件触发后,小程序内所有音频会暂停。
*/
function onAudioInterruptionBegin(callback: () => void): void;
/**
* 取消监听音频因为受到系统占用而被中断开始,以下场景会触发此事件:闹钟、电话、FaceTime 通话、微信语音聊天、微信视频聊天。此事件触发后,小程序内所有音频会暂停。
*/
function offAudioInterruptionBegin(callback: () => void): void;
/**
* 监听全局错误事件
*/
function onError(callback: (res: {
/** 错误*/
message: string,
/** 错误调用堆栈*/
stack: string
}) => void): void;
/**
* 取消监听全局错误事件
*/
function offError(callback: () => void): void;
/**
* 监听开始触摸事件
*/
function onTouchStart(callback: (res: {
/** 当前所有触摸点的列表*/
touches: Array<Touch>,
/** 触发此次事件的触摸点列表*/
changedTouches: Array<Touch>,
/** 事件触发时的时间戳*/
timeStamp: number
}) => void): void;
/**
* 取消监听开始触摸事件
*/
function offTouchStart(callback: () => void): void;
/**
* 监听触点移动事件
*/
function onTouchMove(callback: (res: {
/** 当前所有触摸点的列表*/
touches: Array<Touch>,
/** 触发此次事件的触摸点列表*/
changedTouches: Array<Touch>,
/** 事件触发时的时间戳*/
timeStamp: number
}) => void): void;
/**
* 取消监听触点移动事件
*/
function offTouchMove(callback: () => void): void;
/**
* 监听触摸结束事件
*/
function onTouchEnd(callback: (res: {
/** 当前所有触摸点的列表*/
touches: Array<Touch>,
/** 触发此次事件的触摸点列表*/
changedTouches: Array<Touch>,
/** 事件触发时的时间戳*/
timeStamp: number
}) => void): void;
/**
* 取消监听触摸结束事件
*/
function offTouchEnd(callback: () => void): void;
/**
* 监听触点失效事件
*/
function onTouchCancel(callback: (res: {
/** 当前所有触摸点的列表*/
touches: Array<Touch>,
/** 触发此次事件的触摸点列表*/
changedTouches: Array<Touch>,
/** 事件触发时的时间戳*/
timeStamp: number
}) => void): void;
/**
* 取消监听触点失效事件
*/
function offTouchCancel(callback: () => void): void;
/**
* 获取性能管理器
*/
function getPerformance(): Performance;
/**
* 加快触发 JavaScrpitCore Garbage Collection(垃圾回收),GC 时机是由 JavaScrpitCore 来控制的,并不能保证调用后马上触发 GC。
*/
function triggerGC(): void;
/**
* 基础库 2.1.0 开始支持,低版本需做兼容处理。
* 触发分包加载,详见 分包加载
*/
function loadSubpackage(res: {
/** 分包的名字,可以填 name 或者 root*/
name: () => void,
/** 分包加载成功回调事件*/
success: () => void,
/** 分包加载失败回调事件*/
fail: () => void,
/** 分包加载结束回调事件(加载成功、失败都会执行)*/
complete: () => void
}): LoadSubpackageTask;
/**
* 基础库 1.4.0 开始支持,低版本需做兼容处理。
* 设置是否打开调试开关。此开关对正式版也能生效。
*/
function setEnableDebug(res: {
/** 是否打开调试*/
enableDebug: boolean,
/** 接口调用成功的回调函数*/
success?: () => void,
/** 接口调用失败的回调函数*/
fail?: () => void,
/** 接口调用结束的回调函数(调用成功、失败都会执行)*/
complete?: () => void
}): void;
/**
* 创建一个画布对象。首次调用创建的是显示在屏幕上的画布,之后调用创建的都是离屏画布。
*/
function createCanvas(): Canvas;
/**
* 可以修改渲染帧率。默认渲染帧率为 60 帧每秒。修改后,requestAnimationFrame 的回调频率会发生改变。
*/
function setPreferredFramesPerSecond(fps: number): void;
/**
* 获取一行文本的行高
* @returns number 文本的行高
*/
function getTextLineHeight(object: { fontStyle?: 'normal' | 'italic', fontWeight?: 'normal' | 'bold', fontSize?: 16, fontFamily: string, text: string, success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): number;
/**
* 加载自定义字体文件
* @returns string 如果加载字体成功,则返回字体 family 值,否则返回 null。
*/
function loadFont(path: string): string;
interface Image {
/**
* 图片的 URL
*/
src: string;
/**
* 图片的真实宽度
*/
width: number;
/**
* 图片的真实高度
*/
height: number;
/**
* 图片的加载完成
*/
onload: (res?: any) => void;
/**
* 图片加载发生错误后触发的回调函数
*/
onerror: (res?: any) => void;
}
/**
* 创建一个图片对象
*/
function createImage(): Image;
/**
* banner 广告组件。banner 广告组件是一个原生组件,层级比上屏 Canvas 高,会覆盖在上屏 Canvas 上。banner 广告组件默认是隐藏的,需要调用 BannerAd.show() 将其显示。banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的尺寸将通过 BannerAd.onResize() 事件中提供。
*/
interface BannerAd {
/**
* banner 广告组件的样式。style 上的属性的值仅为开发者设置的值,banner 广告会根据开发者设置的宽度进行等比缩放,缩放后的真实尺寸需要通过 BannerAd.onResize() 事件获得。
*/
style: {
/** banner 广告组件的左上角横坐标*/
left: number,
/** banner 广告组件的左上角纵坐标*/
top: number,
/** banner 广告组件的宽度。最小 300,最大至 屏幕宽度(屏幕宽度可以通过 wx.getSystemInfoSync() 获取)。*/
width: number,
/** banner 广告组件的高度*/
height: number,
/** banner 广告组件经过缩放后真实的宽度*/
realWidth: number,
/** banner 广告组件经过缩放后真实的高度*/
realHeight: number
};
/** 显示 banner 广告。*/
show(): Promise<any>;
/** 隐藏 banner 广告*/
hide(): void;
/** 销毁 banner 广告*/
destroy(): void;
/** 监听 banner 广告尺寸变化事件*/
onResize(callback: (res: { width: number, height: number }) => void): void;
/** 取消监听 banner 广告尺寸变化事件*/
offResize(callback: () => void): void;
/** 监听 banner 广告加载事件*/
onLoad(callback: () => void): void;
/** 取消监听 banner 广告加载事件*/
offLoad(callback: () => void): void;
/** 监听 banner 广告错误事件*/
onError(callback: (res: { errMsg: string, errCode: 1000 | 1001 | 1002 | 1003 | 1004 | 1005 | 1006 | 1007 | 1008 }) => void): void;
/** 取消监听 banner 广告错误事件*/
offError(callback: () => void): void;
}
/**
* 激励视频广告组件。激励视频广告组件是一个原生组件,并且是一个全局单例。层级比上屏 Canvas 高,会覆盖在上屏 Canvas 上。激励视频 广告组件默认是隐藏的,需要调用 RewardedVideoAd.show() 将其显示。
*/
interface RewardedVideoAd {
/** 隐藏激励视频广告*/
load(): Promise<any>;
/** 显示激励视频广告。激励视频广告将从屏幕下方推入。*/
show(): Promise<any>;
/** 销毁 banner 广告*/
destroy(): void;
/** 监听 banner 广告尺寸变化事件*/
onResize(callback: (res: { width: number, height: number }) => void): void;
/** 取消监听 banner 广告尺寸变化事件*/
offResize(callback: () => void): void;
/** 监听激励视频广告加载事件*/
onLoad(callback: () => void): void;
/** 取消监听激励视频广告加载事件*/
offLoad(callback: () => void): void;
/** 监听激励视频错误事件*/
onError(callback: (res: { errMsg: string, errCode: 1000 | 1001 | 1002 | 1003 | 1004 | 1005 | 1006 | 1007 | 1008 }) => void): void;
/** 取消监听激励视频错误事件*/
offError(callback: () => void): void;
/** 监听用户点击 关闭广告 按钮的事件*/
onClose(callback: (res: { isEnded: boolean }) => void);
/** 取消监听用户点击 关闭广告 按钮的事件*/
offClose(callback: () => void);
}
/**
* 创建激励视频广告组件。请通过 wx.getSystemInfoSync() 返回对象的 SDKVersion 判断基础库版本号 >= 2.0.4 后再使用该 API。同时,开发者工具上暂不支持调试该 API,请直接在真机上进行调试。
*/
function createRewardedVideoAd(res: { adUnitId: string }): RewardedVideoAd;
/**
* 创建 banner 广告组件。请通过 wx.getSystemInfoSync() 返回对象的 SDKVersion 判断基础库版本号 >= 2.0.4 后再使用该 API。同时,开发者工具上暂不支持调试该 API,请直接在真机上进行调试。
*/
function createBannerAd(res: {
adUnitId: string, style: {
left: number,
top: number,
width: number,
height: number
}
}): BannerAd;
/**
* 显示操作菜单
*/
function showActionSheet(object: { itemList: string[], itemColor?: string, success?: (res?: { tapIndex: number }) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/** 隐藏 loading 提示框*/
function hideLoading(object: { success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/** 显示 loading 提示框。需主动调用 wx.hideLoading 才能关闭提示框*/
function showLoading(object: { title: string, mask?: boolean, success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/** 隐藏消息提示框*/
function hideToast(object: { success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/** 显示消息提示框*/
function showToast(object: { title: string, icon?: 'success' | 'loading' | 'none', image?: string, duration?: 1500, mask?: boolean, success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* 显示模态对话框
*/
function showModal(object: {
title: string,
content: string,
showCancel?: true,
cancelText?: '取消',
cancelColor?: '#000000',
confirmText?: '确定',
confirmColor?: '#3cc51f',
success?: (res?: any) => void,
fail?: (res?: any) => void,
complete?: (res?: any) => void
}): void;
/**
* 基础库 2.1.0 开始支持,低版本需做兼容处理。更新键盘输入框内容。只有当键盘处于拉起状态时才会产生效果
*/
function updateKeyboard(res: {
value: string,
success?: (res?: any) => void,
fail?: (res?: any) => void,
complete?: (res?: any) => void
}): void;
/**
* 隐藏键盘
*/
function hideKeyboard(object: { success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* 显示键盘
*/
function showKeyboard(object: { defaultValue: string, maxLength: number, multiple: boolean, confirmHold: boolean, confirmType: 'done' | 'next' | 'search' | 'go' | 'send', success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* 监听键盘输入事件
*/
function onKeyboardInput(callback: (res: { value: string }) => void): void;
/**
* 取消监听键盘输入事件
*/
function offKeyboardInput(callback: () => void): void;
/**
* 监听用户点击键盘 Confirm 按钮时的事件
*/
function onKeyboardConfirm(callback: (res: { value: string }) => void): void;
/**
* 取消监听用户点击键盘 Confirm 按钮时的事件
*/
function offKeyboardConfirm(callback: () => void): void;
/**
* 监听监听键盘收起的事件
*/
function onKeyboardComplete(callback: (res: { value: string }) => void): void;
/**
* 取消监听监听键盘收起的事件
*/
function offKeyboardComplete(callback: () => void): void;
/** 基础库 2.1.0 开始支持,低版本需做兼容处理。获取菜单按钮(右上角胶囊按钮)的布局位置信息。坐标信息以屏幕左上角为原点。*/
function getMenuButtonBoundingClientRect(): {
width: number,
height: number,
top: number,
right: number,
bottom: number,
left: number
};
/** 动态设置通过右上角按钮拉起的菜单的样式。*/
function setMenuStyle(res: { style: 'light' | 'dark', success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/** 当在配置中设置 showStatusBarStyle 时,屏幕顶部会显示状态栏。此接口可以修改状态栏的样式。*/
function setStatusBarStyle(res: { style: 'white' | 'black', success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* 监听窗口尺寸变化事件
*/
function onWindowResize(callback: (res: { windowWidth: number, windowHeight: number }) => void): void;
/**
* 取消监听窗口尺寸变化事件
*/
function offWindowResize(callback: () => void): void;
interface RequestTask {
abort(): void;
/** 监听 HTTP Response Header 事件。会比请求完成事件更早*/
onHeadersReceived(callback: (res: { header: Object }) => void): void;
/** 取消监听 HTTP Response Header 事件*/
offHeadersReceived(callback: () => void): void;
}
/**
* 发起网络请求。
*/
function request(object: {
url: string,
data?: string | {} | ArrayBuffer,
header?: {},
method?: 'OPTIONS' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'CONNECT',
dataType?: 'json' | string,
responseType: 'text' | 'arraybuffer',
success?: (res?: {
data: string | {} | ArrayBuffer,
statusCode: number,
header: {}
}) => void,
fail?: (res?: any) => void,
complete?: (res?: any) => void
}): RequestTask;
interface DownloadTask {
abort(): void;
/** 监听下载进度变化事件*/
onProgressUpdate(callback: (res: {
progress: number,
totalBytesWritten: number,
totalBytesExpectedToWrite: number
}) => void): void;
/** 取消监听下载进度变化事件*/
offProgressUpdate(callback: () => void): void;
/** 监听 HTTP Response Header 事件。会比请求完成事件更早*/
onHeadersReceived(callback: (res: { header: Object }) => void): void;
/** 取消监听 HTTP Response Header 事件*/
offHeadersReceived(callback: () => void): void;
}
/**
* 下载文件资源到本地,客户端直接发起一个 HTTP GET 请求,返回文件的本地文件路径。
*/
function downloadFile(object: {
url: string,
header?: Object,
filePath?: string,
success?: (res?: {
tempFilePath: string,
statusCode: number
}) => void,
fail?: (res?: any) => void,
complete?: (res?: any) => void
}): DownloadTask;
interface UploadTask {
/** 中断上传任务*/
abort(): void;
/** 监听上传进度变化事件*/
onProgressUpdate(callback: (res: {
progress: number,
totalBytesSent: number,
totalBytesExpectedToSend: number
}) => void): void;
/** 取消监听上传进度变化事件*/
offProgressUpdate(callback: () => void): void;
/** 监听 HTTP Response Header 事件。会比请求完成事件更早*/
onHeadersReceived(callback: (res: { header: Object }) => void): void;
/** 取消监听 HTTP Response Header 事件*/
offHeadersReceived(callback: () => void): void;
}
/**
* 将本地资源上传到开发者服务器,客户端发起一个 HTTPS POST 请求,其中 content-type 为 multipart/form-data 。
*/
function uploadFile(object: {
url: string,
filePath: string,
name: string,
header?: Object,
formData?: Object,
success?: (res?: {
data: string,
statusCode: number
}) => void,
fail?: (res?: any) => void,
complete?: (res?: any) => void
}): UploadTask;
interface SocketTask {
/**
* 关闭 WebSocket 连接
*/
close(object: { code?: 1000, reason?: string, success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* 监听WebSocket 连接打开事件
*/
onOpen(callback: (res: { header: Object }) => void): void;
/**
* 监听WebSocket 连接关闭事件
*/
onClose(callback: () => void): void;
/**
* 监听WebSocket 错误事件
*/
onError(callback: (res: { errMsg: string }) => void): void;
/**
* 监听WebSocket 接受到服务器的消息事件
*/
onMessage(callback: (res: { data: string | ArrayBuffer }) => void): void;
/**
* 通过 WebSocket 连接发送数据
*/
send(object: { data: string | ArrayBuffer, success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
}
/**
* 监听WebSocket 错误事件
*/
function onSocketError(callback: (err?: any) => void): void;
/**
* 创建一个 WebSocket 连接。
*/
function connectSocket(object: { url: string, header?: {}, protocols: Array<string>, success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): SocketTask;
/**
* 关闭 WeSocket 连接
*/
function closeSocket(object: { code?: 1000, reason?: string, success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* 监听WebSocket 连接打开事件
*/
function onSocketOpen(callback: (res: { header: {} }) => void): void;
/**
* 监听WebSocket 连接关闭事件
*/
function onSocketClose(callback: () => void): void;
/**
* 监听WebSocket 接受到服务器的消息事件
*/
function onSocketMessage(callback: (res: { data: string | ArrayBuffer }) => void): void;
/**
* 通过 WebSocket 连接发送数据,需要先 wx.connectSocket,并在 wx.onSocketOpen 回调之后才能发送。
*/
function sendSocketMessage(object: { data: string | ArrayBuffer, success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* 更新转发属性
*
*/
function updateShareMenu(object: { withShareTicket?: boolean, isUpdatableMessage?: boolean, activityId?: string, templateInfo?: { parameterList: Array<{ name: string, value: string }> }, success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* 显示当前页面的转发按钮
*/
function showShareMenu(object: { withShareTicket?: boolean, success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* 隐藏转发按钮
*
*/
function hideShareMenu(object: { success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* 获取转发详细信息
*
*/
function getShareInfo(object: {
shareTicket: string,
timeout: number,
success?: (res: {
errMsg: string,
encryptedData: string,
iv: string
}) => void,
fail?: (res?: any) => void,
complete?: (res?: any) => void
}): void;
/**
* 主动拉起转发,进入选择通讯录界面。
*/
function shareAppMessage(object: { title?: string, imageUrl?: string, query?: string }): void;
/**
* 取消监听用户点击右上角菜单的“转发”按钮时触发的事件
*/
function offShareAppMessage(callback: () => void): void;
/**
* 监听用户点击右上角菜单的“转发”按钮时触发的事件
*/
function onShareAppMessage(callback: (res: {
title: string,
imageUrl: string,
query: string
}) => void): void;
/**
* 发起米大师支付
*/
function requestMidasPayment(object: {
mode: string,
env?: 0 | 1,
offerId: string,
currencyType: string,
platform?: string,
buyQuantity?: number,
zoneId?: string,
success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void
}): void;
/**
* wx.getStorageInfo 的同步版本
*/
function getStorageInfoSync(): { keys: Array<string>, currentSize: number, limitSize: number };
/**
* 异步获取当前storage的相关信息
*/
function getStorageInfo(object: { success?: (res: { keys: Array<string>, currentSize: number, limitSize: number }) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* wx.clearStorage 的同步版本
*/
function clearStorageSync(): void;
/**
* 清理本地数据缓存
*/
function clearStorage(object: { success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* wx.removeStorage 的同步版本
*/
function removeStorageSync(key: string): void;
/**
* 从本地缓存中移除指定 key
*/
function removeStorage(object: { key: string, success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* wx.setStorage 的同步版本
*/
function setStorageSync(key: string, data: any): void;
/**
* 将数据存储在本地缓存中指定的 key 中,会覆盖掉原来该 key 对应的内容。
*/
function setStorage(object: { key: string, data: any, success?: (res?: any) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* wx.getStorage 的同步版本
*/
function getStorageSync(key: string): any;
/**
* 从本地缓存中异步获取指定 key 的内容
*/
function getStorage(object: { key: string, success?: (res: { data: any }) => void, fail?: (res?: any) => void, complete?: (res?: any) => void }): void;
/**
* 设置 InnerAudioContext 的播放选项。设置之后对当前小程序全局生效。
*/
function setInnerAudioOption(mixWithOther: true, obeyMuteSwitch: true, success?: (res: { data: any }) => void, fail?: (res?: any) => void, complete?: (res?: any) => void): void;
/**
* 获取当前支持的音频输入源
*/
function getAvailableAudioSources(success?: (res: { audioSources: Array<'auto' | 'buildInMic' | 'headsetMic' | 'mic' | 'camcorder' | 'voice_communication' | 'voice_recognition'> }) => void, fail?: (res?: any) => void, complete?: (res?: any) => void): void;
/**
* InnerAudioContext 实例,可通过 wx.createInnerAudioContext 接口获取实例。
*/
interface InnerAudioContext {
/** 音频资源的地址,用于直接播放。2.2.3 开始支持云文件ID*/
src: string;
/** 开始播放的位置(单位:s),默认为 0*/
startTime: number;
/** 是否自动开始播放,默认为 false*/
autoplay: boolean;
/** 是否循环播放,默认为 false*/
loop: boolean;
/** 是否遵循系统静音开关,默认为 true。当此参数为 false 时,即使用户打开了静音开关,也能继续发出声音*/
obeyMuteSwitch: boolean;
/** 基础库 1.9.90 开始支持,低版本需做兼容处理。音量。范围 0~1。默认为 1*/
volume: number;
/** 当前音频的长度(单位 s)。只有在当前有合法的 src 时返回(只读)*/
duration: number;
/** 当前音频的播放位置(单位 s)。只有在当前有合法的 src 时返回,时间保留小数点后 6 位(只读)*/
currentTime: number;
/** 当前是是否暂停或停止状态(只读)*/
paused: boolean;
/** 音频缓冲的时间点,仅保证当前播放时间点到此时间点内容已缓冲(只读)*/
buffered: number;
/**
* 销毁当前实例
*/
destroy(): void;
/**
* 取消监听音频进入可以播放状态的事件
*/
offCanplay(callback: () => void): void;
/**
* 监听音频暂停事件
*/
onPause(callback: () => void): void;
/**
* 监听音频停止事件
*/
onStop(callback: () => void): void;
/**
* 取消监听音频停止事件
*/
offStop(callback: () => void): void;
/**
* 监听音频自然播放至结束的事件
*/
onEnded(callback: () => void): void;
/**
* 取消监听音频自然播放至结束的事件
*/
offEnded(callback: () => void): void;
/**
* 监听音频播放进度更新事件
*/
onTimeUpdate(callback: () => void): void;
/**
* 监听音频播放事件
*/
onPlay(callback: () => void): void;
/**
* 监听音频播放错误事件
*/
onError(callback: (res: { errCode: 10001 | 10002 | 10003 | 10004 | -1 }) => void): void;
/**
* 取消监听音频暂停事件
*/
offPause(callback: () => void): void;
/**
* 监听音频加载中事件,当音频因为数据不足,需要停下来加载时会触发
*/
onWaiting(callback: () => void): void;
/**
* 取消监听音频加载中事件,当音频因为数据不足,需要停下来加载时会触发
*/
offWaiting(callback: () => void): void;
/**
* 监听音频进行跳转操作的事件
*/
onSeeking(callback: () => void): void;
/**