From b6ee9d39cb44c9cd16293885c0e811a9c27de333 Mon Sep 17 00:00:00 2001 From: DCloud_LXH <283700113@qq.com> Date: Sat, 28 May 2022 14:42:46 +0800 Subject: [PATCH] =?UTF-8?q?update:=20systemInfo=E3=80=81getAppBaseInfo?= =?UTF-8?q?=E3=80=81getDeviceInfo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/system/getAppBaseInfo.md | 18 ++++++++++---- docs/api/system/getDeviceInfo.md | 22 ++++++++++++----- docs/api/system/info.md | 40 +++++++++++++++++++++++++++---- 3 files changed, 66 insertions(+), 14 deletions(-) diff --git a/docs/api/system/getAppBaseInfo.md b/docs/api/system/getAppBaseInfo.md index 0b567935c..3291539e9 100644 --- a/docs/api/system/getAppBaseInfo.md +++ b/docs/api/system/getAppBaseInfo.md @@ -15,16 +15,26 @@ |appVersion|string|`manifest.json` 中应用版本名称。|| |appVersionCode|string|`manifest.json` 中应用版本名号。|| |appLanguage|string|应用设置的语言`en`、`zh-Hans`、`zh-Hant`、`fr`、`es`|`App`、`H5`| -|language|string|宿主、浏览器设置的语言、微信设置的语言|`App 仅 UNIMPSDK 支持`| |hostLanguage|string|浏览器语言、小程序宿主语言|`App 仅 UNIMPSDK 支持`| |hostVersion|string|App、小程序宿主版本。如：微信版本号。Web 端为浏览器版本|`App 仅 UNIMPSDK 支持`| -|hostName|string|浏览器名称、小程序宿主名称|`App 仅 UNIMPSDK 支持`、`H5`| +|hostName|string|浏览器名称、小程序宿主名称|`App 仅 UNIMPSDK 支持`| |hostPackageName|string|小程序宿主包名|`仅 UNIMPSDK 支持`| |hostFontSizeSetting|string|用户字体大小设置。以“我-设置-通用-字体大小”中的设置为准，单位：px|`仅 UNIMPSDK 支持`| + +小程序特殊的返回参数 + +|参数名|类型|说明|平台差异说明| +|:-|:-|:-|:-| |hostSDKVersion|string|客户端基础库版本|`仅微信小程序`| |hostTheme|string|系统当前主题，取值为light或dark，全局配置"darkmode":true时才能获取，否则为 undefined （不支持小游戏）|`仅微信小程序`| |SDKVersion|string|客户端基础库版本|`仅微信小程序`| |enableDebug|boolean|是否已打开调试。可通过右上角菜单或 wx.setEnableDebug 打开调试|`仅微信小程序`| |host|Object|当前小程序运行的宿主环境|`仅微信小程序`| -|version|string|引擎版本号、微信版本号|| -|theme|string|系统当前主题，取值为light或dark，全局配置"darkmode":true时才能获取，否则为 undefined （不支持小游戏）|`仅微信小程序`| \ No newline at end of file +|theme|string|系统当前主题，取值为light或dark，全局配置"darkmode":true时才能获取，否则为 undefined （不支持小游戏）|`仅微信小程序`| + +不推荐使用的返回参数，仅为向下兼容保留 + +|参数名|类型|说明|平台差异说明| +|:-|:-|:-|:-| +|language|string|宿主、浏览器设置的语言、微信设置的语言|`App 仅 UNIMPSDK 支持`| +|version|string|引擎版本号、微信版本号|| \ No newline at end of file diff --git a/docs/api/system/getDeviceInfo.md b/docs/api/system/getDeviceInfo.md index d671c2048..375b9ef57 100644 --- a/docs/api/system/getDeviceInfo.md +++ b/docs/api/system/getDeviceInfo.md @@ -14,11 +14,21 @@ |deviceId|string|设备 id 。由 uni-app 框架生成并存储，清空 Storage 会导致改变|| |deviceModel|string|设备型号|| |deviceType|string|设备类型`phone`、`pad`、`pc`|| -|brand|string|设备品牌|| -|model|string|设备型号。新机型刚推出一段时间会显示unknown，微信会尽快进行适配。|| +|deviceOrientation|string|设备方向 `竖屏 portrait`、`横屏 landscape`|`App、H5`。微信小程序请使用 `(getSystemInfo Api)[/api/system/info.html]` 获取| +|devicePixelRatio|string|设备像素比|`App、H5`。微信小程序请使用 `(getSystemInfo Api)[/api/system/info.html]` 获取| |system|string|操作系统及版本|| -|platform|string|客户端平台|| -|deviceOrientation|string|设备方向 `竖屏 portrait`、`横屏 landscape`|`App、H5`| -|devicePixelRatio|string|设备像素比|`App、H5`| +|platform|客户端平台|| + +小程序特殊的返回参数 + +|参数名|类型|说明|平台差异说明| +|:-|:-|:-|:-| |abi |String|应用二进制接口类型（仅 Android 支持）|`仅微信小程序`| -|benchmarkLevel|Number|设备性能等级（仅 Android 支持）。取值为：-2 或 0（该设备无法运行小游戏），-1（性能未知），>=1（设备性能值，该值越高，设备性能越好，目前最高不到50）|`仅微信小程序`| \ No newline at end of file +|benchmarkLevel|Number|设备性能等级（仅 Android 支持）。取值为：-2 或 0（该设备无法运行小游戏），-1（性能未知），>=1（设备性能值，该值越高，设备性能越好，目前最高不到50）|`仅微信小程序`| + +不推荐使用的返回参数，仅为向下兼容保留 + +|参数名|类型|说明|平台差异说明| +|:-|:-|:-|:-| +|brand|string|设备品牌|| +|model|string|设备型号。新机型刚推出一段时间会显示unknown，微信会尽快进行适配。|| \ No newline at end of file diff --git a/docs/api/system/info.md b/docs/api/system/info.md index 709129166..145661639 100644 --- a/docs/api/system/info.md +++ b/docs/api/system/info.md @@ -39,14 +39,14 @@ uni-app提供了同步(`uni.getSystemInfo`)和异步(`uni.getSystemInfoSync`)的 | |osTheme |操作系统主题。 |light、dark|不支持 |不支持 | |`uni-app (3.4.10+)` |browser |browserName |浏览器名称或App平台系统webview名称|系统 webview 名称，wkwebview、chrome |chrome、edge、safari、firefox |不支持||`uni-app (3.4.10+)`| | |browseVersion |浏览器版本、webview 版本| | |不支持 | |`uni-app (3.4.10+)`| -|host |hostName |App、小程序宿主名称，如：`WeChat`、`FeiShu`。Web 端为浏览器名称 |仅UniMPSDK 支持 |浏览器名称|宿主应用名称|微信小程序真机运行才有真值|`uni-app (3.4.10+)` | +|host |hostName |App、小程序宿主名称，如：`WeChat`、`FeiShu`。Web 端为浏览器名称 |仅UniMPSDK 支持 |浏览器名称|[取值如下](#hostname)|微信小程序真机运行才有真值|`uni-app (3.4.10+)` | | |hostVersion |App、小程序宿主版本。如：微信版本号。Web 端为浏览器版本|仅UniMPSDK 支持 |浏览器版本|小程序宿主版本| |`uni-app (3.4.10+)` | | |hostLanguage |浏览器语言、小程序宿主语言、app 语言|仅UniMPSDK 支持 |与浏览器语言一致|小程序宿主语言| |`uni-app (3.4.10+)` | | |hostTheme |App 主题 `light`、`dark`。小程序端为系统当前主题|仅UniMPSDK 支持 |不支持|`light`、`dark`|仅微信小程序全局配置"darkmode":true时才能获取|`uni-app (3.4.10+)` | | |hostPackageName |小程序宿主包名。仅 App 支持|仅UniMPSDK 支持 |不支持|不支持| |`uni-app (3.4.10+)`| | |hostSDKVersion |客户端基础库版本|仅UniMPSDK 支持 |不支持|| |`uni-app (3.4.13+)`| | |hostFontSizeSetting |用户字体大小设置。以“我-设置-通用-字体大小”中的设置为准，单位：px|不支持|不支持||微信小程序、支付宝小程序、百度小程序、QQ小程序、字节小程序(2.53.0+)|`uni-app (3.4.13+)`| -|uni-app框架 |uniPlatform |uni-app 运行平台。取值见下。|-|-|-| |`uni-app (3.4.10+)`| +|uni-app框架 |uniPlatform |uni-app 运行平台。[取值见下](#uniplatform) |-|-|-| |`uni-app (3.4.10+)`| | |uniCompileVersion |uni 编译器版本号|`3.4.10`、`3.2.9` 等|`3.4.10`、`3.2.9` 等|`3.4.10`、`3.2.9` 等| |`uni-app (3.4.10+)`| | |uniRuntimeVersion |uni 运行时版本|`3.4.10`、`3.2.9` 等|`3.4.10`、`3.2.9` 等|`3.4.10`、`3.2.9` 等| |`uni-app (3.4.10+)`| |app |appId |`manifest.json` 中应用appid，即DCloud appid。 | | | | |`uni-app (3.4.10+)`| @@ -54,8 +54,8 @@ uni-app提供了同步(`uni.getSystemInfo`)和异步(`uni.getSystemInfoSync`)的 | |appVersion |`manifest.json` 中应用版本名称。 | | | | |`uni-app (3.4.10+)`| | |appVersionCode |`manifest.json` 中应用版本名号。 | | | | |`uni-app (3.4.10+)`| | |appLanguage |应用设置的语言|`en`、`zh-Hans`、`zh-Hant`、`fr`、`es`|`en`、`zh-Hans`、`zh-Hant`、`fr`、`es`|不支持||`uni-app (3.4.13+)`| -|rom |romName |rom 名称|Android 部分机型获取不到值。iOS 恒为 `ios`|不支持|不支持| |`uni-app (3.4.13+)` | -| |romVersion |rom 版本|Android 部分机型获取不到值。iOS 恒为 `ios 版本号`|不支持|不支持| |`uni-app (3.4.13+)` | +|rom |romName |rom 名称|Android 部分机型获取不到值，[取值如下](#romname)。iOS 恒为 `ios`|不支持|不支持| |`uni-app (3.4.13+)` | +| |romVersion |rom 版本|Android 部分机型获取不到值，[取值如下](#romname)。iOS 恒为 `ios 版本号`|不支持|不支持| |`uni-app (3.4.13+)` | |其他 |ua | userAgent标识 | | |不支持 | |`uni-app (3.4.10+)` | | |screenWidth |屏幕宽度| | | | | | | |screenHeight |屏幕高度 | | | | | | @@ -135,6 +135,7 @@ uni-app提供了同步(`uni.getSystemInfo`)和异步(`uni.getSystemInfoSync`)的 |top |Number |安全区顶部插入位置 | |bottom |Number |安全区域底部插入位置 | + uniPlatform **可取值如下：** |值|生效条件| @@ -154,6 +155,37 @@ uni-app提供了同步(`uni.getSystemInfo`)和异步(`uni.getSystemInfoSync`)的 |quickapp-webview-union|快应用联盟| |quickapp-webview-huawei|快应用华为| + + hostName **可取值如下：** + +|值|生效条件| +|:-|:-| +|qq|QQ| +|WeChat|微信| +|wxwork|微信企业版| +|[百度宿主平台枚举值列表](https://smartprogram.baidu.com/docs/develop/api/device_sys/hostlist/)|百度| +|alipay|支付宝| +|amap|高德| +|DINGTALK|钉钉| +|UC|UC浏览器| +|QUARK|夸克浏览器| +|AK|阿里健康| +|YK|优酷| +|[字节宿主平台枚举值列表](https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/api/device/system-information/tt-get-system-info/#appname-%E8%AF%B4%E6%98%8E)|字节跳动系列| +|KUAISHOU|快手| + + + romName **可取值如下：** + +|值|生效条件| +|:-|:-| +|MIUI|小米| +|EMUI、HarmonyOS|华为| +|Magic OS|荣耀| +|FLymeOS|魅族| +|SmartisanOS|锤子| +|ColorOS|oppo| +|Funtouch OS|vivo| **示例** -- GitLab