API概覽
1.基礎
1.1、系統能力
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| canIuse | 判斷小程序的API,回檔,參數,組件等是否在當前版本可用。 | 1.5.0 |
| env | 環境變量 | 1.5.1 |
| base64ToArrayBuffer | 將Base64字串轉成ArrayBuffer對象 | 1.5.1 |
| arrayBufferToBase64 | 將ArrayBuffer對象轉成Base64字串 | 1.5.1 |
1.2、系統
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| getSystemInfo | 非同步調用獲取系統資訊 | 1.5.0 |
| getSystemInfoSync | 同步調用獲取系統資訊 | 1.5.1 |
| getSystemInfoAsync | 非同步獲取系統資訊 | 1.5.1 |
| getWindowInfo | 獲取視窗資訊 | 1.5.1 |
| getSystemSetting | 獲取設備設定 | 1.5.0 |
| openSystemBluetoothSetting | 跳轉系統藍牙設定頁 | 1.5.1 |
| openAppAuthorizeSetting | 跳轉系統宿主用戶端授權管理頁。 | 1.5.1 |
| getRendererUserAgent | 獲取Webview小程序的UserAgent。 | 1.5.1 |
| getDeviceInfo | 獲取設備基礎資訊。 | 1.5.1 |
| getAppBaseInfo | 獲取宿主用戶端基礎資訊 | 1.5.1 |
| getAppAuthorizeSetting | 獲取宿主用戶端授權設定 | 1.5.1 |
1.3、更新
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| getUpdateManager | 獲取全域唯一的版本更新管理器,用於管理小程序更新。 | 1.5.1 |
| UpdateManager.applyUpdate | 強制小程序重啓並使用新版本 | 1.5.0 |
| UpdateManager.onCheckForUpdate | 監聽向Luffa後臺請求檢查更新結果事件 | 1.5.0 |
| UpdateManager.onUpdateFailed | 監聽小程序更新失敗事件 | 1.5.0 |
| UpdateManager.onUpdateReady | 監聽小程序有版本更新事件 | 1.5.0 |
1.4、小程序
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| getLaunchOptionsSync | 獲取小程序啟動時的參數 | 1.5.0 |
| getEnterOptionsSync | 獲取本次小程序啟動時的參數 | 1.5.1 |
| onError | 監聽小程序錯誤事件 | 1.5.0 |
| offError | 移除小程序錯誤事件的監聽函數 | 1.5.0 |
| onThemeChange | 監聽系統主題改變事件 | 1.5.0 |
| offThemeChange | 移除系統主題改變事件的監聽函數 | 1.5.0 |
| onPageNotFound | 監聽小程序要打開的頁面不存在事件 | 1.5.1 |
| offPageNotFound | 移除小程序要打開的頁面不存在事件的監聽函數 | 1.5.1 |
| onAppShow | 監聽小程序切前臺事件 | 1.5.1 |
| offAppShow | 移除小程序切前臺事件的監聽函數 | 1.5.1 |
| onAppHide | 監聽小程序切後臺事件 | 1.5.1 |
| offAppHide | 移除小程序切前臺事件的監聽函數 | 1.5.1 |
| onUnhandledRejection | 監聽未處理的Promise拒絕事件 | 1.5.1 |
| offUnhandledRejection | 移除未處理的Promise拒絕事件的監聽函數 | 1.5.1 |
1.5、調試
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| setEnableDebug | 設定是否打開調試開關 | 1.5.0 |
| getLogManager | 獲取日誌管理器對象 | 1.5.1 |
| console.debug | 向調試面板中列印debug日誌 | 1.5.0 |
| console.error | 向調試面板中列印error日誌 | 1.5.0 |
| console.group | 在調試面板中創建一個新的分組 | 1.5.0 |
| console.groupEnd | 結束由console.group創建的分組 | 1.5.0 |
| console.info | 向調試面板中列印info日誌 | 1.5.0 |
| console.log | 向調試面板中列印log日誌 | 1.5.0 |
| console.warn | 向調試面板中列印warn日誌 | 1.5.0 |
| LogManager.debug | 寫debug日誌 | 1.5.0 |
| LogManager.info | 寫info日誌 | 1.5.0 |
| LogManager.log | 寫log日誌 | 1.5.0 |
| LogManager.warn | 寫warn日誌 | 1.5.0 |
| RealtimeLogManager.addFilterMsg | 添加過濾關鍵字 | 1.5.16 |
| RealtimeLogManager.error | 寫error日誌 | 1.5.16 |
| RealtimeLogManager.getCurrentState | 可以獲取當前緩存剩餘空間 | 1.5.16 |
| RealtimeLogManager.in | 設定實时日誌page參數所在的頁面 | 1.5.16 |
| RealtimeLogManager.info | 寫info日誌 | 1.5.16 |
| RealtimeLogManager.setFilterMsg | 設定過濾關鍵字 | 1.5.16 |
| RealtimeLogManager.warn | 寫warn日誌 | 1.5.16 |
| RealtimeTagLogManageraddFilterMsg | 添加過濾關鍵字 | 1.5.16 |
| RealtimeTagLogManager.error | 寫error日誌 | 1.5.16 |
| RealtimeTagLogManager.info | 寫info日誌 | 1.5.16 |
| RealtimeTagLogManager.setFilterMsg | 設定過濾關鍵字 | 1.5.16 |
| RealtimeTagLogManager.warn | 寫warn日誌 | 1.5.16 |
2、路由
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| switchTab | 跳轉到tabBar頁面,並關閉其他所有非tabBar頁面 | 1.5.0 |
| reLaunch | 關閉所有頁面,打開到應用內的某個頁面 | 1.5.0 |
| redirectTo | 關閉當前頁面,跳轉到應用內的某個頁面 | 1.5.0 |
| navigateTo | 保留當前頁面,跳轉到應用內的某個頁面 | 1.5.1 |
| navigateBack | 關閉當前頁面,返回上一頁面或多級頁面 | 1.5.0 |
| EventChannel | 頁面間事件通信通道 | 1.5.1 |
3、跳轉
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| exitMiniProgram | 退出當前小程序 | 1.5.0 |
| navigateToMiniProgram | 打開另一個小程序 | 1.5.0 |
| navigateBackMiniProgram | 返回到上一個小程序。 只有在當前小程序是被其他小程序打開時可以調用成功。 | 1.5.1 |
4、轉發
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| hideShareMenu | 隱藏當前頁面的轉發按鈕 | 1.5.0 |
| showShareMenu | 顯示當前頁面的轉發按鈕 | 1.5.0 |
| updateShareMenu | 更新轉發内容 | 1.5.0 |
| showShareImageMenu | 打開分享圖片彈窗 | 1.5.35 |
| onCopyUrl | 監聽用戶點擊右上角選單的「複製連結」按鈕時觸發的事件 | 1.5.35 |
| offCopyUrl | 移除用戶點擊右上角選單的「複製連結」按鈕時觸發的事件的全部監聽函數 | 1.5.35 |
5、介面
5.1、互動
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| hideLoading | 隱藏loading提示框 | 1.5.0 |
| hideToast | 隱藏消息提示框 | 1.5.0 |
| showActionSheet | 顯示操作選單 | 1.5.0 |
| showLoading | 顯示loading提示框 | 1.5.0 |
| showModal | 顯示模態對話方塊 | 1.5.0 |
| showToast | 顯示消息提示框 | 1.5.0 |
| enableAlertBeforeUnload | 開啟小程序頁面返回詢問對話方塊 | 1.5.1 |
| disableAlertBeforeUnload | 關閉小程序頁面返回詢問對話方塊 | 1.5.1 |
5.2、導航欄
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| setNavigationBarTitle | 動態設定當前頁面的標題。 | 1.5.0 |
| setNavigationBarColor | 設定頁面導航條顏色。 | 1.5.0 |
| hideHomeButton | 隱藏返回首頁按鈕 | 1.5.0 |
| showNavigationBarLoading | 在當前頁面顯示導航條加載動畫 | 1.5.1 |
| hideNavigationBarLoading | 在當前頁面隱藏導航條加載動畫 | 1.5.1 |
5.3、背景
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| setBackgroundColor | 動態設定視窗的背景色 | 1.5.0 |
| setBackgroundTextStyle | 動態設定下拉背景字體、loading圖的樣式 | 1.5.0 |
5.4、TabBar
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| showTabBar | 顯示tabBar。 | 1.5.0 |
| hideTabBar | 隱藏tabBar。 | 1.5.0 |
| setTabBarStyle | 動態設定tabBar的整體樣式。 | 1.5.0 |
| setTabBarItem | 動態設定tabBar某一項的內容,2.7.0起圖片支持暫存文件和網絡文件 | 1.5.0 |
| showTabBarRedDot | 顯示tabBar某一項的右上角的紅點 | 1.5.0 |
| hideTabBarRedDot | 隱藏tabBar某一項的右上角的紅點 | 1.5.0 |
| setTabBarBadge | 為tabBar某一項的右上角添加文字 | 1.5.0 |
| removeTabBarBadge | 移除tabBar某一項右上角的文字 | 1.5.0 |
5.5、下拉刷新
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| startPullDownRefresh | 開始下拉刷新 | 1.5.0 |
| stopPullDownRefresh | 停止當前頁面下拉刷新 | 1.5.0 |
5.6、滾動
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| pageScrollTo | 將頁面滾動到目標位置,支持選擇器和滾動距離兩種方式定位 | 1.5.0 |
| ScrollViewContext.scrollIntoView | 滾動至指定位置 | 1.5.0 |
| ScrollViewContext.scrollTo | 滾動至指定位置 | 1.5.0 |
5.7、動畫
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| createAnimation | 創建一個動畫實例animation | 1.5.0 |
| Animation.backgroundColor | 設定背景色。 | 1.5.0 |
| Animation.bottom | 設定bottom值。 | 1.5.0 |
| Animation.export | 匯出動畫隊列 | 1.5.0 |
| Animation.height | 設定高度 | 1.5.0 |
| Animation.left | 設定left值 | 1.5.0 |
| Animation.matrix | 同transform-function matrix | 1.5.0 |
| Animation.matrix3d | 同transform-function matrix3d | 1.5.0 |
| Animation.opacity | 設定透明度 | 1.5.0 |
| Animation.right | 設定right值 | 1.5.0 |
| Animation.rotate | 從原點順時針旋轉一個角度 | 1.5.0 |
| Animation.rotate3d | 從固定軸順時針旋轉一個角度 | 1.5.0 |
| Animation.rotateX | 從X軸順時針旋轉一個角度 | 1.5.0 |
| Animation.rotateY | 從Y軸順時針旋轉一個角度 | 1.5.0 |
| Animation.rotateZ | 從Z軸順時針旋轉一個角度 | 1.5.0 |
| Animation.scale | 縮放 | 1.5.0 |
| Animation.scale3d | 縮放 | 1.5.0 |
| Animation.scaleX | 縮放X軸 | 1.5.0 |
| Animation.scaleY | 縮放Y軸 | 1.5.0 |
| Animation.scaleZ | 縮放Z軸 | 1.5.0 |
| Animation.skew | 對X、Y軸座標進行傾斜 | 1.5.0 |
| Animation.skewX | 對X軸座標進行傾斜 | 1.5.0 |
| Animation.skewY | 對Y軸座標進行傾斜 | 1.5.0 |
| Animation.step | 表示一組動畫完成 | 1.5.0 |
| Animation.top | 設定top值 | 1.5.0 |
| Animation.translate | 平移變換 | 1.5.0 |
| Animation.translate3d | 對xyz座標進行平移變換 | 1.5.0 |
| Animation.translateX | 對X軸平移 | 1.5.0 |
| Animation.translateY | 對Y軸平移 | 1.5.0 |
| Animation.translateZ | 對Z軸平移 | 1.5.0 |
| Animation.width | 設定寬度 | 1.5.0 |
5.8、自定義組件
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| nextTick | 延遲一部分操作到下一個時間片再執行 | 1.5.0 |
5.9、選單
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| getMenuButtonBoundingClientRect | 獲取選單按鈕(右上角膠囊按鈕)的佈局位置資訊 | 1.5.0 |
5.10、視窗
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| onWindowResize | 監聽視窗尺寸變化事件 | 1.5.0 |
| offWindowResize | 移除視窗尺寸變化事件的監聽函數 | 1.5.1 |
5.11、字體
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| loadFontFace | 動態加載網絡字體 | 1.5.0 |
6、網絡
6.1、發起請求
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| request | 發起HTTPS網絡請求 | 1.5.0 |
| RequestTask.abort | 插斷要求任務 | 1.5.0 |
| RequestTask.onChunkReceived | 監聽Transfer-Encoding Chunk Received事件 | 1.5.1 |
| RequestTask.offChunkReceived | 移除Transfer-Encoding Chunk Received事件的監聽函數 | 1.5.1 |
| RequestTask.onHeadersReceived | 監聽HTTP Response Header事件 | 1.5.0 |
| RequestTask.offHeadersReceived | 移除HTTP Response Header事件的監聽函數 | 1.5.0 |
6.2、上傳
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| uploadFile | 將本地資源上傳到服務器 | 1.5.0 |
| UploadTask.abort | 中斷上傳任務 | 1.5.0 |
| UploadTask.onProgressUpdate | 監聽上傳進度變化事件 | 1.5.0 |
| UploadTask.offProgressUpdate | 取消監聽上傳進度變化事件 | 1.5.0 |
| UploadTask.onHeadersReceived | 監聽HTTP Response Header事件 | 1.5.0 |
| UploadTask.offHeadersReceived | 移除HTTP Response Header事件的監聽函數 | 1.5.0 |
6.3、下載
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| downloadFile | 下載文件資源到本地。 用戶端直接發起一個HTTPS GET請求,返回文件的本地臨時路徑(本地路徑),單次下載允許的最大文件為200MB | 1.5.1 |
| DownloadTask.abort | 中斷下載任務 | 1.5.1 |
| DownloadTask.onProgressUpdate | 監聽下載進度變化事件 | 1.5.1 |
| DownloadTask.offProgressUpdate | 移除下載進度變化事件的監聽函數 | 1.5.1 |
| DownloadTask.onHeadersReceived | 監聽HTTP Response Header事件 | 1.5.1 |
| DownloadTask.offHeadersReceived | 移除HTTP Response Header事件的監聽函數 | 1.5.1 |
6.4、WebSocket
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| sendSocketMessage | 通過WebSocket連接發送數據。 需要先wx.connectSocket,並在wx.onSocketOpen回檔之後才能發送 | 1.5.1 |
| onSocketOpen | 監聽WebSocket連接打開事件 | 1.5.1 |
| onSocketMessage | 監聽WebSocket接收到服務器的消息事件 | 1.5.1 |
| onSocketError | 監聽WebSocket錯誤事件 | 1.5.1 |
| onSocketClose | 監聽WebSocket連接關閉事件 | 1.5.1 |
| connectSocket | 創建一個WebSocket連接 | 1.5.1 |
| closeSocket | 關閉WebSocket連接 | 1.5.1 |
| SocketTask.close | 關閉WebSocket連接 | 1.5.0 |
| SocketTask.onClose | 監聽WebSocket連接關閉事件 | 1.5.0 |
| SocketTask.onError | 監聽WebSocket錯誤事件 | 1.5.0 |
| SocketTask.onMessage | 監聽WebSocket接收到服務器的消息事件 | 1.5.0 |
| SocketTask.onOpen | 監聽WebSocket連接打開事件 | 1.5.0 |
| SocketTask.send | 通過WebSocket連接發送數據 | 1.5.0 |
6.5、UDP 通信
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| createUDPSocket | 創建一個UDP Socket實例 | 1.5.1 |
| UDPSocket.bind | 綁定一個系統隨機分配的可用埠,或綁定一個指定的埠號 | 1.5.1 |
| UDPSocket.close | 關閉UDP Socket實例 | 1.5.1 |
| UDPSocket.connect | 預先連接到指定的IP和port,需要配合write方法一起使用 | 1.5.1 |
| UDPSocket.onClose | 監聽關閉事件。 | 1.5.1 |
| UDPSocket.offClose | 移除關閉事件的監聽函數。 | 1.5.1 |
| UDPSocket.onError | 監聽錯誤事件。 | 1.5.1 |
| UDPSocket.offError | 移除錯誤事件的監聽函數。 | 1.5.1 |
| UDPSocket.onListening | 監聽開始監聽數据包消息的事件。 | 1.5.1 |
| UDPSocket.offListening | 移除開始監聽數据包消息的事件的監聽函數。 | 1.5.1 |
| UDPSocket.onMessage | 監聽收到消息的事件。 | 1.5.1 |
| UDPSocket.offMessage | 移除收到消息的事件的監聽函數。 | 1.5.1 |
| UDPSocket.send | 向指定的IP和port發送消息 | 1.5.1 |
| UDPSocket.setTTL | 設定IP_TTL通訊端選項,用於設定一個IP數据包傳輸時允許的最大跳步數 | 1.5.16 |
| UDPSocket.write | 用法與send方法相同 | 1.5.16 |
6.6、TCP 通信
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| createTCPSocket | 創建一個TCP Socket實例 | 1.5.1 |
| TCPSocket.bindWifi | 將TCP Socket綁定到當前Wi-Fi網絡,成功後會觸發onBindWifi事件(僅Android支持) | 1.5.1 |
| TCPSocket.close | 關閉連接 | 1.5.1 |
| TCPSocket.connect | 在給定的套接字上啟動連接 | 1.5.1 |
| TCPSocket.onClose | 監聽一旦socket完全關閉就發出該事件 | 1.5.1 |
| TCPSocket.offClose | 移除一旦socket完全關閉就發出該事件的監聽函數 | 1.5.1 |
| TCPSocket.onConnect | 監聽當一個socket連接成功建立的時候觸發該事件 | 1.5.1 |
| TCPSocket.offConnect | 移除當一個socket連接成功建立的時候觸發該事件的監聽函數 | 1.5.1 |
| TCPSocket.onError | 監聽當錯誤發生時觸發 | 1.5.1 |
| TCPSocket.offError | 移除當錯誤發生時觸發的監聽函數 | 1.5.1 |
| TCPSocket.onMessage | 監聽當接收到數據的時觸發該事件 | 1.5.1 |
| TCPSocket.offMessage | 移除當接收到數據的時觸發該事件的監聽函數 | 1.5.1 |
| TCPSocket.onBindWifi | 監聽當一個socket綁定當前Wi-Fi網絡成功時觸發該事件 | 1.5.1 |
| TCPSocket.offBindWifi | 移除當一個socket綁定當前Wi-Fi網絡成功時觸發該事件的監聽函數 | 1.5.1 |
| TCPSocket.write | 在socket上發送數據 | 1.5.1 |
6.7、mDNS
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| stopLocalServiceDiscovery | 停止蒐索mDNS服務 | 1.5.1 |
| startLocalServiceDiscovery | 開始搜尋局域網下的mDNS服務 | 1.5.1 |
| offLocalServiceResolveFail | 移除mDNS服務解析失敗的事件的監聽函數 | 1.5.1 |
| onLocalServiceResolveFail | 監聽mDNS服務解析失敗的事件 | 1.5.1 |
| offLocalServiceLost | 移除mDNS服務離開的事件的監聽函數 | 1.5.1 |
| onLocalServiceLost | 監聽mDNS服務離開的事件 | 1.5.1 |
| offLocalServiceFound | 移除mDNS服務發現的事件的監聽函數 | 1.5.1 |
| onLocalServiceFound | 監聽mDNS服務發現的事件 | 1.5.1 |
| offLocalServiceDiscoveryStop | 移除mDNS服務停止蒐索的事件的監聽函數 | 1.5.1 |
| onLocalServiceDiscoveryStop | 監聽mDNS服務停止蒐索的事件 | 1.5.1 |
7、數據緩存
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| setStorage | 將資料存儲在本地緩存中指定的key中 | 1.5.0 |
| setStorageSync | 將資料存儲在本地緩存中指定的key中 | 1.5.0 |
| revokeBufferURL | 根據URL銷毀存在記憶體中的數據 | 1.5.35 |
| removeStorage | 從本地緩存中移除指定key | 1.5.0 |
| removeStorageSync | removeStorage的同步版本 | 1.5.0 |
| getStorage | 從本地緩存中非同步獲取指定key的內容 | 1.5.0 |
| createBufferURL | 根據傳入的buffer創建一個唯一的URL存在記憶體中 | 1.5.35 |
| getStorageSync | 從本地緩存中同步獲取指定key的內容 | 1.5.0 |
| getStorageInfo | 非同步獲取當前storage的相關資訊 | 1.5.0 |
| getStorageInfoSync | getStorageInfo的同步版本 | 1.5.0 |
| clearStorage | 清理本地數據緩存 | 1.5.0 |
| clearStorageSync | clearStorage的同步版本 | 1.5.0 |
| batchSetStorage | 將數據批量存儲在本地緩存中指定的key中 | 1.5.16 |
| batchSetStorageSync | batchSetStorage的同步版本 | 1.5.16 |
| batchGetStorage | 從本地緩存中非同步批量獲取指定key的內容。 | 1.5.16 |
| batchGetStorageSync | batchGetStorage的同步版本 | 1.5.16 |
8、資料分析
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| reportEvent | 事件上報 | 1.5.16 |
9、畫布
9.1、畫布概要
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| createOffscreenCanvas | 創建離屏canvas實例 | 1.5.19 |
| createCanvasContext | 創建canvas的繪圖上下文CanvasContext對象 | 1.5.0 |
| canvasToTempFilePath | 把當前畫布指定區域的內容匯出生成指定大小的圖片 | 1.5.0 |
| canvasPutImageData | 將點數數據繪製到畫布 | 1.5.0 |
| canvasGetImageData | 獲取canvas區域隱含的點數數據 | 1.5.0 |
| Image | 圖片對象 | 1.5.16 |
| ImageData | ImageData對象 | 1.5.16 |
| RenderingContext | Canvas繪圖上下文 | 1.5.16 |
9.2、canvasContext
9.3、CanvasGradient
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| CanvasGradient.addColorStop | 添加顏色的漸變點 | 1.5.0 |
9.4、Canvas
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| Canvas.cancelAnimationFrame | 取消由requestAnimationFrame添加到計畫中的動畫請求 | 1.5.16 |
| Canvas.createImageData | 創建一個ImageData對象 | 1.5.16 |
| Canvas.createImage | 創建一個圖片對象 | 1.5.16 |
| Canvas.createPath2D | 創建Path2D對象 | 1.5.16 |
| Canvas.getContext | 該方法返回Canvas的繪圖上下文。 | 1.5.16 |
| Canvas.requestAnimationFrame | 在下次進行重繪時執行 | 1.5.16 |
| Canvas.toDataURL | 返回一個包含圖片展示的data URl | 1.5.16 |
9.5、OffscreenCanvas
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| OffscreenCanvas.createImage | 該方法返回OffscreenCanvas的繪圖上下文 | 1.5.16 |
| OffscreenCanvas.getContext | 創建一個圖片對象 | 1.5.16 |
9.6、Path2D
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| Path2D.addPath | 添加路徑到當前路徑 | 1.5.16 |
| Path2D.arc | 添加一段圓弧路徑 | 1.5.16 |
| Path2D.arcTo | 通過給定控制點添加一段圓弧路徑 | 1.5.16 |
| Path2D.bezierCurveTo | 添加三次貝塞爾曲線路徑 | 1.5.16 |
| Path2D.closePath | 閉合路徑到起點 | 1.5.16 |
| Path2D.ellipse | 添加橢圓弧路徑 | 1.5.16 |
| Path2D.lineTo | 添加直線路徑 | 1.5.16 |
| Path2D.moveTo | 移動路徑開始點 | 1.5.16 |
| Path2D.quadraticCurveTo | 添加二次貝塞爾曲線路徑 | 1.5.16 |
| Path2D.rect | 添加方形路徑 | 1.5.16 |
10、媒體
10.1、地圖
10.2、圖片
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| chooseImage | 從本地相册選擇圖片或使用相機拍照。 | 1.5.0 |
| compressImage | 壓縮圖片接口,可選壓縮質量。 | 1.5.1 |
| getImageInfo | 獲取圖片資訊 | 1.5.0 |
| previewImage | 在新頁面中全屏預覽圖片 | 1.5.0 |
| previewMedia | 預覽圖片和視頻 | 1.5.1 |
| saveImageToPhotosAlbum | 保存圖片到系統相册。 | 1.5.1 |
10.3、實时音視頻
10.4、音訊
10.5、視頻
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| saveVideoToPhotosAlbum | 保存視頻到系統相册 | 1.5.0 |
| createVideoContext | 創建video上下文VideoContext對象 | 1.5.0 |
| chooseVideo | 拍攝視頻或從手機相册中選視頻 | 1.5.0 |
| compressVideo | 壓縮視頻接口 | 1.5.1 |
| chooseMedia | 拍攝或從手機相册中選擇圖片或視頻 | 1.5.1 |
| VideoContext.exitFullScreen | 退出全屏 | 1.5.0 |
| VideoContext.exitBackgroundPlayback | 退出後臺音訊播放模式 | 1.5.16 |
| VideoContext.exitPictureInPicture | 退出小窗,該方法可在任意頁面調用 | 1.5.16 |
| VideoContext.hideStatusBar | 隱藏狀態列,僅在iOS全屏下有效 | 1.5.0 |
| VideoContext.pause | 暫停視頻 | 1.5.0 |
| VideoContext.play | 播放視頻 | 1.5.0 |
| VideoContext.requestFullScreen | 進入全屏 | 1.5.0 |
| VideoContext.requestBackgroundPlayback | 進入後臺音訊播放模式 | 1.5.16 |
| VideoContext.seek | 跳轉到指定位置 | 1.5.0 |
| VideoContext.sendDanmu | 發送彈幕 | 1.5.0 |
| VideoContext.showStatusBar | 顯示狀態列,僅在iOS全屏下有效。 | 1.5.0 |
| VideoContext.stop | 停止視頻 | 1.5.0 |
10.6、透明視頻
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| createAnimationVideo | 創建animation-video上下文AnimationVideoContext對象 | 1.5.0 |
| AnimationVideoContext.play | 播放視頻 | 1.5.0 |
| AnimationVideoContext.pause | 暫停視頻 | 1.5.0 |
| AnimationVideoContext.seek | 跳轉到指定位置 | 1.5.0 |
10.7、相機
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| createCameraContext | 創建camera上下文CameraContext對象 | 1.5.0 |
| CameraContext.onCameraFrame | 獲取Camera實时幀數據。 | 1.5.0 |
| CameraContext.setZoom | 設定縮放級別。 | 1.5.0 |
| CameraContext.startRecord | 開始錄影。 | 1.5.0 |
| CameraContext.stopRecord | 結束錄影。 | 1.5.0 |
| CameraContext.takePhoto | 拍攝照片。 | 1.5.0 |
| CameraFrameListener.start | 開始監聽幀數據。 | 1.5.0 |
| CameraFrameListener.stop | 停止監聽幀數據。 | 1.5.0 |
10.8、錄音
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| startRecord | 開始錄音 | 1.5.1 |
| stopRecord | 結束錄音 | 1.5.1 |
| getRecorderManager | 獲取全域唯一的錄音管理器RecorderManager | 1.5.0 |
| RecorderManager.onError | 監聽錄音錯誤事件 | 1.5.0 |
| RecorderManager.onFrameRecorded | 監聽已錄製完指定幀大小的文件事件 | 1.5.0 |
| RecorderManager.onlnterruptionBegin | 監聽錄音因為受到系統佔用而被中斷開始事件 | 1.5.0 |
| RecorderManager.onlnterruptionEnd | 監聽錄音中斷結束事件 | 1.5.0 |
| RecorderManager.onPause | 監聽錄音暫停事件 | 1.5.0 |
| RecorderManager.onResume | 監聽錄音繼續事件 | 1.5.0 |
| RecorderManager.onStart | 監聽錄音開始事件 | 1.5.0 |
| RecorderManager.onStop | 監聽錄音結束事件 | 1.5.0 |
| RecorderManager.pause | 暫停錄音 | 1.5.0 |
| RecorderManager.resume | 繼續錄音 | 1.5.0 |
| RecorderManager.start | 開始錄音 | 1.5.0 |
| RecorderManager.stop | 暫停錄音 | 1.5.0 |
10.9、背景音频
10.10、富文本
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| EditorContext | EditorContext實例 | 1.5.16 |
| EditorContext.blur | 編輯器失焦,同時收起鍵盤 | 1.5.16 |
| EditorContext.clear | 清空編輯器內容 | 1.5.16 |
| EditorContext.format | 修改樣式 | 1.5.16 |
| EditorContext.getContents | 獲取編輯器內容 | 1.5.16 |
| EditorContext.getSelectionText | 獲取編輯器已選區域內的純文字內容 | 1.5.16 |
| EditorContext.insertDivider | 插入分割線 | 1.5.16 |
| EditorContext.insertImage | 插入圖片 | 1.5.16 |
| EditorContext.insertText | 覆蓋當前選區,設定一段文字 | 1.5.16 |
| EditorContext.redo | 恢復 | 1.5.16 |
| EditorContext.removeFormat | 清除當前選區的樣式 | 1.5.16 |
| EditorContext.scrollIntoView | 使得編輯器光標處滾動到視窗可視區域內 | 1.5.16 |
| EditorContext.setContents | 初始化編輯器內容 | 1.5.16 |
| EditorContext.undo | 撤銷 | 1.5.1 |
11、文件
11.1、文件概要
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| saveFile | 保存文件到本地 | 1.5.0 |
| removeSavedFile | 删除本地緩存文件。 | 1.5.0 |
| openDocument | 新開頁面打開文件 | 1.5.0 |
| getSavedFileList | 獲取該小程序下已保存的本地緩存文件清單。 | 1.5.0 |
| getSavedFileInfo | 獲取本地文件的文件資訊。 | 1.5.0 |
| getFileSystemManager | 獲取全域唯一的文件管理器 | 1.5.0 |
| getFileInfo | 獲取文件資訊。 | 1.5.0 |
| ReadResult | 文件讀取結果 | 1.5.16 |
| WriteResult | 文件寫入結果 | 1.5.16 |
11.2、FileSystemManager
11.3、Stats
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| Stats.isDirectory | 判斷當前文件是否一個目錄 | 1.5.0 |
| Stats.isFile | 判斷當前文件是否一個普通文件 | 1.5.0 |
12、開放接口
12.1、登入
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| login | 調用接口獲取登入憑證(code) | 1.5.1 |
| checkSession | 檢查登入態是否過期 | 1.5.1 |
12.2、帳號資訊
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| getAccountInfoSync | 獲取當前帳號資訊 | 1.5.1 |
12.3、用戶資訊
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| getUserProfile | 獲取用戶資訊 | 1.5.1 |
| getUserInfo | 獲取用戶資訊,在使用過程中需要用戶授權scope.userInfo。 | 1.5.1 |
| userInfo | 用戶資訊 | 1.5.0 |
12.4、設定
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| AuthSetting | 使用者授權設定訊息 | 1.5.0 |
| getSetting | 取得用戶的目前設置 | 1.5.0 |
| openSetting | 調起用戶端小程序設定介面,返回用戶設置的操作結果 | 1.5.0 |
12.5、生物認證
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| checkIsSoterEnrolledInDevice | 校驗設備內是否錄入生物資訊。 | 1.5.0 |
| checkIsSupportSoterAuthentication | 校驗本機是否支持生物認證。 | 1.5.0 |
| startSoterAuthentication | 開始生物認證 | 1.5.0 |
12.6、授權
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| authorize | 提前向用戶發起授權請求 | 1.5.0 |
13、位置
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| getLocation | 獲取當前的地理位置、速度。 | 1.5.0 |
| choosePoi | 打開POI清單選擇位置,支持模糊定位(精確到市)和精確定位混選 | 1.5.0 |
| chooseLocation | 打開地圖選擇位置 | 1.5.0 |
| stopLocationUpdate | 關閉監聽實时位置變化,前後臺都停止消息接收 | 1.5.0 |
| startLocationUpdateBackground | 開啟小程序進入前後臺時均接收位置消息,需引導用戶開啟'授權' | 1.5.0 |
| startLocationUpdate | 開啟小程序進入前臺時接收位置消息。 | 1.5.0 |
| openLocation | 使用Luffa內寘地圖查看位置 | 1.5.0 |
| onLocationChangeError | 監聽持續定位接口返回失敗時觸發 | 1.5.0 |
| onLocationChange | 監聽實时地理位置變化事件,需結合startLocationUpdateBackground、startLocationUpdate使用 | 1.5.0 |
| offLocationChangeError | 移除持續定位接口返回失敗時觸發 | 1.5.0 |
| offLocationChange | 取消監聽實时地理位置變化事件 | 1.5.0 |
| getFuzzyLocation | 獲取當前的模糊地理位置 | 1.5.0 |
14、設備
14.1、藍牙通用
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| stopBluetoothDevicesDiscovery | 停止搜尋附近的藍牙周邊設備 | 1.5.0 |
| startBluetoothDevicesDiscovery | 開始搜尋附近的藍牙周邊設備 | 1.5.0 |
| openBluetoothAdapter | 初始化藍牙模組 | 1.5.1 |
| getConnectedBluetoothDevices | 根據主服務UUID獲取已連接的藍牙設備 | 1.5.1 |
| getBluetoothDevices | 獲取在藍牙模組生效期間所有蒐索到的藍牙設備。 | 1.5.1 |
| getBluetoothAdapterState | 獲取本機藍牙適配器狀態。 | 1.5.1 |
| closeBluetoothAdapter | 關閉藍牙模組 | 1.5.1 |
| onBluetoothDeviceFound | 監聽蒐索到新設備的事件 | 1.5.0 |
| offBluetoothDeviceFound | 移除蒐索到新設備的事件的全部監聽函數。 | 1.5.0 |
| onBluetoothAdapterStateChange | 監聽藍牙適配器狀態變化事件。 | 1.5.0 |
| offBluetoothAdapterStateChange | 移除藍牙適配器狀態變化事件的全部監聽函數。 | 1.5.0 |
| makeBluetoothPair | 藍牙配對接口,僅Android支持 | 1.5.0 |
| isBluetoothDevicePaired | 査詢藍牙設備是否配對,僅Android支持。 | 1.5.0 |
14.2、藍牙-低功耗中心設備
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| writeBLECharacteristicValue | 向藍牙低功耗設備特徵值中寫入二進位數據 | 1.5.1 |
| readBLECharacteristicValue | 讀取藍牙低功耗設備特徵值的二進位數據 | 1.5.1 |
| setBLEMTU | 協商設定藍牙低功耗的最大傳輸單元 | 1.5.1 |
| getBLEMTU | 獲取藍牙低功耗的最大傳輸單元 | 1.5.1 |
| onBLEMTUChange | 監聽藍牙低功耗的最大傳輸單元變化事件(僅Android觸發) | 1.5.1 |
| offBLEMTUChange | 移除藍牙低功耗的最大傳輸單元變化事件的監聽函數 | 1.5.1 |
| onBLEConnectionStateChange | 監聽藍牙低功耗連接狀態改變事件 | 1.5.1 |
| offBLEConnectionStateChange | 移除藍牙低功耗連接狀態改變事件的監聽函數 | 1.5.1 |
| onBLECharacteristicValueChange | 監聽藍牙低功耗設備的特徵值變化事件 | 1.5.1 |
| offBLECharacteristicValueChange | 移除藍牙低功耗設備的特徵值變化事件的全部監聽函數 | 1.5.1 |
| notifyBLECharacteristicValueChange | 啟用藍牙低功耗設備特徵值變化時的notify功能,訂閱特徵 | 1.5.1 |
| getBLEDeviceServices | 獲取藍牙低功耗設備所有服務(service) | 1.5.1 |
| getBLEDeviceRSSI | 獲取藍牙低功耗設備的信號強度 | 1.5.1 |
| getBLEDeviceCharacteristics | 獲取藍牙低功耗設備某個服務中所有特徵 | 1.5.1 |
| createBLEConnection | 連接藍牙低功耗設備 | 1.5.1 |
| closeBLEConnection | 斷開與藍牙低功耗設備的連接 | 1.5.1 |
14.3、藍牙-低功耗周邊設備
14.4、藍牙-信標
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| stopBeaconDiscovery | 停止蒐索附近的Beacon設備 | 1.5.1 |
| startBeaconDiscovery | 開始蒐索附近的Beacon設備 | 1.5.1 |
| onBeaconUpdate | 監聽Beacon設備更新事件,僅能注册一個監聽 | 1.5.1 |
| offBeaconUpdate | 移除Beacon設備更新事件的全部監聽函數 | 1.5.1 |
| onBeaconServiceChange | 監聽Beacon服務狀態變化事件,僅能注册一個監聽 | 1.5.1 |
| offBeaconServiceChange | 移除Beacon服務狀態變化事件的全部監聽函數 | 1.5.1 |
| getBeacons | 獲取所有已蒐索到的Beacon設備 | 1.5.1 |
| BeaconInfo | Beacon設備 | 1.5.1 |
14.5、NFC
14.5.1、getNFCAdapter
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| getNFCAdapter | 獲取NFC實例 | 1.5.0 |
14.5.2、NFCAdapter
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| NFCAdapter.startDiscovery | 開啟設備 | 1.5.0 |
| NFCAdapter.stopDiscovery | 關閉設備 | 1.5.0 |
| NFCAdapter.getNdef | 獲取Ndef實例,實例支持對NDEF格式的NFC標籤上的NDEF數據的讀寫 | 1.5.0 |
| NFCAdapter.getNfcA | 獲取NfcA實例,實例支持NFC-A(ISO 14443-3A)標準的讀寫 | 1.5.0 |
| NFCAdapter.getNfcB | 獲取NfcB實例,實例支持NFC-B(ISO 14443-3B)標準的讀寫 | 1.5.0 |
| NFCAdapter.getNfcF | 獲取NfcF實例,實例支持NFC-F(JIS 6319-4)標準的讀寫 | 1.5.0 |
| NFCAdapter.getNfcV | 獲取NfcV實例,實例支持NFC-V(ISO 15693)標準的讀寫 | 1.5.0 |
| NFCAdapter.getIsoDep | 獲取IsoDep實例,實例支持ISO-DEP(ISO 14443-4)標準的讀寫 | 1.5.0 |
| NFCAdapter.getMifareClassic | 獲取MifareClassic實例,實例支持MIFARE Classic標籤的讀寫 | 1.5.0 |
| NFCAdapter.getMifareUltralight | 獲取MifareUltralight實例,實例支持MIFARE Ultralight標籤的讀寫 | 1.5.0 |
| NFCAdapter.onDiscovered | 監聽NFC Tag | 1.5.0 |
| NFCAdapter.offDiscovered | 移除NFC Tag的監聽函數 | 1.5.0 |
14.5.3、IsoDep
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| IsoDep.connect | 連接NFC標籤 | 1.5.0 |
| IsoDep.close | 斷開連接 | 1.5.0 |
| IsoDep.setTimeout | 設定超時時間 | 1.5.0 |
| IsoDep.isConnected | 檢查是否已連接 | 1.5.0 |
| IsoDep.getMaxTransceiveLength | 獲取最大傳輸長度 | 1.5.0 |
| IsoDep.transceive | 發送數據 | 1.5.0 |
| IsoDep.getHistoricalBytes | 獲取復位資訊 | 1.5.0 |
14.5.4、MifareClassic
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| MifareClassic.connect | 連接NFC標籤 | 1.5.0 |
| MifareClassic.close | 斷開連接 | 1.5.0 |
| MifareClassic.setTimeout | 設定超時時間 | 1.5.0 |
| MifareClassic.isConnected | 檢查是否已連接 | 1.5.0 |
| MifareClassic.getMaxTransceiveLength | 獲取最大傳輸長度 | 1.5.0 |
| MifareClassic.transceive | 發送數據 | 1.5.0 |
14.5.5、MifareUltralifght
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| MifareUltralifght.connect | 連接NFC標籤 | 1.5.0 |
| MifareUltralifght.close | 斷開連接 | 1.5.0 |
| MifareUltralifght.setTimeout | 設定超時時間 | 1.5.0 |
| MifareUltralifght.getMaxTransceiveLength | 獲取最大傳輸長度 | 1.5.0 | | MifareUltralifght.transceive | 發送數據 | 1.5.0 |
14.5.6、Ndef
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| Ndef.connect | 連接NFC標籤 | 1.5.0 |
| Ndef.close | 斷開連接 | 1.5.0 |
| Ndef.setTimeout | 設定超時時間 | 1.5.0 |
| Ndef.isConnected | 檢查是否已連接 | 1.5.0 |
| Ndef.offNdefMessage | 取消監聽Ndef消息 | 1.5.0 |
| Ndef.onNdefMessage | 監聽Ndef消息 | 1.5.0 |
| Ndef.writeNdefMessage | 重寫Ndef標籤內容 | 1.5.0 |
14.5.7、NfcA
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| NfcA.connect | 連接NFC標籤 | 1.5.0 |
| NfcA.close | 斷開連接 | 1.5.0 |
| NfcA.setTimeout | 設定超時時間 | 1.5.0 |
| IsoDep.isConnected | 檢查是否已連接 | 1.5.0 |
| NfcA.getMaxTransceiveLength | 獲取最大傳輸長度 | 1.5.0 |
| NfcA.transceive | 發送數據 | 1.5.0 |
| NfcA.getAtqa | 獲取ATQA資訊 | 1.5.0 |
| NfcA.getSak | 獲取SAK資訊 | 1.5.0 |
14.5.8、NfcB
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| NfcB.connect | 連接NFC標籤 | 1.5.0 |
| NfcB.close | 斷開連接 | 1.5.0 |
| NfcB.setTimeout | 設定超時時間 | 1.5.0 |
| NfcB.isConnected | 檢查是否已連接 | 1.5.0 |
| NfcB.getMaxTransceiveLength | 獲取最大傳輸長度 | 1.5.0 |
| NfcB.transceive | 發送數據 | 1.5.0 |
14.5.9、NfcF
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| NfcF.connect | 連接NFC標籤 | 1.5.0 |
| NfcF.close | 斷開連接 | 1.5.0 |
| NfcF.setTimeout | 設定超時時間 | 1.5.0 |
| NfcF.isConnected | 檢查是否已連接 | 1.5.0 |
| NfcF.getMaxTransceiveLength | 獲取最大傳輸長度 | 1.5.0 |
| NfcF.transceive | 發送數據 | 1.5.0 |
14.5.10、NfcV
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| NfcV.connect | 連接NFC標籤 | 1.5.0 |
| NfcV.close | 斷開連接 | 1.5.0 |
| NfcV.setTimeout | 設定超時時間 | 1.5.0 |
| NfcV.isConnected | 檢查是否已連接 | 1.5.0 |
| NfcV.getMaxTransceiveLength | 獲取最大傳輸長度 | 1.5.0 |
| NfcV.transceive | 發送數據 | 1.5.0 |
14.6、WiFi
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| onWifiConnected | 監聽連接上Wi-Fi的事件 | 1.5.1 |
| offWifiConnected | 移除連接上Wi-Fi的事件的監聽函數 | 1.5.1 |
| stopWifi | 關閉Wi-Fi模塊 | 1.5.0 |
| startWifi | 初始化Wi-Fi模塊 | 1.5.0 |
| onGetWifiList | 監聽獲取到Wi-Fi清單數據事件 | 1.5.0 |
| offGetWifiList | 移除獲取到Wi-Fi清單數據事件的監聽函數 | 1.5.0 |
| getConnectedWifi | 獲取已連接中的Wi-Fi資訊 | 1.5.0 |
| WifiInfo | Wifi資訊 | 1.5.1 |
14.7、日曆
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| addPhoneRepeatCalendar | 向系統行事曆添加重複事件 | 1.5.1 |
| addPhoneCalendar | 向系統行事曆添加事件 | 1.5.1 |
14.8、剪切板
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| setClipboardData | 設定系統剪貼板的內容 | 1.5.1 |
| getClipboardData | 獲取系統剪貼板的內容 | 1.5.1 |
14.9、網絡
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| onNetworkStatusChange | 監聽網絡狀態變化事件 | 1.5.1 |
| getNetworkType | 獲取網絡類型 | 1.5.1 |
| offNetworkStatusChange | 移除網絡狀態變化事件的監聽函數 | 1.5.1 |
14.10、加密
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| getRandomValues | 獲取密碼學安全亂數 | 1.5.1 |
14.11、鍵盤
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| onKeyboardHeightChange | 監聽鍵盤高度變化事件 | 1.5.1 |
| hideKeyboard | 在input、textarea等focus拉起鍵盤之後,手動調用此接口收起鍵盤 | 1.5.1 |
| offKeyboardHeightChange | 移除鍵盤高度變化事件的監聽函數 | 1.5.1 |
| getSelectedTextRange | 在input、textarea等focus之後,獲取輸入框的光標位置 | 1.5.1 |
14.12、電話
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| makePhoneCall | 撥打電話 | 1.5.1 |
14.13、加速計
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| startAccelerometer | 開始監聽加速度數據 | 1.5.1 |
| stopAccelerometer | 停止監聽加速度數據 | 1.5.1 |
| onAccelerometerChange | 監聽加速度數據事件 | 1.5.1 |
| offAccelerometerChange | 移除加速度數據事件的監聽函數 | 1.5.1 |
14.14、羅盤
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| startCompass | 開始監聽羅盤數據 | 1.5.0 |
| stopCompass | 停止監聽羅盤數據 | 1.5.0 |
| onCompassChange | 監聽羅盤數據變化事件 | 1.5.0 |
| offCompassChange | 移除羅盤數據變化事件的監聽函數 | 1.5.0 |
14.15、陀螺儀
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| startGyroscope | 開始監聽陀螺儀數據 | 1.5.1 |
| stopGyroscope | 停止監聽陀螺儀數據 | 1.5.1 |
| onGyroscopeChange | 監聽陀螺儀數據變化事件 | 1.5.1 |
| offGyroscopeChange | 移除陀螺儀數據變化事件的監聽函數 | 1.5.1 |
14.16、掃碼
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| scanCode | 調起用戶端掃碼介面進行掃碼 | 1.5.0 |
14.17、簡訊
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| sendSms | 拉起手機發送短信介面 | 1.5.1 |
14.18、振動
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| vibrateShort | 使手機發生較短時間的振動(15 ms) | 1.5.1 |
| vibrateLong | 使手機發生較長時間的振動(400 ms) | 1.5.1 |
14.19、聯絡人
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| chooseContact | 拉起手機通訊錄,選擇聯絡人 | 1.5.1 |
| addPhoneContact | 添加手機通訊錄聯絡人 | 1.5.1 |
14.20、電量
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| getBatteryInfoSync | wx.getBatteryInfo的同步版本 | 1.5.1 |
| getBatteryInfo | 獲取設備電量 | 1.5.1 |
14.21、屏慕
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| setVisualEffectOnCapture | 設定截圖/錄屏時荧幕表現 | 1.5.1 |
| setScreenBrightness | 設定荧幕亮度 | 1.5.1 |
| setKeepScreenOn | 設定是否保持常亮狀態 | 1.5.1 |
| onUserCaptureScreen | 監聽用戶主動截圖事件 | 1.5.1 |
| onScreenRecordingStateChanged | 監聽用戶錄屏事件 | 1.5.1 |
| offUserCaptureScreen | 用戶主動截圖事件 | 1.5.1 |
| offScreenRecordingStateChanged | 移除用戶錄屏事件的監聽函數 | 1.5.1 |
| getScreenRecordingState | 査詢用戶是否在錄屏 | 1.5.1 |
| getScreenBrightness | 獲取荧幕亮度 | 1.5.1 |
14.22、設備方向
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| stopDeviceMotionListening | 停止監聽設備方向的變化 | 1.5.1 |
| startDeviceMotionListening | 開始監聽設備方向的變化 | 1.5.1 |
| onDeviceMotionChange | 監聽設備方向變化事件 | 1.5.1 |
| offDeviceMotionChange | 移除設備方向變化事件的監聽函數 | 1.5.1 |
14.23、記憶體
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| onMemoryWarning | 監聽記憶體不足告警事件 | 1.5.1 |
| offMemoryWarning | 移除記憶體不足告警事件的監聽函數 | 1.5.1 |
14.24、無障礙
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| checkIsOpenAccessibility | 檢測是否開啟視覺無障礙功能 | 1.5.1 |
15、WXML
15.1、WXML概要
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| createSelectorQuery | 返回一個SelectorQuery對象實例 | 1.5.0 |
| createIntersectionObserver | 創建並返回一個IntersectionObserver對象實例 | 1.5.0 |
15.2、IntersectionObserve
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| IntersectionObserve.relativeTo | 使用選擇器指定一個節點,作為參照區域之一 | 1.5.0 |
| IntersectionObserve.relativeToViewport | 指定頁面顯示區域作為參照區域之一。 | 1.5.0 |
| IntersectionObserve.disconnect | 停止監聽。 回呼函數將不再觸發。 | 1.5.0 |
| IntersectionObserve.observe | 指定目標節點並開始監聽相交狀態變化情况。 | 1.5.0 |
15.3、NodesRef
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| NodesRef.fields | 獲取節點的相關資訊 | 1.5.0 |
| NodesRef.boundingClientRect | 添加節點的佈局位置的査詢請求 | 1.5.0 |
| NodesRef.scrollOffset | 添加節點的滾動位置査詢請求 | 1.5.0 |
| NodesRef.context | 添加節點的Context對象査詢請求 | 1.5.0 |
| NodesRef.node | 獲取Node節點實例 | 1.5.0 |
15.4、SelectorQuery
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| SelectorQuery.exec | 執行所有的請求 | 1.5.0 |
| SelectorQuery.in | 將選擇器的選取範圍更改為自定義組件component內 | 1.5.0 |
| SelectorQuery.select | 在當前頁面下選擇第一個匹配選擇器selector的節點 | 1.5.0 |
| SelectorQuery.selectAll | 在當前頁面下選擇匹配選擇器selector的所有節點。 | 1.5.0 |
| SelectorQuery.selectViewport | 選擇顯示區域 | 1.5.0 |
15.5、meidaQueryObserver
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| MediaQueryObserver.disconnect | 停止監聽。 | 1.5.16 |
| MediaQueryObserver.observe | 開始監聽頁面media query變化情况。 | 1.5.16 |
16、自定義API
| 名稱 | 功能說明 | 最低版本 |
|---|---|---|
| invokeNativePlugin | 自定義API | 1.5.0 |