通常,在小程序 API 有以下几种类型:
我们约定,以 开头的 API 用来监听某个事件是否触发,如:,qq.onCompassChange
等。
这类 API 接受一个回调函数作为参数,当事件触发时会调用这个回调函数,并将相关数据以参数形式传入。
我们约定,以 Sync
结尾的 API 都是同步 API, 如 ,qq.getSystemInfoSync
等。此外,也有一些其他的同步 API,如 ,qq.getBackgroundAudioManager
等,详情参见 API 文档中的说明。
同步 API 的执行结果可以通过函数返回值直接获取,如果执行出错会抛出异常。
代码示例
Object 参数说明
回调函数的参数
success
,,complete
函数调用时会传入一个 Object
类型参数,包含以下字段:
属性 | 类型 | 说明 |
---|---|---|
errMsg | string | 错误信息,如果调用成功返回 ${apiName}:ok |
errCode | number | 错误码,仅部分 API 支持,具体含义请参考对应 API 文档,成功时为 0 。 |
其他 | Any | 接口返回的其他数据 |
代码示例