提交 cc0fca81 编写于 作者: 雪洛's avatar 雪洛

docs: 更新setCustomClientInfo Api说明

上级 9c6f7b5c
......@@ -654,6 +654,14 @@ uniCloud.getRequestList()
### 获取客户端信息列表@get-client-infos
> HBuilderX 4.21版本客户端上传clientInfo信息时不会将所有信息都传到云端。具体字段白名单如下:`'appId', 'appLanguage', 'appName', 'appVersion', 'appVersionCode', 'appWgtVersion',
'browserName', 'browserVersion',
'deviceBrand', 'deviceId', 'deviceModel', 'deviceType',
'osName', 'osVersion',
'romName', 'romVersion', 'ua',
'hostName', 'hostVersion',
'uniPlatform', 'uniRuntimeVersion', 'uniRuntimeVersionCode', 'uniCompilerVersion', 'uniCompilerVersionCode'`。如需让客户端上传更多clientInfo字段到云端,可以使用客户端api:[uniCloud.setCustomClientInfo](client-sdk.md#set-custom-client-info)
同理,考虑到单实例多并发,`uniCloud.getClientInfos()`获取客户端信息也是一个数组。
```js
......@@ -673,14 +681,6 @@ clientInfos = [{
**返回值**
> HBuilderX 4.21版本客户端上传clientInfo信息时不会将所有信息都传到云端。具体字段白名单如下:`'appId', 'appLanguage', 'appName', 'appVersion', 'appVersionCode', 'appWgtVersion',
'browserName', 'browserVersion',
'deviceBrand', 'deviceId', 'deviceModel', 'deviceType',
'osName', 'osVersion',
'romName', 'romVersion', 'ua',
'hostName', 'hostVersion',
'uniPlatform', 'uniRuntimeVersion', 'uniRuntimeVersionCode', 'uniCompilerVersion', 'uniCompilerVersionCode'`
getClientInfos返回的信息,是在客户端的[uni.getSystemInfo](https://uniapp.dcloud.net.cn/api/system/info#getsysteminfo)的基础之上,增加了一些额外的信息。
除了`getSystemInfo`返回字段外,还包含以下信息
......@@ -751,7 +751,6 @@ cloudInfos = [{
或者在云对象的this和云函数的context里获取相关上下文信息也可以。
## 扩展库@extension
uniCloud的api中,有些api对应的实现,其代码体积较大,且这些功能并不是每一个云函数都会使用。为了方便开发者控制云函数的体积,设计了`uniCloud扩展库`的概念。
......
......@@ -29,6 +29,7 @@ uniCloud分为客户端和云端两部分,有些接口名称相同,参数也
|uniCloud.offRefreshToken() |移除监听token更新事件 [详情](#off-refresh-token) |
|uniCloud.initSecureNetworkByWeixin() |在微信小程序安全网络请求发送之前与云函数握手 [详情](#init-secure-network-by-weixin) |
|uniCloud.getFileInfo() |阿里云迁移服务空间到商用版时,使用公测版云存储链接获取商用版云存储链接 [详情](./storage/dev.md#get-file-info) |
|uniCloud.setCustomClientInfo() |设置自定义clientInfo字段 [详情](#set-custom-client-info) |
### 获取当前用户信息getCurrentUserInfo@client-getcurrentuserinfo
......@@ -458,6 +459,20 @@ uniCloud.offRefreshToken(log)
- 发送安全网络请求前uniCloud客户端sdk会判断是否完成初始化,如未完成会等待完成后再发送安全网络请求。
- 需要确保安全网络请求在此方法调用后执行
### 设置自定义clientInfo字段@set-custom-client-info
> 新增于 4.21
用于设置自定义clientInfo字段,此字段会在云函数调用时传递给云函数。**设置的自定义clientInfo无法覆盖默认的clientInfo,只能为clientInfo新增字段,无法修改字段。**调用此接口后,所有的云函数、云对象、clientDB请求都会在clientInfo内携带此字段。
**示例**
```js
uniCloud.setCustomClientInfo({
customField: 'customValue'
})
```
## 属性
### 获取当前uniCloud实例的服务商
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册