Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
unidocs-zh
提交
958a2aa2
unidocs-zh
项目概览
DCloud
/
unidocs-zh
通知
3598
Star
108
Fork
921
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
120
列表
看板
标记
里程碑
合并请求
109
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
120
Issue
120
列表
看板
标记
里程碑
合并请求
109
合并请求
109
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
958a2aa2
编写于
5月 27, 2022
作者:
雪洛
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
docs: update uniCloud client sdk
上级
aac033c4
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
103 addition
and
2 deletion
+103
-2
docs/uniCloud/cf-functions.md
docs/uniCloud/cf-functions.md
+8
-2
docs/uniCloud/client-sdk.md
docs/uniCloud/client-sdk.md
+95
-0
未找到文件。
docs/uniCloud/cf-functions.md
浏览文件 @
958a2aa2
...
@@ -275,7 +275,9 @@ uniCloud服务器给客户端返回的数据格式是json,但json的格式具
...
@@ -275,7 +275,9 @@ uniCloud服务器给客户端返回的数据格式是json,但json的格式具
为此DCloud推出了
`uniCloud响应体规范`
。
为此DCloud推出了
`uniCloud响应体规范`
。
为尽可能的与uni-app前端的API错误回调风格接近,uniCloud响应体规范定义的云端返回信息内应包含
`errCode`
和
`errMsg`
,示例如下
为尽可能的与uni-app前端的API错误回调风格接近,uniCloud响应体规范定义的云端返回信息内应包含
`errCode`
和
`errMsg`
,除此之外响应体规范还包含
`newToken`
字段,用于下发新token给客户端(云对象接收含有newToken的响应后会自动更新storage内存储的uni_id_token及uni_id_token_expired,此行为新增于
`HBuilderX 3.4.13`
)。
示例如下:
```
js
```
js
// 失败返回值
// 失败返回值
...
@@ -288,7 +290,11 @@ uniCloud服务器给客户端返回的数据格式是json,但json的格式具
...
@@ -288,7 +290,11 @@ uniCloud服务器给客户端返回的数据格式是json,但json的格式具
{
{
errCode
:
0
,
errCode
:
0
,
errMsg
:
'
登录成功
'
,
errMsg
:
'
登录成功
'
,
uid
:
'
xxx
'
// 其他信息
uid
:
'
xxx
'
,
// 其他信息
newToken
:
{
// 用于下发新token给客户端
token
:
'
xxx
'
,
tokenExpired
:
'
xxx
'
}
}
}
```
```
...
...
docs/uniCloud/client-sdk.md
浏览文件 @
958a2aa2
...
@@ -16,6 +16,10 @@ uniCloud分为客户端和云端两部分,有些接口名称相同,参数也
...
@@ -16,6 +16,10 @@ uniCloud分为客户端和云端两部分,有些接口名称相同,参数也
|uniCloud.chooseAndUploadFile() |客户端选择文件并上传
[
详情
](
https://uniapp.dcloud.net.cn/uniCloud/storage?id=chooseanduploadfile
)
|
|uniCloud.chooseAndUploadFile() |客户端选择文件并上传
[
详情
](
https://uniapp.dcloud.net.cn/uniCloud/storage?id=chooseanduploadfile
)
|
|uniCloud.getCurrentUserInfo() |获取当前用户信息
[
详情
](
#client-getcurrentuserinfo
)
|
|uniCloud.getCurrentUserInfo() |获取当前用户信息
[
详情
](
#client-getcurrentuserinfo
)
|
|uniCloud.init() |同时使用多个服务空间时初始化额外服务空间
[
详情
](
https://uniapp.dcloud.net.cn/uniCloud/init
)
|
|uniCloud.init() |同时使用多个服务空间时初始化额外服务空间
[
详情
](
https://uniapp.dcloud.net.cn/uniCloud/init
)
|
|uniCloud.addInterceptor() |新增拦截器
[
详情
](
#add-interceptor
)
|
|uniCloud.removeInterceptor() |增加拦截器
[
详情
](
#remove-interceptor
)
|
|uniCloud.onResponse() |监听服务端(云函数、云对象、clientDB)响应
[
详情
](
#on-response
)
|
|uniCloud.offResponse() |监听服务端(云函数、云对象、clientDB)响应
[
详情
](
#off-response
)
|
### 获取当前用户信息getCurrentUserInfo@client-getcurrentuserinfo
### 获取当前用户信息getCurrentUserInfo@client-getcurrentuserinfo
...
@@ -156,6 +160,97 @@ uniCloud.removeInterceptor('callFunction', {
...
@@ -156,6 +160,97 @@ uniCloud.removeInterceptor('callFunction', {
})
})
```
```
### 监听云端响应@on-response
> 新增于HBuilderX 3.4.13
用于监听云函数、云对象、clientDB的请求响应
代码示例:
```
js
uniCloud
.
onResponse
(
function
(
event
)
{
// event格式见下方说明
})
```
**响应格式**
```
js
interface
OnResponseEvent
{
type
:
'
cloudobject
'
|
'
cloudfunctions
'
|
'
clientdb
'
,
content
:
{}
// content同云对象方法、云函数、clientDB请求的返回结果或错误对象
}
```
**以调用云对象方法为例**
```
js
uniCloud
.
onResponse
(
function
(
e
){
console
.
log
(
e
)
})
const
todo
=
uniCloud
.
importObject
(
'
todo
'
)
const
res
=
await
to
.
add
(
'
todo title
'
,
'
todo content
'
)
```
上述代码中打印的e格式如下
```
js
// 成功响应
e
=
{
type
:
'
cloudobject
'
,
content
:
{
// content内容和上方代码块中的res一致
errCode
:
0
}
}
// 失败响应
e
=
{
type
:
'
cloudobject
'
,
content
:
{
errCode
:
'
invalid-todo-title
'
,
errMsg
:
'
xxx
'
}
}
```
可以通过判断content内是否有真值的errCode判断是失败还是成功的响应
```
js
uniCloud
.
onResponse
(
function
(
e
){
if
(
e
.
content
.
errCode
)
{
console
.
log
(
'
请求出错
'
)
}
})
```
### 移除云端响应的监听@off-response
> 新增于HBuilderX 3.4.13
用于移除onResponse添加的监听器
**注意**
-
要移除的监听内方法需和添加的方法一致才可以移除,详情见下方示例
```
js
// 错误用法,无法移除监听
uniCloud
.
onResponse
(
function
(
e
)
{
console
.
log
(
e
)
})
uniCloud
.
offResponse
(
function
(
e
)
{
console
.
log
(
e
)
})
// 正确用法
function
logResponse
(
e
)
{
console
.
log
(
e
)
}
uniCloud
.
onResponse
(
logResponse
)
uniCloud
.
offResponse
(
logResponse
)
```
## 属性
## 属性
### 获取当前uniCloud实例的服务商
### 获取当前uniCloud实例的服务商
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录