24小時服務電話:17712205170 查看騰訊廣告代理商資質
  • 微信官網
    訪問微信官網
  • 小程序
    訪問小程序

南通H5開發公司萬傑網絡帶您認識小程序API

 
2019-09-12人氣:所屬分類:開發動态
API
 
小程序開發框架提供豐富的微信原生 API,可以方便的調起微信提供的能力,如獲取用戶信息,本地存儲,支付功能等。詳細介紹請參考 API 文檔。
 
通常,在小程序 API 有以下幾種類型:
 
事件監聽 API
 
我們約定,以 on 開頭的 API 用來監聽某個事件是否觸發,如:wx.onSocketOpen,wx.onCompassChange 等。
 
這類 API 接受一個回調函數作為參數,當事件觸發時會調用這個回調函數,并将相關數據以參數形式傳入。
 
代碼示例
 
wx.onCompassChange(function (res) {
  console.log(res.direction)
})
同步 API
 
我們約定,以 Sync 結尾的 API 都是同步 API, 如 wx.setStorageSync,wx.getSystemInfoSync 等。此外,也有一些其他的同步 API,如 wx.createWorker,wx.getBackgroundAudioManager 等,詳情參見 API 文檔中的說明。
 
同步 API 的執行結果可以通過函數返回值直接獲取,如果執行出錯會抛出異常。
 
代碼示例
 
try {
  wx.setStorageSync('key', 'value')
} catch (e) {
  console.error(e)
}
異步 API
 
大多數 API 都是異步 API,如 wx.request,wx.login 等。這類 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 也會有返回值,可以用來實現更豐富的功能,如 wx.request,wx.connectSocket 等。
 
代碼示例
 
wx.login({
  success(res) {
    console.log(res.code)
  }
})