API
收藏
我的收藏

小程序开发框架提供丰富的字节跳动宿主原生 API，可以方便地调起字节跳动宿主提供的能力，如获取系统信息等。详细介绍请参考 API 文档。

通常，小程序 API 有以下几种类型:

同步 API

同步 API 的执行结果可以通过函数返回值直接获取，如果执行出错会抛出异常。

try { 
  tt.createVideoContext("video");
} catch (e) {
  console.error(e);
}

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

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

异步 API 的执行结果需要通过 Object 类型的参数中传入的对应回调函数获取。部分异步 API 也会有返回值，可以用来实现更丰富的功能，如 tt.request 等。

const requestTask = tt.request({
  success(res) {
    console.log(res);
  },
});
requestTask.abort();