字节跳动小程序开发API 标准对象输入
2019-08-12 16:11 更新
定义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';
}
});
}
}
});
以上内容是否对您有帮助:
更多建议: