forked from changshazhou/MiniGameAllPlatformSDK-Source
-
Notifications
You must be signed in to change notification settings - Fork 1
/
wx.d.ts
5643 lines (4720 loc) · 115 KB
/
wx.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
interface CanvasContext {
/**
* 创建一个颜色的渐变点。
*/
addColorStop: () => void;
/**
* 画一条弧线。
*/
arc: () => void;
/**
* 开始创建一个路径,需要调用fill或者stroke才会使用路径进行填充或描边。
*/
beginPath: () => void;
/**
* 创建三次方贝塞尔曲线路径。
*/
bezierCurveTo: () => void;
/**
* 清空绘图上下文的绘图动作。
*/
clearActions: () => void;
/**
* 清除画布上在该矩形区域内的内容。
*/
clearRect: () => void;
/**
* clip() 方法从原始画布中剪切任意形状和尺寸。一旦剪切了某个区域,则所有之后的绘图都会被限制在被剪切的区域内(不能访问画布上的其他区域)。可以在使用 clip() 方法前通过使用 save() 方法对当前画布区域进行保存,并在以后的任意时间对其进行恢复(通过 restore() 方法)。
*/
clip: () => void;
/**
* 关闭一个路径
*/
closePath: () => void;
/**
* 创建一个圆形的渐变颜色。
*/
createCircularGradient: () => void;
/**
* 创建一个线性的渐变颜色。
*/
createLinearGradient: () => void;
/**
* 将之前在绘图上下文中的描述(路径、变形、样式)画到 canvas 中。
*/
draw: () => void;
/**
* 绘制图像到画布。
*/
drawImage: () => void;
/**
* 对当前路径中的内容进行填充。默认的填充色为黑色。
*/
fill: () => void;
/**
* 填充一个矩形。
*/
fillRect: () => void;
/**
* 在画布上绘制被填充的文本。
*/
fillText: () => void;
/**
* const ctx = wx.createCanvasContext('myCanvas')
*/
lineTo: () => void;
/**
* 把路径移动到画布中的指定点,不创建线条。
*/
moveTo: () => void;
/**
* 创建二次贝塞尔曲线路径。
*/
quadraticCurveTo: () => void;
/**
* 创建一个矩形。
*/
rect: () => void;
/**
* 以原点为中心,原点可以用 [translate](#translate)方法修改。顺时针旋转当前坐标轴。多次调用`rotate`,旋转的角度会叠加。
*/
rotate: () => void;
/**
* 保存当前的绘图上下文。
*/
save: () => void;
/**
* 在调用`scale`方法后,之后创建的路径其横纵坐标会被缩放。多次调用`scale`,倍数会相乘。
*/
scale: () => void;
/**
* 设置填充色。
*/
setFillStyle: () => void;
/**
* 设置字体的字号。
*/
setFontSize: () => void;
/**
* 设置全局画笔透明度。
*/
setGlobalAlpha: () => void;
/**
* 设置线条的端点样式。
*/
setLineCap: () => void;
/**
* 设置线条的宽度。
*/
setLineDash: () => void;
/**
* 设置线条的交点样式。
*/
setLineJoin: () => void;
/**
* 设置线条的宽度。
*/
setLineWidth: () => void;
/**
* 设置最大斜接长度,斜接长度指的是在两条线交汇处内角和外角之间的距离。 当 `setLineJoin()` 为 miter 时才有效。超过最大倾斜长度的,连接处将以 lineJoin 为 bevel 来显示
*/
setMiterLimit: () => void;
/**
* 设置阴影样式。
*/
setShadow: () => void;
/**
* 设置边框颜色。
*/
setStrokeStyle: () => void;
/**
* 用于设置文字的对齐
*/
setTextAlign: () => void;
/**
* 用于设置文字的水平对齐
*/
setTextBaseline: () => void;
/**
* 画出当前路径的边框。默认颜色色为黑色。
*/
stroke: () => void;
/**
* 画一个矩形(非填充)。
*/
strokeRect: () => void;
/**
* 对当前坐标系的原点(0, 0)进行变换,默认的坐标系原点为页面左上角。
*/
translate: () => void;
}
interface _writeBLECharacteristicValueObject {
/**
* 蓝牙设备 id,参考 device 对象
*/
deviceId: string;
/**
* 蓝牙特征值对应服务的 uuid
*/
serviceId: string;
/**
* 蓝牙特征值的 uuid
*/
characteristicId: string;
/**
* 蓝牙设备特征值对应的二进制值
*/
value: any;
/**
* 成功则返回本机蓝牙适配器状态
*/
success: (result: _writeBLECharacteristicValueSuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _writeBLECharacteristicValueSuccessObject {
/**
* 成功:ok,错误:详细信息
*/
errMsg: string;
}
interface _vibrateShortObject {
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _vibrateLongObject {
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _uploadFileObject {
/**
* 开发者服务器 url
*/
url: string;
/**
* 要上传文件资源的路径
*/
filePath: string;
/**
* 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容
*/
name: string;
/**
* HTTP 请求 Header, header 中不能设置 Referer
*/
header: object;
/**
* HTTP 请求中其他额外的 form data
*/
formData: object;
/**
* 接口调用成功的回调函数
*/
success: (result: _uploadFileSuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _uploadFileSuccessObject {
/**
* 开发者服务器返回的数据
*/
data: string;
/**
* 开发者服务器返回的 HTTP 状态码
*/
statusCode: number;
}
interface _updateShareMenuObject {
/**
* 是否使用带 shareTicket 的转发[详情](./share.md#获取更多转发信息)
*/
withShareTicket: boolean;
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _switchTabObject {
/**
* 需要跳转的 tabBar 页面的路径(需在 app.json 的 [tabBar](../framework/config.md#tabbar) 字段定义的页面),路径后不能带参数
*/
url: string;
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _stopWifiObject {
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _stopHCEObject {
/**
* 接口调用成功的回调函数
*/
success: (result: _stopHCESuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _stopHCESuccessObject {
/**
* 错误信息
*/
errMsg: string;
/**
* 错误码
*/
errCode: number;
}
interface _stopCompassObject {
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _stopBluetoothDevicesDiscoveryObject {
/**
* 成功则返回本机蓝牙适配器状态
*/
success: (result: _stopBluetoothDevicesDiscoverySuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _stopBluetoothDevicesDiscoverySuccessObject {
/**
* 成功:ok,错误:详细信息
*/
errMsg: string;
}
interface _stopBeaconDiscoveryObject {
/**
* 接口调用成功的回调函数
*/
success: (result: _stopBeaconDiscoverySuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _stopBeaconDiscoverySuccessObject {
/**
* 调用结果
*/
errMsg: string;
}
interface _stopAccelerometerObject {
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _startWifiObject {
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _startSoterAuthenticationObject {
/**
* 请求使用的可接受的生物认证方式
*/
requestAuthModes: any;
/**
* 挑战因子。挑战因子为调用者为此次生物鉴权准备的用于签名的字符串关键是别信息,将作为result_json的一部分,供调用者识别本次请求。例如:如果场景为请求用户对某订单进行授权确认,则可以将订单号填入此参数。
*/
challenge: string;
/**
* 验证描述,即识别过程中显示在界面上的对话框提示内容
*/
authContent: string;
/**
* 接口调用成功的回调函数
*/
success: (result: _startSoterAuthenticationSuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _startSoterAuthenticationSuccessObject {
/**
* 错误码
*/
errCode: number;
/**
* 生物认证方式
*/
authMode: string;
/**
* 在设备安全区域(TEE)内获得的本机安全信息(如TEE名称版本号等以及防重放参数)以及本次认证信息(仅Android支持,本次认证的指纹ID)(仅Android支持,本次认证的指纹ID)
*/
resultJSON: string;
/**
* 用SOTER安全密钥对result_json的签名(SHA256withRSA/PSS, saltlen=20)
*/
resultJSONSignature: string;
/**
* 接口调用结果
*/
errMsg: string;
}
interface _startRecordObject {
/**
* 录音成功后调用,返回录音文件的临时文件路径,res = {tempFilePath: '录音文件的临时路径'}
*/
success: (result: _startRecordSuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _startRecordSuccessObject {
/**
* 录音文件的临时路径
*/
tempFilePath: any;
}
interface _startPullDownRefreshObject {
/**
* 接口调用成功的回调函数
*/
success: (result: _startPullDownRefreshSuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _startPullDownRefreshSuccessObject {
/**
* 接口调用结果
*/
errMsg: string;
}
interface _startHCEObject {
/**
* 需要注册到系统的 AID 列表,每个 AID 为 String 类型
*/
aid_list: any;
/**
* 接口调用成功的回调函数
*/
success: (result: _startHCESuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _startHCESuccessObject {
/**
* 错误信息
*/
errMsg: string;
/**
* 错误码
*/
errCode: number;
}
interface _startCompassObject {
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _startBluetoothDevicesDiscoveryObject {
/**
* 蓝牙设备主 service 的 uuid 列表
*/
services: any;
/**
* 是否允许重复上报同一设备, 如果允许重复上报,则onDeviceFound 方法会多次上报同一设备,但是 RSSI 值会有不同
*/
allowDuplicatesKey: boolean;
/**
* 上报设备的间隔,默认为0,意思是找到新设备立即上报,否则根据传入的间隔上报
*/
interval: number;
/**
* 成功则返回本机蓝牙适配器状态
*/
success: (result: _startBluetoothDevicesDiscoverySuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _startBluetoothDevicesDiscoverySuccessObject {
/**
* 成功:ok,错误:详细信息
*/
errMsg: string;
}
interface _startBeaconDiscoveryObject {
/**
* iBeacon设备广播的 uuids
*/
uuids: any;
/**
* 接口调用成功的回调函数
*/
success: (result: _startBeaconDiscoverySuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _startBeaconDiscoverySuccessObject {
/**
* 调用结果
*/
errMsg: string;
}
interface _startAccelerometerObject {
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _showToastObject {
/**
* 提示的内容
*/
title: string;
/**
* 图标,有效值 "success", "loading", "none"
*/
icon: string;
/**
* 自定义图标的本地路径,image 的优先级高于 icon
*/
image: string;
/**
* 提示的延迟时间,单位毫秒,默认:1500
*/
duration: number;
/**
* 是否显示透明蒙层,防止触摸穿透,默认:false
*/
mask: boolean;
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _showTabBarRedDotObject {
/**
* tabBar的哪一项,从左边算起
*/
index: number;
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _showTabBarObject {
/**
* 是否需要动画效果,默认无
*/
aniamtion: boolean;
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _showShareMenuObject {
/**
* 是否使用带 shareTicket 的转发[详情](./share.md#获取更多转发信息)
*/
withShareTicket: boolean;
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _showModalObject {
/**
* 提示的标题
*/
title: string;
/**
* 提示的内容
*/
content: string;
/**
* 是否显示取消按钮,默认为 true
*/
showCancel: boolean;
/**
* 取消按钮的文字,默认为"取消",最多 4 个字符
*/
cancelText: string;
/**
* 取消按钮的文字颜色,默认为"#000000"
*/
cancelColor: any;
/**
* 确定按钮的文字,默认为"确定",最多 4 个字符
*/
confirmText: string;
/**
* 确定按钮的文字颜色,默认为"#3CC51F"
*/
confirmColor: any;
/**
* 接口调用成功的回调函数
*/
success: (result: _showModalSuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _showModalSuccessObject {
/**
* 为 true 时,表示用户点击了确定按钮
*/
confirm: boolean;
/**
* 为 true 时,表示用户点击了取消(用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭)
*/
cancel: boolean;
}
interface _showLoadingObject {
/**
* 提示的内容
*/
title: string;
/**
* 是否显示透明蒙层,防止触摸穿透,默认:false
*/
mask: boolean;
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _showActionSheetObject {
/**
* 按钮的文字数组,数组长度最大为6个
*/
itemList: any;
/**
* 按钮的文字颜色,默认为"#000000"
*/
itemColor: any;
/**
* 接口调用成功的回调函数,详见返回参数说明
*/
success: (result: _showActionSheetSuccessObject) => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _showActionSheetSuccessObject {
/**
* 用户点击的按钮,从上到下的顺序,从0开始
*/
tapIndex: number;
}
interface _setWifiListObject {
/**
* 提供预设的 Wi-Fi 信息列表
*/
wifiList: any;
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _setTopBarTextObject {
/**
* 置顶栏文字内容
*/
text: string;
/**
* 接口调用成功的回调函数
*/
success: () => void;
/**
* 接口调用失败的回调函数
*/
fail: () => void;
/**
* 接口调用结束的回调函数(调用成功、失败都会执行)
*/
complete: () => void;
}
interface _setTabBarStyleObject {