抖音小程式基礎之 目前提供哪些API（教程含原始碼）

小程式開發框架提供豐富的 位元組跳動宿主 原生 API，可以方便的調起 位元組跳動宿主 提供的能力，如獲取系統資訊等。詳細介紹請參考 API 文件。

通常，在小程式 API 有以下幾種型別:

• 同步 API
• 非同步 API

---

同步 API

同步 API 的執行結果可以通過函式返回值直接獲取，如果執行出錯會丟擲異常。

程式碼示例

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

非同步 API

大多數 API 都是非同步 API，如 tt.request，tt.showToast 等。這類 API 介面通常都接受一個 Object 型別的引數，這個引數都支援按需指定以下欄位來接收介面呼叫結果：

Object 引數說明

引數名	型別	必填	說明
success	function	否	介面呼叫成功的回撥函式
fail	function	否	介面呼叫失敗的回撥函式
complete	function	否	介面呼叫結束的回撥函式（呼叫成功、失敗都會執行）
其他	Any	-	介面定義的其他引數

回撥函式的引數

success，fail，complete 函式呼叫時會傳入一個 Object 型別引數，包含以下欄位：

屬性	型別	說明
errMsg	string	錯誤資訊，如果呼叫成功返回 ${apiName}:ok
errCode	number	錯誤碼，僅部分 API 支援，具體含義請參考對應 API 文件，成功時為 0。
其他	Any	介面返回的其他資料

非同步 API 的執行結果需要通過 Object 型別的引數中傳入的對應回撥函式獲取。部分非同步 API 也會有返回值，可以用來實現更豐富的功能，如 tt.request 等。

程式碼示例

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

系列文章

• 《原創 抖音小程式開發教程之 01 構建開發環境（教程含原始碼）》

---

未經授權禁止轉載

---

更多技術交流請加入QQ群

群名稱：抖音小程式開發
群 號：491016707