微信小程序API 文檔快速參考索引

本文轉載自查看原文 2017-12-19 11:03 3649 小程序

內容那么多，這個頁面到底做了什么？

第一：解決微信文檔APi文檔使用不便；
第二：解決了內容搜索與索引；—— 最好是寫成全文索引文檔，但是比較需要時間，而且更新是一件麻煩的事；所以以下是直接連接官網查看的；
第三：解決了完整性；—— 當你看文檔時，無法掌握整體；這里可能更容易記憶目錄整體；
第四：不一定每個人閱讀后，都有作用！—— 可能本文檔與你無緣；

目錄2017-12-1911:37:56

-------------------------------------------------------------------------------------------------------------------------------------------

網絡
- 發起請求
  - wx.request —— wx.request(OBJECT) 發起網絡請求。使用前請先閱讀說明。
- 上傳、下載
  - wx.uploadFile —— wx.uploadFile(OBJECT) 將本地資源上傳到開發者服務器，客戶端發起一個 HTTPS POST 請求，其中 content-type 為 multipart/form-data 。使用前請先閱讀說明。
  - wx.downloadFile —— wx.downloadFile(OBJECT) 下載文件資源到本地，客戶端直接發起一個 HTTP GET 請求，返回文件的本地臨時路徑。使用前請先閱讀說明。
- WebSocket
  - wx.connectSocket —— wx.connectSocket(OBJECT) 創建一個 WebSocket 連接。使用前請先閱讀說明。
  - wx.onSocketOpen —— wx.onSocketOpen(CALLBACK) 監聽WebSocket連接打開事件。
  - wx.onSocketError —— wx.onSocketError(CALLBACK) 監聽WebSocket錯誤。
  - wx.sendSocketMessage —— wx.sendSocketMessage(OBJECT) 通過 WebSocket 連接發送數據，需要先 wx.connectSocket，並在 wx.onSocketOpen 回調之后才能發送。
  - wx.onSocketMessage —— wx.onSocketMessage(CALLBACK) 監聽WebSocket接受到服務器的消息事件。
  - wx.closeSocket —— wx.closeSocket(OBJECT) 關閉 WebSocket 連接。
  - wx.onSocketClose —— wx.onSocketClose(CALLBACK) 監聽WebSocket關閉。
  - SocketTask —— SocketTask
    SocketTask.send(OBJECT) 通過 WebSocket 連接發送數據。
    SocketTask.close(OBJECT) 關閉 WebSocket 連接。
    SocketTask.onOpen(CALLBACK) 監聽 WebSocket 連接打開事件。
    SocketTask.onOpen(CALLBACK) 監聽 WebSocket 連接關閉事件。
    SocketTask.onError(CALLBACK) 監聽 WebSocket 錯誤。
    SocketTask.onMessage(CALLBACK) 監聽WebSocket接受到服務器的消息事件。
媒體
- 圖片
  - wx.chooseImage —— wx.chooseImage(OBJECT) 從本地相冊選擇圖片或使用相機拍照。
  - wx.previewImage —— wx.previewImage(OBJECT) 預覽圖片。
  - wx.getImageInfo —— wx.getImageInfo(OBJECT) 獲取圖片信息
  - wx.saveImageToPhotosAlbum —— wx.saveImageToPhotosAlbum(OBJECT) 保存圖片到系統相冊。需要用戶授權 scope.writePhotosAlbum （基礎庫 1.2.0 開始支持，低版本需做兼容處理）
- 錄音
  - wx.startRecord —— wx.startRecord(OBJECT) 注意：1.6.0 版本開始，本接口不再維護。建議使用能力更強的 wx.getRecorderManager 接口
  - wx.stopRecord —— wx.stopRecord() 主動調用停止錄音。
- 錄音管理
  - wx.getRecorderManager —— wx.getRecorderManager() 獲取全局唯一的錄音管理器 recorderManager。
- 音頻播放控制
  - wx.playVoice —— wx.playVoice(OBJECT) 開始播放語音，同時只允許一個語音文件正在播放，如果前一個語音文件還沒播放完，將中斷前一個語音播放。
  - wx.pauseVoice
  - wx.stopVoice
- 音樂播放控制
- 背景音頻播放管理
  - wx.getBackgroundAudioManager
- 音頻組件控制
  - wx.createAudioContext
  - wx.createInnerAudioContext
- 視頻
  - wx.chooseVideo
  - wx.saveVideoToPhotosAlbum
- 視頻組件控制
  - wx.createVideoContext
- 相機組件控制
  - wx.createCameraContext
文件
- wx.saveFile —— wx.saveFile(OBJECT) 保存文件到本地。注意：saveFile 會把臨時文件移動，因此調用成功后傳入的 tempFilePath 將不可用
- wx.getFileInfo—— wx.getFileInfo(OBJECT) 獲取文件信息
- wx.getSavedFileList —— wx.getSavedFileList(OBJECT) 獲取本地已保存的文件列表
- wx.getSavedFileInfo —— wx.getSavedFileInfo(OBJECT) 獲取本地文件的文件信息。此接口只能用於獲取已保存到本地的文件，若需要獲取臨時文件信息，請使用 wx.getFileInfo 接口。
- wx.removeSavedFile —— wx.removeSavedFile(OBJECT) 刪除本地存儲的文件
- wx.openDocument —— wx.openDocument(OBJECT) 新開頁面打開文檔，支持格式：doc, xls, ppt, pdf, docx, xlsx, pptx
數據緩存
- wx.setStorage —— wx.setStorage(OBJECT) 將數據存儲在本地緩存中指定的 key 中，會覆蓋掉原來該 key 對應的內容，這是一個異步接口。
- wx.setStorageSync —— wx.setStorageSync(KEY,DATA) 將 data 存儲在本地緩存中指定的 key 中，會覆蓋掉原來該 key 對應的內容，這是一個同步接口。
- wx.getStorage —— wx.getStorage(OBJECT) 從本地緩存中異步獲取指定 key 對應的內容。
- wx.getStorageSync —— wx.getStorageSync(KEY) 從本地緩存中同步獲取指定 key 對應的內容。
- wx.getStorageInfo —— wx.getStorageInfo(OBJECT) 異步獲取當前storage的相關信息
- wx.getStorageInfoSync —— wx.getStorageInfoSync 同步獲取當前storage的相關信息
- wx.removeStorage —— wx.removeStorage(OBJECT) 從本地緩存中異步移除指定 key 。
- wx.removeStorageSync —— wx.removeStorageSync(KEY) 從本地緩存中同步移除指定 key 。
- wx.clearStorage —— wx.clearStorage() 清理本地數據緩存。
- wx.clearStorageSync —— wx.clearStorageSync() 同步清理本地數據緩存
位置
設備
界面
- 交互反饋
  - wx.showToast —— 顯示消息提示框
  - wx.showLoading —— 顯示 loading 提示框, 需主動調用 wx.hideLoading 才能關閉提示框
  - wx.hideToast —— 隱藏消息提示框
  - wx.hideLoading —— 隱藏 loading 提示框
  - wx.showModal —— 顯示模態彈窗
  - wx.showActionSheet —— 顯示操作菜單
- 設置導航條
  - wx.setNavigationBarTitle —— 動態設置當前頁面的標題。
  - wx.showNavigationBarLoading —— 在當前頁面顯示導航條加載動畫。
  - wx.hideNavigationBarLoading —— 隱藏導航條加載動畫。
  - wx.setNavigationBarColor —— 設置顏色
- 設置置頂信息
  - wx.setTopBarText —— 動態設置置頂欄文字內容，只有當前小程序被置頂時能生效，如果當前小程序沒有被置頂，也能調用成功，但是不會立即生效，只有在用戶將這個小程序置頂后才換上設置的文字內容。
- 導航
  - wx.navigateTo —— 保留當前頁面，跳轉到應用內的某個頁面，使用wx.navigateBack可以返回到原頁面。
  - wx.redirectTo —— 關閉當前頁面，跳轉到應用內的某個頁面。
  - wx.switchTab —— 跳轉到 tabBar 頁面，並關閉其他所有非 tabBar 頁面
  - wx.navigateBack —— 關閉當前頁面，返回上一頁面或多級頁面。可通過 getCurrentPages()) 獲取當前的頁面棧，決定需要返回幾層。
  - wx.reLaunch —— 關閉所有頁面，打開到應用內的某個頁面。
- 動畫
  - wx.createAnimation ——
    創建一個動畫實例animation。調用實例的方法來描述動畫。最后通過動畫實例的export方法導出動畫數據傳遞給組件的animation屬性。
    
    注意: export 方法每次調用后會清掉之前的動畫操作
- 位置
  - wx.pageScrollTo —— 將頁面滾動到目標位置。
  - wx.createSelectorQuery —— 返回一個SelectorQuery對象實例。可以在這個實例上使用select等方法選擇節點，並使用boundingClientRect等方法選擇需要查詢的信息。
- 繪圖
  - intro
  - coordinates
  - gradient
  - reference
  - color
  - wx.createCanvasContext
  - wx.createContext
  - wx.drawCanvas
  - wx.canvasToTempFilePath
  - setFillStyle
  - setStrokeStyle
  - setShadow
  - createLinearGradient
  - createCircularGradient
  - addColorStop
  - setLineWidth
  - setLineCap
  - setLineJoin
  - setLineDash
  - setMiterLimit
  - rect
  - fillRect
  - strokeRect
  - clearRect
  - fill
  - stroke
  - beginPath
  - closePath
  - moveTo
  - lineTo
  - arc
  - bezierCurveTo
  - quadraticCurveTo
  - scale
  - rotate
  - translate
  - clip
  - setFontSize
  - fillText
  - setTextAlign
  - setTextBaseline
  - drawImage
  - setGlobalAlpha
  - save
  - restore
  - draw
  - getActions
  - clearActions
- 下拉刷新
  - Page.onPullDownRefresh —— 在 Page 中定義 onPullDownRefresh 處理函數，監聽該頁面用戶下拉刷新事件。
  - wx.startPullDownRefresh —— 開始下拉刷新，調用后觸發下拉刷新動畫，效果與用戶手動下拉刷新一致
  - wx.stopPullDownRefresh —— 停止當前頁面下拉刷新。
WXML節點信息
- wx.createSelectorQuery —— 返回一個SelectorQuery對象實例。可以在這個實例上使用select等方法選擇節點，並使用boundingClientRect等方法選擇需要查詢的信息。
- selectorQuery.in —— 將選擇器的選取范圍更改為自定義組件component內。（初始時，選擇器僅選取頁面范圍的節點，不會選取任何自定義組件中的節點。）
- selectorQuery.select —— 在當前頁面下選擇第一個匹配選擇器selector的節點，返回一個NodesRef對象實例，可以用於獲取節點信息。
- selectorQuery.selectAll —— 在當前頁面下選擇匹配選擇器selector的節點，返回一個NodesRef對象實例。與selectorQuery.selectNode(selector)不同的是，它選擇所有匹配選擇器的節點。
- selectorQuery.selectViewport —— 選擇顯示區域，可用於獲取顯示區域的尺寸、滾動位置等信息，返回一個NodesRef對象實例。
- nodesRef.boundingClientRect —— 添加節點的布局位置的查詢請求，相對於顯示區域，以像素為單位。其功能類似於DOM的getBoundingClientRect。返回值是nodesRef對應的selectorQuery。
- nodesRef.scrollOffset —— 添加節點的滾動位置查詢請求，以像素為單位。節點必須是scroll-view或者viewport。返回值是nodesRef對應的selectorQuery。
- nodesRef.fields —— 獲取節點的相關信息，需要獲取的字段在fields中指定。返回值是nodesRef對應的selectorQuery。可指定獲取的字段包括：
- selectorQuery.exec —— 執行所有的請求，請求結果按請求次序構成數組，在callback的第一個參數中返回。
第三方平台
- wx.getExtConfig
- wx.getExtConfigSync
開放接口
- 登錄
  - wx.login ——
    調用接口獲取登錄憑證（code）進而換取用戶登錄態信息，包括用戶的唯一標識（openid）及本次登錄的會話密鑰（session_key）等。用戶數據的加解密通訊需要依賴會話密鑰完成。
    
    注：調用 login 會引起登錄態的刷新，之前的 sessionKey 可能會失效。
  - wx.checkSession —— 通過上述接口獲得的用戶登錄態擁有一定的時效性。用戶越久未使用小程序，用戶登錄態越有可能失效。反之如果用戶一直在使用小程序，則用戶登錄態一直保持有效。具體時效邏輯由微信維護，對開發者透明。開發者只需要調用wx.checkSession接口檢測當前用戶登錄態是否有效。登錄態過期后開發者可以再調用wx.login獲取新的用戶登錄態。
  - 簽名加密 —— 用戶數據的簽名驗證和加解密
- 授權
  - wx.authorize —— 提前向用戶發起授權請求。調用后會立刻彈窗詢問用戶是否同意授權小程序使用某項功能或獲取用戶的某些數據，但不會實際調用對應接口。如果用戶之前已經同意授權，則不會出現彈窗，直接返回成功。
- 用戶信息
  - wx.getUserInfo —— 獲取用戶信息，withCredentials 為 true 時需要先調用 wx.login 接口。
  - getPhoneNumber ——
    獲取微信用戶綁定的手機號，需先調用login接口。
    
    因為需要用戶主動觸發才能發起獲取手機號接口，所以該功能不由 API 來調用，需用 <button> 組件的點擊來觸發。
    
    注意：目前該接口針對非個人開發者，且完成了認證的小程序開放。需謹慎使用，若用戶舉報較多或被發現在不必要場景下使用，微信有權永久回收該小程序的該接口權限。
  - UnionID機制說明 —— 移動應用、網站應用、和公眾帳號（包括小程序）ID機制說明
- 微信支付
  - wx.requestPayment
- 模板消息
- 客服消息
- 轉發
- 獲取二維碼
- 收貨地址
  - wx.chooseAddress
- 卡券
- 設置
  - wx.openSetting
  - wx.getSetting
- 微信運動
  - wx.getWeRunData
- 打開小程序
  - wx.navigateToMiniProgram
  - wx.navigateBackMiniProgram
- 獲取發票抬頭
  - wx.chooseInvoiceTitle
- 生物認證
- 附近
數據
- 常規分析
- 自定義分析
  - 自定義數據上報
調試接口
- 打開/關閉調試

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 微信小程序 API 微信小程序調用api接口微信小程序api封裝微信小程序 HTTP API 微信小程序之 ----API接口封裝簡單的API——微信小程序微信小程序初使心得【微信小程序快速入門】微信小程序，獲取點擊元素的索引值index 微信小程序：獲取列表Index索引和額外數據微信小程序數組索引 data-“”解釋