# 接口概述
# 通用规则
# 同步
同步方法调用后必须等到方法结果返回后才能继续后续的行为,返回值可以是任意类型。
示例:
var info = app.getInfo();
console.log(JSON.stringify(info));
# 异步
异步方法调用整个过程不会阻碍调用者的工作。业务执行完成后会调用开发者提供的回调函数。
- 异步接口支持的回调函数
回调函数 | 参数名 | 类型 | 返回值 | 说明 |
---|---|---|---|---|
success | data | any | 可选,返回值可以是任意类型,详见接口使用文档。 | 在执行成功时触发。 |
fail | data code | any number | 错误信息内容,一般是字符串,也可能是其他类型,详见接口使用文档。 错误代码 | 在执行失败时触发。 |
cancel | data | any | 一般无内容,详见接口使用文档。 | 在用户取消时触发。部分用户交互场景可能有对该回调接口的支持。 |
complete | - | - | - | 在执行完成时触发。 |
说明:
- success、fail、cancel和complete四个回调函数是否支持参考具体接口描述
- success、fail和cancel三个回调函数的触发是互斥的,即会且只会在一个回调函数中触发,触发任意一个都会再次调用complete回调。
示例:
battery.getStatus({
success: function(data) {
console.log('success get battery level:' + data.level);
},
fail: function(data, code) {
console.log('fail to get battery level code:' + code);
},
});
# 通用错误码
其中,错误码200 为系统通用错误码,所有系统未知异常发生时抛出。比如框架申请内存空间失败等。
代码 | 含义 |
---|---|
200 | 一般性错误 |
201 | 用户拒绝 |
202 | 参数非法 |
203 | 服务不可用 |
204 | 请求超时 |