标准对象输入
定义 API 的标准输入内容。 绝大多数 API 为异步调用,调用的结果通过预先定义好的三个 callback 方法返回
success (res)
当 API 成功执行后调用,传入参数res为object类型,基础属性包括:
名称 | 数据类型 | 描述 |
---|---|---|
errMsg | string | 预定义返回消息格式为${API_NAME}:ok |
API 执行的返回结果会扩展 res 的属性,具体参见各 API 详细说明。
fail (res)
当 API 执行失败后调用,传入参数res为object类型,基础属性包括:
名称 | 数据类型 | 描述 |
---|---|---|
errMsg | string | 预定义返回消息格式为${API_NAME}:fail |
API 执行的返回结果会扩展 res 的属性,具体参见各 API 详细说明。
complete (res)
当 API 执行完成(无论成功或者失败)后调用,传入参数res为object类型,基础属性包括:
名称 | 数据类型 | 描述 |
---|---|---|
errMsg | string | 与success 或fail 的值相同 |
API 执行的返回结果会扩展 res 的属性,具体参见各 API 详细说明。
提示complete回调的执行发生在success和fail之后。
代码示例
var someSwitch = "on";
Page({
oneFunc() {
if (someSwitch === "on") {
someSwitch = "off";
tt.someAPI({
someattr: somevalue,
success(res) {
console.log(res.someattr);
},
fail(res) {
console.log(`run fail`);
},
complete(res) {
console.log(`run done`);
someSwitch = "on";
}
});
}
}
});