Skip to content

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創建一個動畫實例animation1.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 matrix1.5.0
Animation.matrix3d同transform-function matrix3d1.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請求,返回文件的本地臨時路徑(本地路徑),單次下載允許的最大文件為200MB1.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從本地緩存中移除指定key1.5.0
removeStorageSyncremoveStorage的同步版本1.5.0
getStorage從本地緩存中非同步獲取指定key的內容1.5.0
createBufferURL根據傳入的buffer創建一個唯一的URL存在記憶體中1.5.35
getStorageSync從本地緩存中同步獲取指定key的內容1.5.0
getStorageInfo非同步獲取當前storage的相關資訊1.5.0
getStorageInfoSyncgetStorageInfo的同步版本1.5.0
clearStorage清理本地數據緩存1.5.0
clearStorageSyncclearStorage的同步版本1.5.0
batchSetStorage將數據批量存儲在本地緩存中指定的key中1.5.16
batchSetStorageSyncbatchSetStorage的同步版本1.5.16
batchGetStorage從本地緩存中非同步批量獲取指定key的內容。1.5.16
batchGetStorageSyncbatchGetStorage的同步版本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
ImageDataImageData對象1.5.16
RenderingContextCanvas繪圖上下文1.5.16

9.2、canvasContext

名稱功能說明最低版本
CanvasContext.arc創建一條弧線1.5.0
CanvasContext.arcTo根據控制點和半徑繪製圓弧路徑1.5.0
CanvasContext.beginPath開始創建一個路徑1.5.0
CanvasContext.bezierCurveTo創建三次方貝塞爾曲線路徑1.5.0
CanvasContext.clearRect清除畫布上在該矩形區域內的內容1.5.0
CanvasContext.clip從原始畫布中剪切任意形狀和尺寸1.5.0
CanvasContext.closePath關閉一個路徑1.5.0
CanvasContext.createCircularGradient創建一個圓形的漸變顏色1.5.0
CanvasContext.createLinearGradient創建一個線性的漸變顏色1.5.0
CanvasContext.createPattern對指定的影像創建模式的方法,可在指定的方向上重複元影像1.5.0
CanvasContext.draw將之前在繪圖上下文中的描述(路徑、變形、樣式)畫到canvas中1.5.0
CanvasContext.drawImage繪製影像到畫布1.5.0
CanvasContext.fill對當前路徑中的內容進行填充1.5.0
CanvasContext.fillRect填充一個矩形1.5.0
CanvasContext.fillText在畫布上繪製被填充的文字1.5.0
CanvasContext.lineTo新增一個新點,然後創建一條從上次指定點到目標點的線1.5.0
CanvasContext.measureText量測文字尺寸資訊1.5.0
CanvasContext.moveTo把路徑移動到畫布中的指定點,不創建線條1.5.0
CanvasContext.quadraticCurveTo創建二次貝塞爾曲線路徑1.5.0
CanvasContext.rect創建一個矩形路徑1.5.0
CanvasContext.restore恢復之前保存的繪圖上下文1.5.0
CanvasContext.rotate以原點為中心順時針旋轉當前坐標軸1.5.0
CanvasContext.save保存繪圖上下文1.5.0
CanvasContext.scale在調用後,之後創建的路徑其橫縱坐標會被縮放1.5.0
CanvasContext.setFillStyle設定填充色1.5.0
CanvasContext.setFontSize設定字體的字號1.5.0
CanvasContext.setGlobalAlpha設定全域畫筆透明度1.5.0
CanvasContext.setLineCap設定線條的端點樣式1.5.0
CanvasContext.setLineDash設定虛線樣式1.5.0
CanvasContext.setLineJoin設定線條的交點樣式1.5.0
CanvasContext.setLineWidth設定線條的寬度1.5.0
CanvasContext.setMiterLimit設定最大斜接長度1.5.0
CanvasContext.setShadow設定陰影樣式1.5.0
CanvasContext.setStrokeStyle設定描邊顏色1.5.0
CanvasContext.setTextAlign設定文字的對齊。1.5.0
CanvasContext.setTextBaseline設定文字的豎直對齊1.5.0
CanvasContext.setTransform使用矩陣重新設定(覆蓋)當前變換的方法1.5.0
CanvasContext.stroke畫出當前路徑的邊框1.5.0
CanvasContext.strokeRect畫一個矩形(非填充)1.5.0
CanvasContext.strokeText給定的(x,y)位置繪製文字描邊的方法1.5.0
CanvasContext.transform使用矩陣多次疊加當前變換的方法1.5.0
CanvasContext.translate對當前坐標系的原點(0,0)進行變換1.5.0

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 URl1.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、地圖

名稱功能說明最低版本
createMapContext創建map上下文MapContext對象1.5.0
MapContext.addArc添加弧線1.5.16
MapContext.addCustomLayer添加個性化圖層1.5.16
MapContext.addGroundOverlay創建自定義圖片圖層1.5.16
MapContext.addMarkers添加marker1.5.0
MapContext.eraseLines擦除或置灰已添加到地圖中的線段1.5.16
MapContext.fromScreenLocation獲取荧幕上的點對應的經緯度,座標原點為地圖左上角1.5.0
MapContext.getCenterLocation獲取當前地圖中心的經緯度1.5.0
MapContext.getRegion獲取當前地圖的視野範圍1.5.0
MapContext.getRotate獲取當前地圖的旋轉角1.5.0
MapContext.getScale獲取當前地圖的縮放級別1.5.0
MapContext.getSkew獲取當前地圖的傾斜角1.5.0
MapContext.includePoints縮放視野展示所有經緯度1.5.0
MapContext.initMarkerCluster初始化點聚合的配置1.5.16
MapContext.moveAlong沿指定路徑移動marker,用於軌跡重播等場景1.5.0
MapContext.moveToLocation將地圖中心移置當前定位點,此時需設定地圖組件show-location為true1.5.0
MapContext.on監聽地圖事件1.5.16
MapContext.openMapApp拉起地圖APP選擇導航1.5.0
MapContext.removeArc删除弧線1.5.16
MapContext.removeCustomLayer移除個性化圖層1.5.16
MapContext.removeGroundOverlay移除自定義圖片圖層1.5.16
MapContext.removeMarkers移除marker1.5.0
MapContext.setBoundary限制地圖的顯示範圍1.5.16
MapContext.setCenterOffset設定地圖中心點偏移1.5.16
MapContext.setLocMarkerIcon設定定位點圖標1.5.16
MapContext.toScreenLocation獲取經緯度對應的荧幕座標1.5.16
MapContext.translateMarker平移marker,帶動畫1.5.0
MapContext.updateGroundOverlay更新自定義圖片圖層。1.5.16

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、實时音視頻

名稱功能說明最低版本
createLivePusherContext創建live-pusher上下文LivePusherContext對象1.5.0
createLivePlayerContext創建live-player上下文LivePlayerContext對象1.5.0
LivePlayerContext.exitfullscreen退出全屏1.5.0
LivePlayerContext.mute靜音1.5.0
LivePlayerContext.pause暫停1.5.0
LivePlayerContext.play播放1.5.0
LivePlayerContext.requestFullScreen進入全屏1.5.0
LivePlayerContext.resume恢復1.5.0
LivePlayerContext.snapshot截圖1.5.0
LivePlayerContext.stop停止1.5.0
LivePusherContext.start開始推流,同時開啟監視器預覽1.5.0
LivePusherContext.stop停止推流,同時停止監視器預覽1.5.0
LivePusherContext.pause暫停推流1.5.0
LivePusherContext.resume恢復推流1.5.0
LivePusherContext.switchCamera切換前後監視器1.5.0
LivePusherContext.snapshot快照1.5.0
LivePusherContext.toggleTorch切換手電筒1.5.0
LivePusherContext.playBGM播放背景音1.5.0
LivePusherContext.stopBGM停止背景音1.5.0
LivePusherContext.pauseBGM暫停背景音1.5.0
LivePusherContext.resumeBGM恢復背景音1.5.0
LivePusherContext.setBGMPosition設定背景音進度1.5.0
LivePusherContext.setMICVolume設定麥克風音量1.5.0
LivePusherContext.setBGMVolume設定背景音量1.5.0
LivePusherContext.setAudioReverbType設定混音類型1.5.0
LivePusherContext.startPreview開啟監視器預覽1.5.0
LivePusherContext.stopPreview關閉監視器預覽1.5.0
LivePusherContext.startAudioRecord開始錄音1.5.0
LivePusherContext.stopAudioRecord結束錄音1.5.0

10.4、音訊

名稱功能說明最低版本
stopVoice結束播放語音1.5.1
playVoice開始播放語音1.5.1
pauseVoice暫停正在播放的語音1.5.1
setInnerAudioOption設定InnerAudioContext的播放選項1.5.0
getAvailableAudioSources獲取當前支持的音訊輸入源1.5.1
createInnerAudioContext創建內部'audio'組件上下文InnerAudioContext對象1.5.0
AudioContext.pause暫停音訊1.5.1
AudioContext.play播放音訊1.5.1
AudioContext.seek跳轉到指定位置1.5.1
AudioContext.setSrc設定音訊地址1.5.1
InnerAudioContext.destroy銷毀當前實例1.5.0
InnerAudioContext.offCanplay移除音訊進入可以播放狀態的事件的監聽函數1.5.0
InnerAudioContext.offEnded移除音訊自然播放至結束的事件的監聽函數1.5.0
InnerAudioContext.offError移除音訊播放錯誤事件的監聽函數1.5.0
InnerAudioContext.offPause移除音訊暫停事件的監聽函數1.5.0
InnerAudioContext.offPlay移除音訊播放事件的監聽函數1.5.0
InnerAudioContext.offSeeked移除音訊完成跳轉操作的事件的監聽函數1.5.0
InnerAudioContext.offSeeking移除音訊進行跳轉操作的事件的監聽函數1.5.0
InnerAudioContext.offStop移除音訊停止事件的監聽函數1.5.0
InnerAudioContext.offTimeUpdate移除音訊播放進度更新事件的監聽函數1.5.0
InnerAudioContext.offWaiting移除音訊加載中事件的監聽函數1.5.0
InnerAudioContext.onCanplay監聽音訊進入可以播放狀態的事件1.5.0
InnerAudioContext.onEnded監聽音訊自然播放至結束的事件1.5.0
InnerAudioContext.onError監聽音訊播放錯誤事件1.5.0
InnerAudioContext.onPause監聽音訊暫停事件1.5.0
InnerAudioContext.onPlay監聽音訊播放事件1.5.0
InnerAudioContext.onSeeked監聽音訊完成跳轉操作的事件1.5.0
InnerAudioContext.onSeeking監聽音訊進行跳轉操作的事件1.5.0
InnerAudioContext.onStop監聽音訊停止事件1.5.0
InnerAudioContext.onTimeUpdate監聽音訊播放進度更新事件1.5.0
InnerAudioContext.onWaiting監聽音訊加載中事件1.5.0
InnerAudioContext.pause暫停1.5.0
InnerAudioContext.play播放1.5.0
InnerAudioContext.seek跳轉到指定位置1.5.0
InnerAudioContext.stop停止1.5.0

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獲取全域唯一的錄音管理器RecorderManager1.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、背景音频

名稱功能說明最低版本
stopBackgroundAudio停止播放音樂1.5.1
seekBackgroundAudio控制音樂播放進度1.5.1
playBackgroundAudio使用後臺播放機播放音樂1.5.1
pauseBackgroundAudio暫停播放音樂監聽音樂停止事件1.5.1
onBackgroundAudioStop監聽音樂停止事件1.5.1
onBackgroundAudioPlay監聽音樂播放事件1.5.1
onBackgroundAudioPause監聽音樂暫停事件1.5.1
getBackgroundAudioPlayerState獲取後臺音樂播放狀態1.5.1
getBackgroundAudioManager獲取全域唯一的背景音频管理器1.5.1
BackgroundAudioManager.onCanplay監聽背景音频進入可播放狀態事件1.5.16
BackgroundAudioManager.onEnded監聽背景音频自然播放結束事件1.5.16
BackgroundAudioManager.onError監聽背景音频播放錯誤事件1.5.16
BackgroundAudioManager.onNext監聽用戶在系統音樂播放面板點擊下一曲事件(僅iOS)1.5.16
BackgroundAudioManager.onPause監聽背景音频暫停事件1.5.16
BackgroundAudioManager.onPlay監聽背景音频播放事件1.5.16
BackgroundAudioManager.onPrev監聽用戶在系統音樂播放面板點擊上一曲事件(僅iOS)1.5.16
BackgroundAudioManager.onSeeked監聽背景音频完成跳轉操作事件1.5.16
BackgroundAudioManager.onSeeking監聽背景音频開始跳轉操作事件1.5.16
BackgroundAudioManager.onStop監聽背景音频停止事件1.5.16
BackgroundAudioManager.onTimeUpdate監聽背景音频播放進度更新事件1.5.16
BackgroundAudioManager.onWaiting監聽音訊加載中事件1.5.16
BackgroundAudioManager.pause暫停音樂1.5.16
BackgroundAudioManager.play播放音樂1.5.16
BackgroundAudioManager.seek跳轉到指定位置1.5.16
BackgroundAudioManager.stop停止音樂1.5.16

10.10、富文本

名稱功能說明最低版本
EditorContextEditorContext實例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

名稱功能說明最低版本
FileSystemManager.access判斷文件/目錄是否存在1.5.0
FileSystemManager.accessSyncFileSystemManager.access的同步版本1.5.0
FileSystemManager.appendFile在文件結尾追加內容1.5.0
FileSystemManager.appendFileSyncFileSystemManager.appendFile的同步版本1.5.0
FileSystemManager.close關閉文件1.5.16
FileSystemManager.closeSync同步關閉文件1.5.16
FileSystemManager.copyFile複製文件1.5.0
FileSystemManager.copyFileSyncFileSystemManager.copyFile的同步版本1.5.0
FileSystemManager.fstat獲取文件的狀態資訊。1.5.16
FileSystemManager.fstatSync同步獲取文件的狀態資訊。1.5.16
FileSystemManager.ftruncate對文件內容進行截斷操作FileSystemManager.open1.5.16
FileSystemManager.ftruncateSync對文件內容進行截斷操作。1.5.16
FileSystemManager.getFileInfo獲取該小程序下的本地暫存文件或本地緩存文件資訊。1.5.0
FileSystemManager.getSavedFileList獲取該小程序下已保存的本地緩存文件清單。1.5.0
FileSystemManager.mkdir創建目錄1.5.0
FileSystemManager.mkdirSyncFileSystemManager.mkdir的同步版本1.5.0
FileSystemManager.open打開文件,返回檔描述符1.5.16
FileSystemManager.openSync同步打開文件,返回檔描述符。1.5.16
FileSystemManager.read讀文件1.5.16
FileSystemManager.readSync讀文件1.5.16
FileSystemManager.readCompressedFile讀取指定壓縮類型的本地文件內容。1.5.16
FileSystemManager.readCompressedFileSync同步讀取指定壓縮類型的本地文件內容。1.5.16
FileSystemManager.readdir讀取目錄內文件清單1.5.0
FileSystemManager.readdirSyncFileSystemManager.readdir的同步版本1.5.0
FileSystemManager.readFile讀取本地文件內容1.5.0
FileSystemManager.readFileSyncFileSystemManager.readFile的同步版本1.5.0
FileSystemManager.readZipEntry讀取壓縮包內的文件1.5.16
FileSystemManager.removeSavedFile删除該小程序下已保存的本地緩存文件1.5.0
FileSystemManager.rename重命名文件1.5.0
FileSystemManager.renameSyncFileSystemManager.rename的同步版本1.5.0
FileSystemManager.rmdir删除目錄1.5.0
FileSystemManager.rmdirSyncFileSystemManager.rmdir的同步版本1.5.0
FileSystemManager.saveFile保存暫存文件到本地1.5.0
FileSystemManager.saveFileSyncFileSystemManager.saveFile的同步版本1.5.0
FileSystemManager.stat獲取文件Stats對象1.5.0
FileSystemManager.statSyncFileSystemManager.stat的同步版本1.5.0
FileSystemManager.truncate對文件內容進行截斷操作。1.5.16
FileSystemManager.truncateSync對文件內容進行截斷操作(truncate的同步版本)1.5.16
FileSystemManager.unlink刪除文件1.5.0
FileSystemManager.unlinkSyncFileSystemManager.unlink的同步版本1.5.0
FileSystemManager.unzip解壓文件1.5.0
FileSystemManager.write寫入文件1.5.16
FileSystemManager.writeSync同步寫入文件1.5.16
FileSystemManager.writeFile寫文件1.5.0
FileSystemManager.writeFileSyncFileSystemManager.writeFile的同步版本1.5.0

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、藍牙-低功耗周邊設備

名稱功能說明最低版本
onBLEPeripheralConnectionStateChanged監聽當前周邊設備被連接或斷開連接事件1.5.1
offBLEPeripheralConnectionStateChanged移除當前周邊設備被連接或斷開連接事件的監聽函數。1.5.1
createBLEPeripheralServer建立本地作為藍牙低功耗周邊設備的服務端1.5.1
BLEPeripheraServer.addService添加服務。1.5.1
BLEPeripheraServer.removeService移除服務。1.5.1
BLEPeripheraServer.startAdvertising開始廣播本地創建的周邊設備1.5.1
BLEPeripheraServer.stopAdvertising停止廣播1.5.1
BLEPeripheraServer.writeCharacteristicValue往指定特徵寫入二進位數據值,並通知已連接的主機1.5.1
BLEPeripheraServer.onCharacteristicWriteRequest監聽已連接的設備請求寫當前周邊設備的特徵值事件1.5.1
BLEPeripheraServer.offCharacteristicWriteRequest移除已連接的設備請求寫當前周邊設備的特徵值事件的監聽函數1.5.1
BLEPeripheraServer.onCharacteristicReadRequest監聽已連接的設備請求讀當前周邊設備的特徵值事件1.5.1
BLEPeripheraServer.offCharacteristicReadRequest移除已連接的設備請求讀當前周邊設備的特徵值事件的監聽函數1.5.1
BLEPeripheraServer.onCharacteristicSubscribed監聽特徵訂閱事件,僅iOS支持1.5.1
BLEPeripheraServer.offCharacteristicSubscribed移除特徵訂閱事件的監聽函數1.5.1
BLEPeripheraServer.onCharacteristicUnsubscribed監聽取消特徵訂閱事件,僅iOS支持1.5.1
BLEPeripheraServer.offCharacteristicUnsubscribed移除取消特徵訂閱事件的監聽函數1.5.1

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
BeaconInfoBeacon設備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 Tag1.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
WifiInfoWifi資訊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、電量

名稱功能說明最低版本
getBatteryInfoSyncwx.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自定義API1.5.0