@dcloudio/uni-app-x 0.7.1 → 0.7.3

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.
@@ -38,133 +38,140 @@ export type GetAppBaseInfoResult = {
38
38
  /**
39
39
  * 应用资源(wgt)的版本名称。
40
40
  *
41
- * @uniPlatform {
42
- * "app": {
43
- * "android": {
44
- * "osVer": "5.0",
45
- * "uniVer": "",
46
- * "unixVer": "x"
47
- * },
48
- * "ios": {
49
- * "osVer": "9.0",
50
- * "uniVer": "",
51
- * "unixVer": "x"
52
- * }
53
- * }
41
+ * @uniPlatform
42
+ * {
43
+ * "app": {
44
+ * "android": {
45
+ * "osVer": "5.0",
46
+ * "uniVer": "",
47
+ * "unixVer": "x"
48
+ * },
49
+ * "ios": {
50
+ * "osVer": "9.0",
51
+ * "uniVer": "",
52
+ * "unixVer": "x"
53
+ * }
54
+ * }
54
55
  * }
55
56
  */
56
57
  appWgtVersion?: string,
57
58
  /**
58
59
  * 小程序宿主语言
59
60
  *
60
- * @uniPlatform {
61
- * "app": {
62
- * "android": {
63
- * "osVer": "5.0",
64
- * "uniVer": "",
65
- * "unixVer": "x"
66
- * },
67
- * "ios": {
68
- * "osVer": "9.0",
69
- * "uniVer": "",
70
- * "unixVer": "x"
71
- * }
72
- * }
61
+ * @uniPlatform
62
+ * {
63
+ * "app": {
64
+ * "android": {
65
+ * "osVer": "5.0",
66
+ * "uniVer": "",
67
+ * "unixVer": "x"
68
+ * },
69
+ * "ios": {
70
+ * "osVer": "9.0",
71
+ * "uniVer": "",
72
+ * "unixVer": "x"
73
+ * }
74
+ * }
73
75
  * }
74
76
  */
75
77
  hostLanguage?: string,
76
78
  /**
77
79
  * App、小程序宿主版本。
78
80
  *
79
- * @uniPlatform {
80
- * "app": {
81
- * "android": {
82
- * "osVer": "5.0",
83
- * "uniVer": "",
84
- * "unixVer": "x"
85
- * },
86
- * "ios": {
87
- * "osVer": "9.0",
88
- * "uniVer": "",
89
- * "unixVer": "x"
90
- * }
91
- * }
81
+ * @uniPlatform
82
+ * {
83
+ * "app": {
84
+ * "android": {
85
+ * "osVer": "5.0",
86
+ * "uniVer": "",
87
+ * "unixVer": "x"
88
+ * },
89
+ * "ios": {
90
+ * "osVer": "9.0",
91
+ * "uniVer": "",
92
+ * "unixVer": "x"
93
+ * }
94
+ * }
92
95
  * }
93
96
  */
94
97
  hostVersion?: string,
95
98
  /**
96
99
  * 小程序宿主名称
97
100
  *
98
- * @uniPlatform {
99
- * "app": {
100
- * "android": {
101
- * "osVer": "5.0",
102
- * "uniVer": "",
103
- * "unixVer": "x"
104
- * },
105
- * "ios": {
106
- * "osVer": "9.0",
107
- * "uniVer": "",
108
- * "unixVer": "x"
109
- * }
110
- * }
101
+ * @uniPlatform
102
+ * {
103
+ * "app": {
104
+ * "android": {
105
+ * "osVer": "5.0",
106
+ * "uniVer": "",
107
+ * "unixVer": "x"
108
+ * },
109
+ * "ios": {
110
+ * "osVer": "9.0",
111
+ * "uniVer": "",
112
+ * "unixVer": "x"
113
+ * }
114
+ * }
111
115
  * }
112
116
  */
113
117
  hostName?: string,
114
118
  /**
115
119
  * 小程序宿主包名
116
120
  *
117
- * @uniPlatform {
118
- * "app": {
119
- * "android": {
120
- * "osVer": "5.0",
121
- * "uniVer": "",
122
- * "unixVer": "x"
123
- * },
124
- * "ios": {
125
- * "osVer": "9.0",
126
- * "uniVer": "",
127
- * "unixVer": "x"
128
- * }
129
- * }
121
+ * @uniPlatform
122
+ * {
123
+ * "app": {
124
+ * "android": {
125
+ * "osVer": "5.0",
126
+ * "uniVer": "",
127
+ * "unixVer": "x"
128
+ * },
129
+ * "ios": {
130
+ * "osVer": "9.0",
131
+ * "uniVer": "",
132
+ * "unixVer": "x"
133
+ * }
134
+ * }
130
135
  * }
131
136
  */
132
137
  hostPackageName?: string,
133
138
  /**
134
139
  * uni小程序SDK版本、小程序客户端基础库版本
135
140
  *
136
- * @uniPlatform {
137
- * "app": {
138
- * "android": {
139
- * "osVer": "5.0",
140
- * "uniVer": "",
141
- * "unixVer": "x"
142
- * },
143
- * "ios": {
144
- * "osVer": "9.0",
145
- * "uniVer": "",
146
- * "unixVer": "x"
147
- * }
148
- * }
141
+ * @uniPlatform
142
+ * {
143
+ * "app": {
144
+ * "android": {
145
+ * "osVer": "5.0",
146
+ * "uniVer": "",
147
+ * "unixVer": "x"
148
+ * },
149
+ * "ios": {
150
+ * "osVer": "9.0",
151
+ * "uniVer": "",
152
+ * "unixVer": "x"
153
+ * }
154
+ * }
149
155
  * }
150
156
  */
151
157
  hostSDKVersion?: string,
152
158
  /**
153
159
  * 系统当前主题,取值为light或dark。微信小程序全局配置"darkmode":true时才能获取,否则为 undefined (不支持小游戏)
154
160
  *
155
- * @uniPlatform {
156
- * "app": {
157
- * "android": {
158
- * "osVer": "5.0",
159
- * "uniVer": "",
160
- * "unixVer": "x"
161
- * },
162
- * "ios": {
163
- * "osVer": "9.0",
164
- * "uniVer": "",
165
- * "unixVer": "x"
166
- * }
167
- * }
161
+ * @uniPlatform
162
+ * {
163
+ * "app": {
164
+ * "android": {
165
+ * "osVer": "5.0",
166
+ * "uniVer": "",
167
+ * "unixVer": "x"
168
+ * },
169
+ * "ios": {
170
+ * "osVer": "9.0",
171
+ * "uniVer": "",
172
+ * "unixVer": "x"
173
+ * }
174
+ * }
168
175
  * }
169
176
  */
170
177
  hostTheme?: string,
@@ -172,22 +179,65 @@ export type GetAppBaseInfoResult = {
172
179
  * 是否uni-app x
173
180
  */
174
181
  isUniAppX ?: boolean,
182
+
175
183
  /**
176
184
  * uni 编译器版本
185
+ * @deprecated 已废弃,仅为了向下兼容保留
177
186
  */
178
187
  uniCompileVersion ?: string,
179
188
  /**
180
- * uni-app 运行平台。如:`app`、`mp-weixin`、`web`
189
+ * uni 编译器版本
190
+ *
191
+ * @uniPlatform
192
+ * {
193
+ * "app": {
194
+ * "android": {
195
+ * "osVer": "5.0",
196
+ * "uniVer": "x",
197
+ * "unixVer": "4.0"
198
+ * },
199
+ * "ios": {
200
+ * "osVer": "9.0",
201
+ * "uniVer": "x",
202
+ * "unixVer": "x"
203
+ * }
204
+ * }
205
+ * }
181
206
  */
182
- uniPlatform ?: string,
207
+ uniCompilerVersion ?: string,
208
+ /**
209
+ * uni-app 运行平台。
210
+ */
211
+ uniPlatform ?: 'app' | 'web' | 'mp-weixin' | 'mp-alipay' | 'mp-baidu' | 'mp-toutiao' | 'mp-lark' | 'mp-qq' | 'mp-kuaishou' | 'mp-jd' | 'mp-360' | 'quickapp-webview' | 'quickapp-webview-union' | 'quickapp-webview-huawei',
183
212
  /**
184
213
  * uni 运行时版本
185
214
  */
186
215
  uniRuntimeVersion ?: string,
187
216
  /**
188
217
  * uni 编译器版本号
218
+ * @deprecated 已废弃,仅为了向下兼容保留
189
219
  */
190
220
  uniCompileVersionCode?: number,
221
+ /**
222
+ * uni 编译器版本号
223
+ *
224
+ * @uniPlatform
225
+ * {
226
+ * "app": {
227
+ * "android": {
228
+ * "osVer": "5.0",
229
+ * "uniVer": "x",
230
+ * "unixVer": "4.0"
231
+ * },
232
+ * "ios": {
233
+ * "osVer": "9.0",
234
+ * "uniVer": "x",
235
+ * "unixVer": "x"
236
+ * }
237
+ * }
238
+ * }
239
+ */
240
+ uniCompilerVersionCode?: number,
191
241
  /**
192
242
  * uni 运行时版本号
193
243
  */
@@ -195,40 +245,41 @@ export type GetAppBaseInfoResult = {
195
245
  /**
196
246
  * Android的包名
197
247
  *
198
- * @uniPlatform {
199
- * "app": {
200
- * "android": {
201
- * "osVer": "4.4",
202
- * "uniVer": "x",
203
- * "unixVer": "3.97"
204
- * },
205
- * "ios": {
206
- * "osVer": "x",
207
- * "uniVer": "x",
208
- * "unixVer": "x"
209
- * }
210
- * }
248
+ * @uniPlatform
249
+ * {
250
+ * "app": {
251
+ * "android": {
252
+ * "osVer": "4.4",
253
+ * "uniVer": "x",
254
+ * "unixVer": "3.97"
255
+ * },
256
+ * "ios": {
257
+ * "osVer": "x",
258
+ * "uniVer": "x",
259
+ * "unixVer": "x"
260
+ * }
261
+ * }
211
262
  * }
212
263
  */
213
264
  packageName?: string,
214
265
  /**
215
266
  * iOS的bundleId
216
267
  *
217
- * @uniPlatform {
218
- * "app": {
219
- * "android": {
220
- * "osVer": "x",
221
- * "uniVer": "x",
222
- * "unixVer": "x"
223
- * },
224
- * "ios": {
225
- * "osVer": "9.0",
226
- * "uniVer": "x",
227
- * "unixVer": "3.97"
228
- * }
229
- * }
268
+ * @uniPlatform
269
+ * {
270
+ * "app": {
271
+ * "android": {
272
+ * "osVer": "x",
273
+ * "uniVer": "x",
274
+ * "unixVer": "x"
275
+ * },
276
+ * "ios": {
277
+ * "osVer": "9.0",
278
+ * "uniVer": "x",
279
+ * "unixVer": "x"
280
+ * }
281
+ * }
230
282
  * }
231
- *
232
283
  * @autodoc false
233
284
  */
234
285
  bundleId?: string,
@@ -236,19 +287,20 @@ export type GetAppBaseInfoResult = {
236
287
  * Android: 应用签名证书的SHA1值(全部为小写,中间不包含“:”)。 为了保证应用的安全性,请使用自己生成的证书(不要使用公共测试证书)。
237
288
  * iOS: 应用签名证书中绑定的Bundle ID(AppleID)的md5值(全部为小写)。
238
289
  *
239
- * @uniPlatform {
240
- * "app": {
241
- * "android": {
242
- * "osVer": "4.4",
243
- * "uniVer": "x",
244
- * "unixVer": "3.97"
245
- * },
246
- * "ios": {
247
- * "osVer": "9.0",
248
- * "uniVer": "x",
249
- * "unixVer": "3.97"
250
- * }
251
- * }
290
+ * @uniPlatform
291
+ * {
292
+ * "app": {
293
+ * "android": {
294
+ * "osVer": "4.4",
295
+ * "uniVer": "x",
296
+ * "unixVer": "3.97"
297
+ * },
298
+ * "ios": {
299
+ * "osVer": "9.0",
300
+ * "uniVer": "x",
301
+ * "unixVer": "x"
302
+ * }
303
+ * }
252
304
  * }
253
305
  */
254
306
  signature?: string,
@@ -268,20 +320,21 @@ export interface Uni {
268
320
  * @param {GetAppBaseInfoOptions} options [options=包含所有字段的过滤对象] 过滤的字段对象, 不传参数默认为获取全部字段。
269
321
  * @return {object}
270
322
  * @tutorial https://uniapp.dcloud.net.cn/api/system/getAppBaseInfo.html
271
- * @uniPlatform {
272
- * "app": {
273
- * "android": {
274
- * "osVer": "4.4",
275
- * "uniVer": "",
276
- * "unixVer": "3.9+"
277
- * },
278
- * "ios": {
279
- * "osVer": "9.0",
280
- * "uniVer": "",
281
- * "unixVer": "3.9+"
282
- * }
283
- * }
284
- * }
323
+ * @uniPlatform
324
+ * {
325
+ * "app": {
326
+ * "android": {
327
+ * "osVer": "4.4",
328
+ * "uniVer": "",
329
+ * "unixVer": "3.9+"
330
+ * },
331
+ * "ios": {
332
+ * "osVer": "9.0",
333
+ * "uniVer": "",
334
+ * "unixVer": "x"
335
+ * }
336
+ * }
337
+ * }
285
338
  * @example
286
339
  ```typescript
287
340
  uni.getAppBaseInfo({
@@ -46,25 +46,6 @@ export type GetDeviceInfoResult = {
46
46
  * 客户端平台
47
47
  */
48
48
  platform?: string,
49
- /**
50
- * oaid标识 Android专有
51
- *
52
- * @uniPlatform {
53
- * "app": {
54
- * "android": {
55
- * "osVer": "5.0",
56
- * "uniVer": "√",
57
- * "unixVer": "√"
58
- * },
59
- * "ios": {
60
- * "osVer": "9.0",
61
- * "uniVer": "x",
62
- * "unixVer": "x"
63
- * }
64
- * }
65
- * }
66
- */
67
- oaid?: string,
68
49
  /**
69
50
  * 是否root
70
51
  */
@@ -76,44 +57,23 @@ export type GetDeviceInfoResult = {
76
57
  /**
77
58
  * adb是否开启
78
59
  *
79
- * @uniPlatform {
80
- * "app": {
81
- * "android": {
82
- * "osVer": "5.0",
83
- * "uniVer": "",
84
- * "unixVer": ""
85
- * },
86
- * "ios": {
87
- * "osVer": "9.0",
88
- * "uniVer": "x",
89
- * "unixVer": "x"
90
- * }
91
- * }
60
+ * @uniPlatform
61
+ * {
62
+ * "app": {
63
+ * "android": {
64
+ * "osVer": "5.0",
65
+ * "uniVer": "x",
66
+ * "unixVer": "√"
67
+ * },
68
+ * "ios": {
69
+ * "osVer": "x",
70
+ * "uniVer": "x",
71
+ * "unixVer": "x"
72
+ * }
73
+ * }
92
74
  * }
93
75
  */
94
76
  isUSBDebugging?: boolean,
95
- /**
96
- * idfa标识 iOS专有
97
- *
98
- * @uniPlatform {
99
- * "app": {
100
- * "android": {
101
- * "osVer": "5.0",
102
- * "uniVer": "x",
103
- * "unixVer": "x"
104
- * },
105
- * "ios": {
106
- * "osVer": "9.0",
107
- * "uniVer": "√",
108
- * "unixVer": "√"
109
- * }
110
- * }
111
- * }
112
- */
113
- idfa?: string,
114
- /**
115
- * 应用平台
116
- */
117
77
  }
118
78
 
119
79
 
@@ -131,20 +91,21 @@ export interface Uni {
131
91
  * @param {GetDeviceInfoOptions} options [options=包含所有字段的过滤对象] 过滤的字段对象, 不传参数默认为获取全部字段。
132
92
  * @return {object}
133
93
  * @tutorial https://uniapp.dcloud.net.cn/api/system/getDeviceInfo.html
134
- * @uniPlatform {
135
- * "app": {
136
- * "android": {
137
- * "osVer": "4.4",
138
- * "uniVer": "",
139
- * "unixVer": "3.9+"
140
- * },
141
- * "ios": {
142
- * "osVer": "9.0",
143
- * "uniVer": "",
144
- * "unixVer": "3.9+"
145
- * }
146
- * }
147
- * }
94
+ * @uniPlatform
95
+ * {
96
+ * "app": {
97
+ * "android": {
98
+ * "osVer": "4.4",
99
+ * "uniVer": "",
100
+ * "unixVer": "3.9+"
101
+ * },
102
+ * "ios": {
103
+ * "osVer": "9.0",
104
+ * "uniVer": "",
105
+ * "unixVer": "x"
106
+ * }
107
+ * }
108
+ * }
148
109
  * @example
149
110
  ```typescript
150
111
  uni.getDeviceInfo({
@@ -6,20 +6,21 @@ export interface Uni {
6
6
  * @param {GetNetworkTypeOptions} options
7
7
  * @return {void}
8
8
  * @tutorial http://uniapp.dcloud.io/api/system/network?id=getnetworktype
9
- * @uniPlatform {
10
- * "app": {
11
- * "android": {
12
- * "osVer": "4.4",
13
- * "uniVer": "",
14
- * "unixVer": "3.9+"
15
- * },
16
- * "ios": {
17
- * "osVer": "9.0",
18
- * "uniVer": "",
19
- * "unixVer": "x"
20
- * }
21
- * }
22
- * }
9
+ * @uniPlatform
10
+ * {
11
+ * "app": {
12
+ * "android": {
13
+ * "osVer": "4.4",
14
+ * "uniVer": "",
15
+ * "unixVer": "3.9+"
16
+ * },
17
+ * "ios": {
18
+ * "osVer": "9.0",
19
+ * "uniVer": "",
20
+ * "unixVer": "x"
21
+ * }
22
+ * }
23
+ * }
23
24
  * @example
24
25
  ```typescript
25
26
  uni.getNetworkType({