# 标准对象
定义 API 的标准输入、输出内容。绝大多数 API 为异步调用,调用的结果通过预先定义好的三个回调方法返回
# 输入
名称 | 数据类型 | 必填 | 默认值 | 描述 |
---|---|---|---|---|
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用完成的回调函数(成功或失败都会执行),该回调发生在 success 和 fail 之后 目前仅部分API 包含 complete 回调函数 |
# 输出
success
返回对象res
的基础属性:
名称 | 数据类型 | 描述 |
---|---|---|
errMsg | string | 错误信息,返回消息格式为${API_NAME}:ok 示例值:chooseContact:ok |
fail
返回对象res
的基础属性:
名称 | 数据类型 | 描述 |
---|---|---|
errCode | number | 错误码 示例值:1716201 错误码的覆盖范围正在逐步扩展中。 |
errMsg | string | 错误信息,返回消息格式为${API_NAME}:fail 示例值:chooseContact:fail |
complete
返回对象res
的基础属性:
名称 | 数据类型 | 描述 |
---|---|---|
errMsg | string | 错误信息,与 success 或 fail 返回对象的errMsg 值相同 |
提示
API 执行的返回结果会扩展success
、fail
、complete
返回对象的属性,具体参见各 API 详细说明。如chooseChat
# 示例代码
var someSwitch = 'on';
Page({
oneFunc () {
if (someSwitch === 'on') {
someSwitch = 'off';
bz.someAPI({
someattr: somevalue,
success (res) {
console.log(res.someattr);
},
fail (res) {
console.log(`run fail`);
},
complete (res) {
console.log(`run done`);
someSwitch = 'on';
}
});
}
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22