API

更新时间：2023-02-09 15:34:02

快手小程序给开发者提供了丰富的 API，方便开发者调起原生方法，具体见 API 文档。

事件监听 API

以 on 开头的 API 用来监听某个事件是否触发。

例如：ks.onAppShow ks.onAppHide

同步 API

以 Sync 结尾的 API 都是同步 API。

例如：ks.getSystemInfoSync ks.setStorageSync

异步 API

其余大多数 API 都是异步 API。
例如：ks.request、ks.downloadFile这类 API 接口通常都接受一个 Object 类型的参数，这个参数都支持按需指定以下字段来接收接口调用结果：

Object 参数说明

参数名	类型	必填	说明
success	function	否	接口调用成功的回调函数
fail	function	否	接口调用失败的回调函数
complete	function	否	接口调用结束的回调函数（调用成功、失败都会执行）
其他	Any		接口定义的其他参数

回调函数的参数

success，fail，complete 函数调用时会传入一个 Object 类型参数，包含以下字段：

属性	类型	说明
errMsg	string	错误信息，如果调用成功返回 ${apiName}:ok
errCode	number	错误码，仅部分 API 支持，具体含义请参考对应 API 文档，成功时为 0。
其他	Any	接口返回的其他数据

代码示例

ks.login({
  success(res) {
    console.log(res.code)
  }
})

// callback 形式调用
ks.chooseImage({
  success(res) {
    console.log('res:', res)
  }
})

// promise 形式调用
ks.chooseImage().then(res => console.log('res: ', res))