interface.uts 40.3 KB
Newer Older
DCloud-yyl's avatar
DCloud-yyl 已提交
1 2 3
export interface Uni {
  /**
    * getSystemInfo()
DCloud-yyl's avatar
DCloud-yyl 已提交
4
    * @description
DCloud-yyl's avatar
DCloud-yyl 已提交
5 6 7
    * 异步获取系统信息
    * @param {GetSystemInfoOptions}  options
    * @return {void}
DCloud-yyl's avatar
DCloud-yyl 已提交
8 9 10
    * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/system/info.html
    * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/get-system-info.html
    * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-system-info.html
DCloud-yyl's avatar
DCloud-yyl 已提交
11 12 13 14 15 16 17 18 19 20 21 22
    * @uniPlatform
	* {
	* 	"app": {
	* 		"android": {
	* 			"osVer": "5.0",
	* 			"uniVer": "√",
	* 			"unixVer": "3.9+"
	* 		},
	* 		"ios": {
	* 			"osVer": "12.0",
	* 			"uniVer": "√",
	* 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
23 24 25 26 27 28
	* 		},
  *    "harmony": {
  *      "osVer": "3.0",
  *      "uniVer": "4.23",
  *      "unixVer": "x"
  *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
	* 	},
    *   "web": {
    *     "uniVer": "√",
    *     "unixVer": "4.0"
    *   }
	* }
    * @example
     ```typescript
      uni.getSystemInfo({
        success(e) {
          console.log("success :",e);
        },
        complete(e) {
          console.log("complete :",e);
        }
      })
     ```
    */
  getSystemInfo(options: GetSystemInfoOptions): void;

  /**
    * getSystemInfoSync()
DCloud-yyl's avatar
DCloud-yyl 已提交
51
    * @description
DCloud-yyl's avatar
DCloud-yyl 已提交
52
    * 同步获取系统信息
DCloud-yyl's avatar
DCloud-yyl 已提交
53
    * @param {void}
DCloud-yyl's avatar
DCloud-yyl 已提交
54
    * @return {GetSystemInfoResult}
DCloud-yyl's avatar
DCloud-yyl 已提交
55 56 57
    * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/system/info.html#getsysteminfosync
    * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/get-system-info.html#getsysteminfosync
    * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-system-info.html#getsysteminfosync
DCloud-yyl's avatar
DCloud-yyl 已提交
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
    * @uniPlatform
	* {
	* 	"app": {
	* 		"android": {
	* 			"osVer": "5.0",
	* 			"uniVer": "√",
	* 			"unixVer": "3.9+"
	* 		},
	* 		"ios": {
	* 			"osVer": "12.0",
	* 			"uniVer": "√",
	* 			"unixVer": "4.11"
	* 		}
	* 	},
    *   "web": {
    *     "uniVer": "√",
    *     "unixVer": "4.0"
    *   }
	* }
    * @example
     ```typescript
      uni.getSystemInfoSync()
     ```
    */
  getSystemInfoSync(): GetSystemInfoResult;

  /**
    * getWindowInfo()
DCloud-yyl's avatar
DCloud-yyl 已提交
86
    * @description
DCloud-yyl's avatar
DCloud-yyl 已提交
87
    * 同步获取窗口信息
DCloud-yyl's avatar
DCloud-yyl 已提交
88
    * @param {void}
DCloud-yyl's avatar
DCloud-yyl 已提交
89
    * @return {GetWindowInfoResult} result
DCloud-yyl's avatar
DCloud-yyl 已提交
90 91 92
    * @tutorial-uni-app https://uniapp.dcloud.net.cn/api/system/getWindowInfo.html
    * @tutorial-uni-app-x https://doc.dcloud.net.cn/uni-app-x/api/get-window-info.html
    * @tutorial https://doc.dcloud.net.cn/uni-app-x/api/get-window-info.html
DCloud-yyl's avatar
DCloud-yyl 已提交
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
    * @uniPlatform
	* {
	* 	"app": {
	* 		"android": {
	* 			"osVer": "5.0",
	* 			"uniVer": "√",
	* 			"unixVer": "3.9+"
	* 		},
	* 		"ios": {
	* 			"osVer": "12.0",
	* 			"uniVer": "√",
	* 			"unixVer": "4.11"
	* 		}
	* 	},
    *   "web": {
    *     "uniVer": "√",
    *     "unixVer": "4.0"
    *   }
	* }
    * @example
     ```typescript
      uni.getWindowInfo()
     ```
    */
  getWindowInfo(): GetWindowInfoResult;
}

export type GetSystemInfo = (options: GetSystemInfoOptions) => void;
export type GetSystemInfoSync = () => GetSystemInfoResult;
export type GetWindowInfo = () => GetWindowInfoResult;
export type SafeArea = {
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
125
   * 安全区域左上角横坐标,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
126
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
127 128 129 130 131 132 133 134 135 136 137 138
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
139 140 141 142 143 144
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
145 146 147 148 149 150 151 152 153
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  left: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
154
   * 安全区域右下角横坐标,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
155
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
156 157 158 159 160 161 162 163 164 165 166 167
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
168 169 170 171 172 173
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
174 175 176 177 178 179 180 181 182
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  right: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
183
   * 安全区域左上角纵坐标,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
184
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
185 186 187 188 189 190 191 192 193 194 195 196
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
197 198 199 200 201 202
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
203 204 205 206 207 208 209 210 211
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  top: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
212
   * 安全区域右下角纵坐标,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
213
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
214 215 216 217 218 219 220 221 222 223 224 225
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
226 227 228 229 230 231
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
232 233 234 235 236 237 238 239 240
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  bottom: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
241
   * 安全区域的宽度,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
242
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
243 244 245 246 247 248 249 250 251 252 253 254
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
255 256 257 258 259 260
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
261 262 263 264 265 266 267 268 269
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  width: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
270
   * 安全区域的高度,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
271
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
272 273 274 275 276 277 278 279 280 281 282 283
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
284 285 286 287 288 289
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
290 291 292 293 294 295 296 297 298 299 300 301
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  height: number
};
export type SafeAreaInsets = {
  /**
   * 安全区域左侧插入位置(距离左边边界距离),单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
302
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
303 304 305 306 307 308 309 310 311 312 313 314
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
315 316 317 318 319 320
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
321 322 323 324 325 326 327 328 329 330
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  left: number,
  /**
   * 安全区域右侧插入位置(距离右边边界距离),单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
331
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
332 333 334 335 336 337 338 339 340 341 342 343
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
344 345 346 347 348 349
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
350 351 352 353 354 355 356 357 358 359
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  right: number,
  /**
   * 安全区顶部插入位置(距离顶部边界距离),单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
360
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
361 362 363 364 365 366 367 368 369 370 371 372
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
373 374 375 376 377 378
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
379 380 381 382 383 384 385 386 387 388
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  top: number,
  /**
   * 安全区域底部插入位置(距离底部边界距离),单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
389
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
390 391 392 393 394 395 396 397 398 399 400 401
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
402 403 404 405 406 407
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
408 409 410 411 412 413 414 415 416 417 418
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  bottom: number
};
export type GetSystemInfoResult = {
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
419
   * 客户端基础库版本
DCloud-yyl's avatar
DCloud-yyl 已提交
420
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
421 422 423 424 425 426 427 428 429 430 431 432
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
433 434 435 436 437 438
   * 		},
     *    "harmony": {
     *      "osVer": "x",
     *      "uniVer": "x",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
439 440 441 442 443 444 445 446 447
   * 	},
   *   "web": {
   *     "uniVer": "x",
   *     "unixVer": "x"
   *   }
   * }
   */
  SDKVersion: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
448
   * `manifest.json` 中应用appid。
DCloud-yyl's avatar
DCloud-yyl 已提交
449
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
450 451 452 453 454 455 456 457 458 459 460 461
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
462 463 464 465 466 467
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
468 469 470 471 472 473 474 475 476
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  appId: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
477
   * 应用设置的语言。
DCloud-yyl's avatar
DCloud-yyl 已提交
478
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
479 480 481 482 483 484 485 486 487 488 489 490
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
491 492 493 494 495 496
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
497 498 499 500 501 502 503 504 505
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  appLanguage: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
506
   * `manifest.json` 中应用名称。
DCloud-yyl's avatar
DCloud-yyl 已提交
507
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
508 509 510 511 512 513 514 515 516 517 518 519
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
520 521 522 523 524 525
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
526 527 528 529 530 531 532 533 534
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  appName: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
535
   * `manifest.json` 中应用版本名称。
DCloud-yyl's avatar
DCloud-yyl 已提交
536
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
537 538 539 540 541 542 543 544 545 546 547 548
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
549 550 551 552 553 554
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
555 556 557 558 559 560 561 562 563
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  appVersion: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
564
   * `manifest.json` 中应用版本名号。
DCloud-yyl's avatar
DCloud-yyl 已提交
565
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
566 567 568 569 570 571 572 573 574 575 576 577
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
578 579 580 581 582 583
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
584 585 586 587 588 589 590 591 592 593
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  appVersionCode: string,
  /**
   * 应用资源(wgt)的版本名称。
DCloud-yyl's avatar
DCloud-yyl 已提交
594
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
595 596 597 598 599 600 601 602 603 604 605 606
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "x"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "x"
DCloud-yyl's avatar
DCloud-yyl 已提交
607 608 609 610 611 612
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
613 614 615 616 617 618 619 620 621
   * 	},
   *   "web": {
   *     "uniVer": "x",
   *     "unixVer": "x"
   *   }
   * }
   */
  appWgtVersion?: string | null,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
622 623
   * 手机品牌。
   * @deprecated 已废弃,仅为了向下兼容保留
DCloud-yyl's avatar
DCloud-yyl 已提交
624
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
625 626 627 628 629 630 631 632 633 634 635 636
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
637 638 639 640 641 642
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
643 644 645 646 647 648 649 650 651
   * 	},
   *   "web": {
   *     "uniVer": "x",
   *     "unixVer": "x"
   *   }
   * }
   */
  brand: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
652
   * 浏览器名称。`App` 端是系统 webview 的名字,比如 wkwebview、chrome。小程序端为空
DCloud-yyl's avatar
DCloud-yyl 已提交
653
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
654 655 656 657 658 659 660 661 662 663 664 665
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
666 667 668 669 670 671
   * 		},
     *    "harmony": {
     *      "osVer": "x",
     *      "uniVer": "x",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
672 673 674 675 676 677 678 679 680
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  browserName: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
681
   * 浏览器版本、webview 版本。
DCloud-yyl's avatar
DCloud-yyl 已提交
682
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
683 684 685 686 687 688 689 690 691 692 693 694
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
695 696 697 698 699 700
   * 		},
     *    "harmony": {
     *      "osVer": "x",
     *      "uniVer": "x",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
701 702 703 704 705 706 707 708 709
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  browserVersion: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
710
   * 设备 ID
DCloud-yyl's avatar
DCloud-yyl 已提交
711
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
712 713 714 715 716 717 718 719 720 721 722 723
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
724 725 726 727 728 729
   * 		},
     *    "harmony": {
     *      "osVer": "3.0",
     *      "uniVer": "4.23",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
730 731 732 733 734 735 736 737 738
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  deviceId: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
739
   * 设备品牌。如:`apple`、`huawei`。
DCloud-yyl's avatar
DCloud-yyl 已提交
740
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
741 742 743 744 745 746 747 748 749 750 751 752
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
753 754 755 756 757 758
   * 		},
     *    "harmony": {
     *      "osVer": "3.0",
     *      "uniVer": "4.23",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
759 760 761 762 763 764 765 766 767
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  deviceBrand: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
768
   * 设备型号
DCloud-yyl's avatar
DCloud-yyl 已提交
769
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
770 771 772 773 774 775 776 777 778 779 780 781
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
782 783 784 785 786 787
   * 		},
     *    "harmony": {
     *      "osVer": "3.0",
     *      "uniVer": "4.23",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
788 789 790 791 792 793 794 795 796
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  deviceModel: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
797
   * 设备类型。
DCloud-yyl's avatar
DCloud-yyl 已提交
798
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
799 800 801 802 803 804 805 806 807 808 809 810
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
811 812 813 814 815 816
   * 		},
     *    "harmony": {
     *      "osVer": "3.0",
     *      "uniVer": "4.23",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
817 818 819 820 821 822 823 824 825
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  deviceType: 'phone' | 'pad' | 'tv' | 'watch' | 'pc' | 'undefined' | 'car' | 'vr' | 'appliance',
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
826
   * 设备像素比
DCloud-yyl's avatar
DCloud-yyl 已提交
827
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
828 829 830 831 832 833 834 835 836 837 838 839
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
840 841 842 843 844 845
   * 		},
     *    "harmony": {
     *      "osVer": "3.0",
     *      "uniVer": "4.23",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
846 847 848 849 850 851 852 853 854 855
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  devicePixelRatio: number,
  /**
   * 设备方向。
DCloud-yyl's avatar
DCloud-yyl 已提交
856
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
857 858 859 860 861 862 863 864 865 866 867 868
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
869 870 871 872 873 874
   * 		},
     *    "harmony": {
     *      "osVer": "3.0",
     *      "uniVer": "4.23",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
875 876 877 878 879 880 881
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
DCloud-yyl's avatar
DCloud-yyl 已提交
882 883 884 885 886 887 888 889 890
  deviceOrientation:
  /**
   * 纵向
   */
  'portrait' |
  /**
   * 横向
   */
  'landscape',
DCloud-yyl's avatar
DCloud-yyl 已提交
891
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
892 893
   * 程序设置的语言
   * @deprecated 已废弃,仅为了向下兼容保留
DCloud-yyl's avatar
DCloud-yyl 已提交
894
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
895 896 897 898 899 900 901 902 903 904 905 906
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
907 908 909 910 911 912
   * 		},
     *    "harmony": {
     *      "osVer": "x",
     *      "uniVer": "x",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
913 914 915 916 917 918 919 920 921
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  language: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
922 923
   * 手机型号
   * @deprecated 已废弃,仅为了向下兼容保留
DCloud-yyl's avatar
DCloud-yyl 已提交
924
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
925 926 927 928 929 930 931 932 933 934 935 936
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
937 938 939 940 941 942
   * 		},
     *    "harmony": {
     *      "osVer": "x",
     *      "uniVer": "x",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
943 944 945 946 947 948 949
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
DCloud-yyl's avatar
DCloud-yyl 已提交
950
  model?: string,
DCloud-yyl's avatar
DCloud-yyl 已提交
951
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
952 953
   * 系统名称
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
954 955 956 957 958 959 960 961 962 963 964 965
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
966 967 968 969 970 971
   * 		},
     *    "harmony": {
     *      "osVer": "3.0",
     *      "uniVer": "4.23",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
972 973 974 975 976 977 978
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
DCloud-yyl's avatar
DCloud-yyl 已提交
979
  osName: 'ios' | 'android' | 'harmonyos' | 'macos' | 'windows' | 'linux',
DCloud-yyl's avatar
DCloud-yyl 已提交
980
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
981
   * 操作系统版本。如 ios 版本,andriod 版本
DCloud-yyl's avatar
DCloud-yyl 已提交
982
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
983 984 985 986 987 988 989 990 991 992 993 994
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
995 996 997 998 999 1000
   * 		},
     *    "harmony": {
     *      "osVer": "3.0",
     *      "uniVer": "4.23",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1001 1002 1003 1004 1005 1006 1007 1008 1009
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  osVersion: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1010
   * 操作系统语言
DCloud-yyl's avatar
DCloud-yyl 已提交
1011
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1024 1025 1026 1027 1028 1029
   * 		},
     *    "harmony": {
     *      "osVer": "3.0",
     *      "uniVer": "4.23",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  osLanguage: string,
  /**
   * 操作系统主题
DCloud-yyl's avatar
DCloud-yyl 已提交
1040
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "√"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1053 1054 1055 1056 1057 1058
   * 		},
     *    "harmony": {
     *      "osVer": "3.0",
     *      "uniVer": "4.23",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1059 1060 1061 1062 1063 1064 1065 1066 1067
   * 	},
   *   "web": {
   *     "uniVer": "x",
   *     "unixVer": "x"
   *   }
   * }
   */
  osTheme?: 'light' | 'dark' | null,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1068 1069
   * 设备像素比
   * @deprecated 已废弃,仅为了向下兼容保留
DCloud-yyl's avatar
DCloud-yyl 已提交
1070
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1083 1084 1085 1086 1087 1088
   * 		},
     *    "harmony": {
     *      "osVer": "x",
     *      "uniVer": "x",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1089 1090 1091 1092 1093 1094 1095 1096 1097
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  pixelRatio: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1098 1099
   * 客户端平台
   * @deprecated 已废弃,仅为了向下兼容保留
DCloud-yyl's avatar
DCloud-yyl 已提交
1100
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1113 1114 1115 1116 1117 1118
   * 		},
     *    "harmony": {
     *      "osVer": "x",
     *      "uniVer": "x",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1119 1120 1121 1122 1123 1124 1125
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
DCloud-yyl's avatar
DCloud-yyl 已提交
1126
  platform: 'ios' | 'android' | 'harmonyos' | 'mac' | 'windows' | 'linux',
DCloud-yyl's avatar
DCloud-yyl 已提交
1127
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1128
   * 屏幕宽度,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1129
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1142 1143 1144 1145 1146 1147
   * 		},
     *    "harmony": {
     *      "osVer": "3.0",
     *      "uniVer": "4.23",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1148 1149 1150 1151 1152 1153 1154 1155 1156
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  screenWidth: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1157
   * 屏幕高度,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1158
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1171 1172 1173 1174 1175 1176
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1177 1178 1179 1180 1181 1182 1183 1184 1185
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  screenHeight: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1186
   * 状态栏的高度,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1187
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1200 1201 1202 1203 1204 1205
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1206 1207 1208 1209 1210 1211 1212 1213 1214
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  statusBarHeight: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1215 1216
   * 操作系统版本
   * @deprecated 已废弃,仅为了向下兼容保留
DCloud-yyl's avatar
DCloud-yyl 已提交
1217
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1230 1231 1232 1233 1234 1235
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1236 1237 1238 1239 1240 1241 1242 1243 1244
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  system: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1245
   * 在竖屏正方向下的安全区域
DCloud-yyl's avatar
DCloud-yyl 已提交
1246
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1259 1260 1261 1262 1263 1264
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1265 1266 1267 1268 1269 1270 1271 1272 1273
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  safeArea: SafeArea,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1274
   * 在竖屏正方向下的安全区域插入位置
DCloud-yyl's avatar
DCloud-yyl 已提交
1275
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1288 1289 1290 1291 1292 1293
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1294 1295 1296 1297 1298 1299 1300 1301 1302
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  safeAreaInsets: SafeAreaInsets,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1303
   * 用户标识。小程序端为空
DCloud-yyl's avatar
DCloud-yyl 已提交
1304
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1317 1318 1319 1320 1321 1322
   * 		},
     *    "harmony": {
     *      "osVer": "x",
     *      "uniVer": "x",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  ua: string,
  /**
   * uni 编译器版本。
DCloud-yyl's avatar
DCloud-yyl 已提交
1333
   * @deprecated 已废弃,仅为了向下兼容保留
DCloud-yyl's avatar
DCloud-yyl 已提交
1334
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1347 1348 1349 1350 1351 1352
   * 		},
     *    "harmony": {
     *      "osVer": "x",
     *      "uniVer": "x",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1353 1354 1355 1356 1357 1358 1359 1360 1361
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  uniCompileVersion: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1362
   * uni 编译器版本。
DCloud-yyl's avatar
DCloud-yyl 已提交
1363
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "x",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "x",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1376 1377 1378 1379 1380 1381
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1382 1383 1384 1385 1386 1387 1388 1389 1390
   * 	},
   *   "web": {
   *     "uniVer": "x",
   *     "unixVer": "4.18"
   *   }
   * }
   */
  uniCompilerVersion: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1391
   * uni-app 运行平台,与条件编译平台相同。
DCloud-yyl's avatar
DCloud-yyl 已提交
1392
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1405 1406 1407 1408 1409 1410
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1411 1412 1413 1414 1415 1416 1417 1418 1419
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  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',
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1420
   * uni 运行时版本。
DCloud-yyl's avatar
DCloud-yyl 已提交
1421
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1434 1435 1436 1437 1438 1439
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  uniRuntimeVersion: string,
  /**
   * uni 编译器版本号。
DCloud-yyl's avatar
DCloud-yyl 已提交
1450
   * @deprecated 已废弃,仅为了向下兼容保留
DCloud-yyl's avatar
DCloud-yyl 已提交
1451
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "x",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "x",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1464 1465 1466 1467 1468 1469
   * 		},
     *    "harmony": {
     *      "osVer": "x",
     *      "uniVer": "x",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1470 1471 1472 1473 1474 1475 1476 1477 1478
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  uniCompileVersionCode: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1479
   * uni 编译器版本号。
DCloud-yyl's avatar
DCloud-yyl 已提交
1480
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "x",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "x",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1493 1494 1495 1496 1497 1498
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1499 1500 1501 1502 1503 1504 1505 1506 1507
   * 	},
   *   "web": {
   *     "uniVer": "x",
   *     "unixVer": "4.18"
   *   }
   * }
   */
  uniCompilerVersionCode: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1508
   * uni 运行时版本号。
DCloud-yyl's avatar
DCloud-yyl 已提交
1509
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "x",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "x",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1522 1523 1524 1525 1526 1527
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1528 1529 1530 1531 1532 1533 1534 1535 1536 1537
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  uniRuntimeVersionCode: number,
  /**
   * 引擎版本号。
DCloud-yyl's avatar
DCloud-yyl 已提交
1538
   * @deprecated 已废弃,仅为了向下兼容保留
DCloud-yyl's avatar
DCloud-yyl 已提交
1539
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1552 1553 1554 1555 1556 1557
   * 		},
     *    "harmony": {
     *      "osVer": "x",
     *      "uniVer": "x",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1558 1559 1560 1561 1562 1563 1564 1565 1566
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  version: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1567
   * rom 名称。Android 部分机型获取不到值。iOS 恒为 `ios`
DCloud-yyl's avatar
DCloud-yyl 已提交
1568
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "x",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1581 1582 1583 1584 1585 1586
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1587 1588 1589 1590 1591 1592 1593 1594 1595
   * 	},
   *   "web": {
   *     "uniVer": "x",
   *     "unixVer": "x"
   *   }
   * }
   */
  romName: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1596
   * rom 版本号。Android 部分机型获取不到值。iOS 为操作系统版本号(同 `osVersion`)。
DCloud-yyl's avatar
DCloud-yyl 已提交
1597
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "x",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1610 1611 1612 1613 1614 1615
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1616 1617 1618 1619 1620 1621 1622 1623 1624
   * 	},
   *   "web": {
   *     "uniVer": "x",
   *     "unixVer": "x"
   *   }
   * }
   */
  romVersion: string,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1625
   * 可使用窗口宽度,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1626
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1639 1640 1641 1642 1643 1644
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1645 1646 1647 1648 1649 1650 1651 1652 1653
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  windowWidth: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1654
   * 可使用窗口高度,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1655
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1668 1669 1670 1671 1672 1673
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1674 1675 1676 1677 1678 1679 1680 1681 1682
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  windowHeight: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1683
   * 内容区域距离顶部的距离(同CSS变量 `--window-top`),单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1684
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1697 1698 1699 1700 1701 1702
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1703 1704 1705 1706 1707 1708 1709 1710 1711
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  windowTop: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1712
   * 内容区域距离底部的距离(同CSS变量 `--window-bottom`),单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1713
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1726 1727 1728 1729 1730 1731
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1732 1733 1734 1735 1736 1737 1738 1739 1740 1741
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  windowBottom: number,
  /**
   * Android 系统API库的版本。
DCloud-yyl's avatar
DCloud-yyl 已提交
1742
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "√"
   * 		},
   * 		"ios": {
   * 			"osVer": "x",
   * 			"uniVer": "x",
   * 			"unixVer": "x"
DCloud-yyl's avatar
DCloud-yyl 已提交
1755 1756 1757 1758 1759 1760
   * 		},
     *    "harmony": {
     *      "osVer": "x",
     *      "uniVer": "x",
     *      "unixVer": "x"
     *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1761 1762 1763 1764 1765 1766 1767 1768 1769 1770
   * 	},
   *   "web": {
   *     "uniVer": "x",
   *     "unixVer": "x"
   *   }
   * }
   */
  osAndroidAPILevel?: number | null,
  /**
   * 当前App的主题
DCloud-yyl's avatar
DCloud-yyl 已提交
1771
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "x",
   * 			"unixVer": "4.18"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "x",
   * 			"unixVer": "4.18"
DCloud-yyl's avatar
DCloud-yyl 已提交
1784 1785 1786 1787 1788 1789
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823
   * 	},
   *   "web": {
   *     "uniVer": "x",
   *     "unixVer": "x"
   *   }
   * }
   */
  appTheme?: 'light' | 'dark' | 'auto' | null,
};
export type GetSystemInfoSuccessCallback = (result: GetSystemInfoResult) => void;
type GetSystemInfoFail = UniError;
type GetSystemInfoFailCallback = (result: GetSystemInfoFail) => void;
export type GetSystemInfoComplete = any;
export type GetSystemInfoCompleteCallback = (result: GetSystemInfoComplete) => void;
export type GetSystemInfoOptions = {
  /**
   * 接口调用成功的回调函数
   * @defaultValue null
   */
  success?: GetSystemInfoSuccessCallback | null,
  /**
   * 接口调用失败的回调函数
   * @defaultValue null
   */
  fail?: GetSystemInfoFailCallback | null,
  /**
   * 接口调用结束的回调函数(调用成功、失败都会执行)
   * @defaultValue null
   */
  complete?: GetSystemInfoCompleteCallback | null
};

export type GetWindowInfoResult = {
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1824
   * 设备像素比
DCloud-yyl's avatar
DCloud-yyl 已提交
1825
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1838 1839 1840 1841 1842 1843
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1844 1845 1846 1847 1848 1849 1850 1851 1852
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  pixelRatio: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1853
   * 屏幕宽度,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1854
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1867 1868 1869 1870 1871 1872
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1873 1874 1875 1876 1877 1878 1879 1880 1881
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  screenWidth: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1882
   * 屏幕高度,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1883
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1896 1897 1898 1899 1900 1901
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1902 1903 1904 1905 1906 1907 1908 1909 1910
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  screenHeight: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1911
   * 可使用窗口宽度,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1912
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1925 1926 1927 1928 1929 1930
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1931 1932 1933 1934 1935 1936 1937 1938 1939
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  windowWidth: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1940
   * 可使用窗口高度,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1941
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1954 1955 1956 1957 1958 1959
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1960
   * 	}
DCloud-yyl's avatar
DCloud-yyl 已提交
1961 1962 1963 1964
   * }
   */
  windowHeight: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1965
   * 状态栏的高度,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1966
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
1979 1980 1981 1982 1983 1984
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
1985 1986 1987 1988 1989 1990 1991 1992 1993
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  statusBarHeight: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
1994
   * 内容区域距离顶部的距离(同CSS变量 `--window-top`),单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
1995
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
2008 2009 2010 2011 2012 2013
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
2014 2015 2016 2017 2018 2019 2020 2021 2022
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  windowTop: number,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
2023
   * 内容区域距离底部的距离(同CSS变量 `--window-bottom`),单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
2024
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
2037 2038 2039 2040 2041 2042
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
2043 2044 2045 2046 2047 2048 2049 2050 2051 2052
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  windowBottom: number,
  /**
   * 安全区域在屏幕中的位置信息
DCloud-yyl's avatar
DCloud-yyl 已提交
2053
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
2066 2067 2068 2069 2070 2071
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
2072 2073 2074 2075 2076 2077 2078 2079 2080 2081
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  safeArea: SafeArea,
  /**
   * 安全区域插入位置(与屏幕边界的距离)信息
DCloud-yyl's avatar
DCloud-yyl 已提交
2082
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094
   * @uniPlatform
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
2095 2096 2097 2098 2099 2100
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
2101 2102 2103 2104 2105 2106 2107 2108 2109
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  safeAreaInsets: SafeAreaInsets,
  /**
DCloud-yyl's avatar
DCloud-yyl 已提交
2110
   * 窗口上边缘的 y 值,单位为px
DCloud-yyl's avatar
DCloud-yyl 已提交
2111
   *
DCloud-yyl's avatar
DCloud-yyl 已提交
2112
   * @uniPlatform
DCloud-yyl's avatar
DCloud-yyl 已提交
2113
   * @deprecated 已废弃,仅为了向下兼容保留
DCloud-yyl's avatar
DCloud-yyl 已提交
2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124
   * {
   * 	"app": {
   * 		"android": {
   * 			"osVer": "5.0",
   * 			"uniVer": "√",
   * 			"unixVer": "3.9+"
   * 		},
   * 		"ios": {
   * 			"osVer": "12.0",
   * 			"uniVer": "√",
   * 			"unixVer": "4.11"
DCloud-yyl's avatar
DCloud-yyl 已提交
2125 2126 2127 2128 2129 2130
   * 		},
   *    "harmony": {
   *      "osVer": "3.0",
   *      "uniVer": "4.23",
   *      "unixVer": "x"
   *    }
DCloud-yyl's avatar
DCloud-yyl 已提交
2131 2132 2133 2134 2135 2136 2137 2138 2139
   * 	},
   *   "web": {
   *     "uniVer": "√",
   *     "unixVer": "4.0"
   *   }
   * }
   */
  screenTop: number
};