QQ小程序 API

小程序開發(fā)框架提供豐富的QQ原生 API，可以方便的調起QQ提供的能力，如獲取用戶信息，本地存儲，支付功能等。詳細介紹請參考 API 文檔。 通常，在小程序 API 有以下幾種類型：

事件監(jiān)聽 API

我們約定，以 on 開頭的 API 用來監(jiān)聽某個事件是否觸發(fā)，如：qq.onSocketOpen，qq.onCompassChange等。 這類 API 接受一個回調函數(shù)作為參數(shù)，當事件觸發(fā)時會調用這個回調函數(shù)，并將相關數(shù)據以參數(shù)形式傳入。

代碼示例

qq.onCompassChange(function (res) {
  console.log(res.direction)
})

同步 API

我們約定，以 Sync 結尾的 API 都是同步 API， 如 qq.setStorageSync，qq.getSystemInfoSync 等。此外，也有一些其他的同步 API，如 qq.createWorker，qq.getBackgroundAudioManager 等，詳情參見 API 文檔中的說明。 同步 API 的執(zhí)行結果可以通過函數(shù)返回值直接獲取，如果執(zhí)行出錯會拋出異常。

代碼示例

try {
  qq.setStorageSync('key', 'value')
} catch (e) {
  console.error(e)
}

異步 API

大多數(shù) API 都是異步 API，如 qq.request，qq.login 等。這類 API 接口通常都接受一個 Object 類型的參數(shù)，這個參數(shù)都支持按需指定以下字段來接收接口調用結果：

Object 參數(shù)說明

回調函數(shù)的參數(shù)

success，fail，complete 函數(shù)調用時會傳入一個 Object 類型參數(shù)，包含以下字段： |屬性|類型|說明| |errMsg|string|錯誤信息，如果調用成功返回 ${apiName}:ok| |errCode|number|錯誤碼，僅部分 API 支持，具體含義請參考對應 API 文檔，成功時為 0。| |其他|Any|接口返回的其他數(shù)據|

異步 API 的執(zhí)行結果需要通過 Object 類型的參數(shù)中傳入的對應回調函數(shù)獲取。部分異步 API 也會有返回值，可以用來實現(xiàn)更豐富的功能，如qq.request，qq.connectSockets 等。

代碼示例

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