diff --git a/docs/uniCloud/cf-functions.md b/docs/uniCloud/cf-functions.md index eb73cf1792b9f18bbd92ad86869ac1655722dcac..a7451e1952220073abb497b3b0e91ba7d09cd6b6 100644 --- a/docs/uniCloud/cf-functions.md +++ b/docs/uniCloud/cf-functions.md @@ -30,14 +30,18 @@ exports.main = async (event, context) => { let clientUA = context.CLIENTUA // 客户端user-agent ... //其它业务代码 } +``` + +>在云函数URL化的场景无法获取客户端平台信息，可以在调用依赖客户端平台的接口接口之前（推荐在云函数入口）通过修改context.PLATFORM手动传入客户端平台信息 + +例： + +```js +exports.main = async (event, context) => { + context.PLATFORM = 'app-plus' +} ``` -**关于CLIENTIP、CLIENTUA** - -- 通过管理端调用云函数（云函数上传并运行、腾讯云开发调试期间），使用腾讯云时想临时调试UA、IP等可以通过自行初始化`uniCloud`的方式（[同时连多服务空间](uniCloud/init.md) -）传入`debugFunction: false`来实现客户端直连调用，需要注意的是此时控制台将不会打印云函数日志。 - - 云函数中如果要使用其他服务（比如mysql数据库、redis等），可以按照nodejs的写法即可。但注意这些非uniCloud数据库和云函数运行环境不在一起，访问速度受影响。 **注意事项** @@ -52,10 +56,10 @@ exports.main = async (event, context) => { |-- |-- | |uniCloud.callFunction() |云函数中调用另一个云函数 [见下](uniCloud/cf-functions?id=callbyfunction) | |uniCloud.database() |云数据库对象 [详情](uniCloud/cf-database.md) | -|uniCloud.uploadFile() |云函数上传文件到云存储 [详情](uniCloud/storage?id=uploadfile) | +|uniCloud.uploadFile() |云函数上传文件到云存储 [详情](uniCloud/storage?id=clouduploadfile) | |uniCloud.downloadFile() |云函数下载云存储的文件到云函数运行环境 [详情](uniCloud/storage?id=clouddownloadfile) | -|uniCloud.deleteFile() |云函数删除云存储的文件 [详情](uniCloud/storage?id=deletefile) | -|uniCloud.getTempFileURL() |获取云存储文件的临时路径 [详情](uniCloud/storage?id=gettempfileurl) | +|uniCloud.deleteFile() |云函数删除云存储的文件 [详情](uniCloud/storage?id=clouddeletefile) | +|uniCloud.getTempFileURL() |获取云存储文件的临时路径 [详情](uniCloud/storage?id=cloudgettempfileurl) | |uniCloud.httpclient |云函数中通过http连接其他系统 [见下](uniCloud/cf-functions?id=httpclient) | |uniCloud.logger |云函数中打印日志到uniCloud日志记录系统（非HBuilderX控制台）[详情](uniCloud/cf-logger) | |uniCloud.sendSms() |发送短信 [详见](uniCloud/send-sms.md) | diff --git a/docs/uniCloud/http.md b/docs/uniCloud/http.md index 535a704213a067437edaeabc6d40ad3b5d784a6c..5e22750bf5dc95ab76921c9543d3a2f717af9c25 100644 --- a/docs/uniCloud/http.md +++ b/docs/uniCloud/http.md @@ -151,6 +151,16 @@ uni.request({ + 请求Body大小限制，不能超过1M。 + 响应Body大小限制，不能超过1M。 +>在云函数URL化的场景无法获取客户端平台信息，可以在调用依赖客户端平台的接口接口之前（推荐在云函数入口）通过修改context.PLATFORM手动传入客户端平台信息 + +例： + +```js +exports.main = async (event, context) => { + context.PLATFORM = 'app-plus' +} +``` + 云函数接收到的post请求的请求体可能是被转成base64的，如果是这样需要进行一次转化。 以接收application/json格式的post请求为例 diff --git a/docs/uniCloud/storage.md b/docs/uniCloud/storage.md index 41501681e5b00077868980d3c2407cf9ee2435d7..7c61f01be809c6b14d103d4c9c1d15fbfb30a07a 100644 --- a/docs/uniCloud/storage.md +++ b/docs/uniCloud/storage.md @@ -256,7 +256,7 @@ uniCloud.deleteFile( 在云函数中操作云存储文件（不是在前端），包括在云函数里上传、删除云存储文件。 -## uniCloud.uploadFile(Object uploadFileOptions) +## uniCloud.uploadFile(Object uploadFileOptions)@clouduploadfile **云函数**内上传文件至云存储。 @@ -297,7 +297,7 @@ let result = await uniCloud.uploadFile({ }); ``` -## uniCloud.getTempFileURL(Object getTempFileURLOptions) +## uniCloud.getTempFileURL(Object getTempFileURLOptions)@cloudgettempfileurl **云函数**获取文件下载链接。 @@ -344,7 +344,7 @@ let result = await uniCloud.getTempFileURL({ }); ``` -## uniCloud.deleteFile(Object deleteFileOptions) +## uniCloud.deleteFile(Object deleteFileOptions)@clouddeletefile **云函数**删除云存储文件。 @@ -382,7 +382,7 @@ let result = await uniCloud.deleteFile({ }); ``` -## uniCloud.downloadFile(Object downloadFileOptions) +## uniCloud.downloadFile(Object downloadFileOptions)@clouddownloadfile **云函数**下载已上传至云开发的文件至本地（默认本地根目录/root）。 diff --git a/docs/uniCloud/uni-id.md b/docs/uniCloud/uni-id.md index cf550b880939f5220da37f67c5174ac9e9b1998d..c97e00c9d634655597780530842c9194cc645353 100644 --- a/docs/uniCloud/uni-id.md +++ b/docs/uniCloud/uni-id.md @@ -100,6 +100,16 @@ DCloud暂无计划开发百度、头条、QQ等小程序的登录，以及Apple - **config.json是一个标准json文件，不支持注释** - 如果不希望使用config.json初始化而是想自行传入参数，可以使用`init`方法[uniID.init](/uniCloud/uni-id?id=init) + +>在云函数URL化的场景无法获取客户端平台信息，可以在调用uni-id相关接口之前（推荐在云函数入口）通过修改context.PLATFORM手动传入客户端平台信息 + +例： + +```js +exports.main = async (event, context) => { + context.PLATFORM = 'app-plus' +} +``` 配置项： @@ -114,7 +124,7 @@ DCloud暂无计划开发百度、头条、QQ等小程序的登录，以及Apple **下面的配置文件中所有时间的单位都是秒** -> ！！！重要！！！ passwordSecret与tokenSecret十分重要，切记妥善保存（不要直接使用下面示例中的passwordSecret与tokenSecret）。修改passwordSecret会导致老用户使用密码无法登陆，修改tokenSecret会导致所有已经下发的token失效。如果重新导入uni-id切勿直接覆盖config.json相关配置 +> ！！！重要！！！ passwordSecret与tokenSecret十分重要，切记妥善保存（不要直接使用下面示例中的passwordSecret与tokenSecret）。修改passwordSecret会导致老用户使用密码无法登陆，修改tokenSecret会导致所有已经下发的token失效。如果重新导入uni-id切勿直接覆盖config.json相关配置 ```json // 如果拷贝此内容切记去除注释 @@ -1291,7 +1301,6 @@ exports.main = async function(event,context) { | 字段 | 类型 | 必填| 说明 | | --- | --- | --- | --- | | code | String| 是 |微信登录返回的code | -| platform |String | 否 |客户端类型：`mp-weixin`、`app-plus`，默认uni-id会自动取客户端类型，但是在云函数url化等场景无法取到客户端类型，可以使用此参数指定 | | myInviteCode|String | 否 |设置当前注册用户自己的邀请码，type为`register`时生效 | | needPermission| Boolean | 否 |设置为true时会在checkToken时返回用户权限（permission），建议在管理控制台中使用 | @@ -1407,7 +1416,6 @@ export default { | 字段 | 类型 | 必填| 说明 | | --- | --- | --- | --- | | code | String| 是 |微信登录返回的code | -|platform |String |否 |客户端类型：`mp-weixin`、`app-plus`，默认uni-id会自动取客户端类型，但是在云函数url化等场景无法取到客户端类型，可以使用此参数指定 | **响应参数** @@ -1445,7 +1453,6 @@ exports.main = async function(event,context) { | --- | --- | --- | --- | | uid | String| 是 |用户Id，可以通过checkToken返回 | | code | String| 是 |微信登录返回的code | -|platform |String |否 |客户端类型：`mp-weixin`、`app-plus`，默认uni-id会自动取客户端类型，但是在云函数url化等场景无法取到客户端类型，可以使用此参数指定 | **响应参数** @@ -1516,7 +1523,6 @@ exports.main = async function(event,context) { | 字段 | 类型 | 必填| 说明 | | --- | --- | --- | --- | | code | String| 是 |支付宝登录返回的code | -| platform | String| 否 |客户端类型：`mp-weixin`、`app-plus`，默认uni-id会自动取客户端类型，但是在云函数url化等场景无法取到客户端类型，可以使用此参数指定 | | myInviteCode| String| 否 |设置当前注册用户自己的邀请码，type为`register`时生效 | | needPermission| Boolean | 否 |设置为true时会在checkToken时返回用户权限（permission），建议在管理控制台中使用 | @@ -1560,7 +1566,6 @@ exports.main = async function(event,context) { | 字段 | 类型 | 必填| 说明 | | --- | --- | --- | --- | | code | String| 是 |支付宝登录返回的code | -|platform |String |否 |客户端类型：`mp-weixin`、`app-plus`，默认uni-id会自动取客户端类型，但是在云函数url化等场景无法取到客户端类型，可以使用此参数指定 | **响应参数**