Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
程序yang
unidocs-zh
提交
dce33736
U
unidocs-zh
项目概览
程序yang
/
unidocs-zh
与 Fork 源项目一致
Fork自
DCloud / unidocs-zh
通知
1
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
dce33736
编写于
8月 22, 2022
作者:
雪洛
浏览文件
操作
浏览文件
下载
差异文件
Merge branch 'intercept-object' into next
上级
5221d932
e0ef9ddb
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
56 addition
and
6 deletion
+56
-6
docs/uniCloud/client-sdk.md
docs/uniCloud/client-sdk.md
+56
-6
未找到文件。
docs/uniCloud/client-sdk.md
浏览文件 @
dce33736
...
...
@@ -19,6 +19,7 @@ uniCloud分为客户端和云端两部分,有些接口名称相同,参数也
|uniCloud.init() |同时使用多个服务空间时初始化额外服务空间
[
详情
](
init.md
)
|
|uniCloud.addInterceptor() |新增拦截器
[
详情
](
#add-interceptor
)
|
|uniCloud.removeInterceptor() |移除拦截器
[
详情
](
#remove-interceptor
)
|
|uniCloud.interceptObject() |拦截云对象请求
[
详情
](
#intercept-object
)
|
|uniCloud.onResponse() |监听服务端(云函数、云对象、clientDB)响应
[
详情
](
#on-response
)
|
|uniCloud.offResponse() |移除监听服务端(云函数、云对象、clientDB)响应
[
详情
](
#off-response
)
|
|uniCloud.onNeedLogin() |监听需要登录事件
[
详情
](
#on-need-login
)
|
...
...
@@ -71,7 +72,7 @@ console.log(uniCloud.getCurrentUserInfo().role.indexOf('admin')>-1); // 如果
> 新增于HBuilderX 3.1.20
接口形式:
`uniCloud.addInterceptor(String apiName, Object interceptor
Map
)`
接口形式:
`uniCloud.addInterceptor(String apiName, Object interceptor)`
**平台兼容性**
...
...
@@ -85,9 +86,9 @@ console.log(uniCloud.getCurrentUserInfo().role.indexOf('admin')>-1); // 如果
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| apiName | string| 是 | 要拦截的Api名称,可选值:callFunction、database、uploadFile |
| interceptor
Map
| object| 是 | 要添加的拦截器 |
| interceptor| object| 是 | 要添加的拦截器 |
**interceptor
Map
参数说明**
**interceptor参数说明**
|参数名 |类型 |必填 |默认值 |说明 |平台差异说明 |
|--- |--- |--- |--- |--- |--- |
...
...
@@ -120,16 +121,16 @@ uniCloud.addInterceptor('callFunction', {
> 新增于HBuilderX 3.1.20
接口形式:
`uniCloud.removeInterceptor(String apiName, Object interceptor
Map
)`
接口形式:
`uniCloud.removeInterceptor(String apiName, Object interceptor)`
**入参说明**
| 字段 | 类型 | 必填| 说明 |
| --- | --- | --- | --- |
| apiName | string| 是 | 要拦截的Api名称,可选值:callFunction、database、uploadFile |
| interceptor
Map
| object| 是 | 要移除的拦截器,选填,不传递此参数时移除此Api所有拦截器 |
| interceptor| object| 是 | 要移除的拦截器,选填,不传递此参数时移除此Api所有拦截器 |
**interceptor
Map
参数说明**
**interceptor参数说明**
|参数名 |类型 |必填 |默认值 |说明 |平台差异说明 |
|--- |--- |--- |--- |--- |--- |
...
...
@@ -167,6 +168,55 @@ uniCloud.removeInterceptor('callFunction', {
})
```
### 拦截云对象请求intercept-object
> 新增于HBuilderX 3.5.5
接口形式:
`uniCloud.interceptObject(Object interceptor)`
**interceptor参数说明**
|参数名 |类型 |必填 |默认值 |说明 |平台差异说明 |
|--- |--- |--- |--- |--- |--- |
|invoke |Function |否 | |拦截前触发 | |
|success |Function |否 | |成功回调拦截 | |
|fail |Function |否 | |失败回调拦截 | |
|complete |Function |否 | |完成回调拦截 | |
**invoke**
拦截器内将会收到以下形式的参数
```
js
{
objectName
:
""
,
// 云对象名称
methodName
:
""
,
// 云对象的方法名称
params
:
[]
// 参数列表
}
```
**success**
拦截器内将会收到以下形式的参数
```
js
{
objectName
:
""
,
// 云对象名称
methodName
:
""
,
// 云对象的方法名称
params
:
[],
// 参数列表
result
:
{}
// 云对象响应结果
}
```
**fail**
拦截器内将会收到以下形式的参数
```
js
{
objectName
:
""
,
// 云对象名称
methodName
:
""
,
// 云对象的方法名称
params
:
[],
// 参数列表
error
:
new
Error
()
// 错误对象
}
```
**complete**
拦截器内将会收到success或fail拦截器相同的参数,具体以云函数是否执行成功为准
### 监听云端响应@on-response
> 新增于HBuilderX 3.4.13
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录