本文介紹uni-app小程式JSAPI的能力和使用方式，便於您在使用uni-app小程式JSAPI時參考。
本文介紹的JSAPI是參見uni-app官網的JSAPI。本文列舉的JSAPI適用於Superapp的uni-app小程式，未列舉的JSAPI均不適用。調用此類JSAPI的小程式支援投放到您自己開發的Superapp平台。
基礎
名稱 | 功能說明 | 連結 |
uni.base64ToArrayBuffer | 將Base64字串轉成ArrayBuffer對象。 | |
uni.arrayBufferToBase64 | 將ArrayBuffer對象轉成Base64字串。 | |
uni.getLaunchOptionsSync | 擷取啟動時的參數。 | |
uni.getEnterOptionsSync | 擷取啟動時的參數。 | |
uni.addInterceptor | 添加攔截器。 | |
uni.removeInterceptor | 刪除攔截器。 | |
uni.canIUse | 判斷應用的 API，回調，參數，組件等是否在目前的版本可用。 |
網路
發起請求
名稱 | 功能說明 | 連結 |
uni.request | 發起網路請求。 |
上傳/下載
名稱 | 功能說明 | 連結 |
uni.uploadFile | 將本地資源上傳到開發人員伺服器，用戶端發起一個 | |
uni.downloadFile | 下載檔案資源到本地，用戶端直接發起一個 |
WebSocket
名稱 | 功能說明 | 連結 |
uni.connectSocket | 建立一個WebSocket串連。 | |
uni.onSocketOpen | 監聽WebSocket串連開啟事件。 | |
uni.onSocketError | 監聽WebSocket錯誤。 | |
uni.sendSocketMessage | 通過WebSocket串連發送資料，需要先調用uni.connectSocket，並在uni.onSocketOpen回調之後才能發送。 | |
uni.onSocketMessage | 監聽WebSocket接受到伺服器的訊息事件。 | |
uni.closeSocket | 關閉WebSocket串連。 | |
uni.onSocketClose | 監聽WebSocket關閉。 |
SocketTask
名稱 | 功能說明 | 連結 |
SocketTask.onMessage | 監聽WebSocket接收到伺服器的訊息事件。 | |
SocketTask.send | 通過WebSocket串連發送資料。 | |
SocketTask.close | 關閉WebSocket串連。 | |
SocketTask.onOpen | 監聽WebSocket串連開啟事件。 | |
SocketTask.onClose | 監聽WebSocket串連關閉事件。 | |
SocketTask.onError | 監聽WebSocket錯誤事件。 |
頁面路由
名稱 | 功能說明 | 連結 |
uni.navigateTo | 保留當前頁面，跳轉到應用內的某個頁面，使用uni.navigateBack可以返回到原頁面。 | |
uni.redirectTo | 關閉當前頁面，跳轉到應用內的某個頁面。 | |
uni.reLaunch uni.reLaunch | 關閉所有頁面，開啟到應用內的某個頁面。 | |
uni.switchTab uni.switchTab | 跳轉到TabBar頁面，並關閉其他所有非TabBar頁面 | |
uni.navigateBack uni.navigateBack | 關閉當前頁面，返回上一頁面或多級頁面。可通過 getCurrentPages() 擷取當前的頁面棧，決定需要返回幾層。 | |
uni.preloadPage uni.preloadPage | 預先載入頁面，是一種效能最佳化技術。被預載的頁面，在開啟時速度更快。 |
EventChannel
名稱 | 功能說明 | 連結 |
EventChannel.emit | 觸發一個事件。 | |
EventChannel.off | 取消監聽一個事件。 | |
EventChannel.on | 持續監聽一個事件。 | |
EventChannel.once | 監聽一個事件一次，觸發後失效。 |
視窗動畫
視窗的顯示/關閉動畫效果，支援在 API、組件、pages.json 中配置，優先順序為：API = 組件 > pages.json，詳細說明請參見視窗動畫。
頁面通訊
名稱 | 功能說明 | 連結 |
uni.$emit | 觸發全域的自訂事件，附加參數都會傳給監聽器回呼函數 | |
uni.$on | 監聽全域的自訂事件，事件由 uni.$emit觸發，回呼函數會接收事件觸發函數的傳入參數。 | |
uni.$once | 監聽全域的自訂事件，事件由 uni.$emit觸發，但僅觸發一次，在第一次觸發之後移除該監聽器。 | |
uni.$off | 移除全域自訂事件監聽器。 |
subNVue原生子表單
名稱 | 功能說明 | 連結 |
uni.getSubNVueById | 通過ID擷取subNVues原生子表單的執行個體。 | |
uni.getCurrentSubNVue | 在一個subnvue表單的nvue頁面代碼中，擷取當前subNVues原生子表單的執行個體。 | |
subNVue.show | 顯示原生子表單。 | |
subNVue.hide | 隱藏原生子表單。 |
資料緩衝
名稱 | 功能說明 | 連結 |
uni.setStorage | 將資料存放區在本機快取中指定的key中，會覆蓋掉原來該key對應的內容，這是一個非同步介面。 | |
uni.setStorageSync | 將資料存放區在本機快取中指定的key中，會覆蓋掉原來該key對應的內容，這是一個同步介面。 | |
uni.getStorage | 從本機快取中非同步擷取指定key對應的內容。 | |
uni.getStorageSync | 從本機快取中同步擷取指定key對應的內容。 | |
uni.getStorageInfo | 非同步擷取當前storage的相關資訊。 | |
uni.getStorageInfoSync | 同步擷取當前storage的相關資訊。 | |
uni.removeStorage | 從本機快取中非同步移除指定key。 | |
uni.removeStorageSync | 從本機快取中同步移除指定key。 | |
uni.clearStorage | 清理本機資料緩衝。 | |
uni.clearStorageSync | 同步清理本機資料緩衝。 |
位置
擷取位置
名稱 | 功能說明 | 連結 |
uni.getLocation | 擷取當前的地理位置、速度。 | |
uni.chooseLocation | 開啟地圖選擇位置。 | |
plus.geolocation.getCurrentPosition | 擷取當前裝置位置資訊。 |
更新位置
名稱 | 功能說明 | 連結 |
uni.onLocationChange | 監聽即時地理位置變化事件，需結合uni.startLocationUpdate或 uni.startLocationUpdateBackground使用。 | |
uni.offLocationChange | 關閉監聽即時位置變化，前後台都停止訊息接收。 | |
uni.onLocationChangeError | 監聽持續定位介面返回失敗時觸發。 | |
uni.offLocationChangeError | 取消註冊位置更新錯誤回調。 | |
uni.startLocationUpdate | 開啟小程式進入前台時接收位置訊息。 | |
uni.stopLocationUpdate | 關閉監聽即時位置變化，前後台都停止訊息接收。 | |
uni.startLocationUpdateBackground | 開始監聽即時地理位置資訊變化事件，小程式進入前後台時均接收即時地理位置資訊。 | |
plus.geolocation.watchPosition | 監聽裝置位置變化資訊。 | |
plus.geolocation.clearWatch | 關閉監聽裝置位置資訊。 |
地圖組件控制
名稱 | 功能說明 | 連結 |
uni.createMapContext | 建立並返回map上下文mapContext對象。在自訂群組件下，第二個參數傳入組件執行個體this，以操作組件內<map>組件。 | |
plus.maps.openSysMap | 調用系統第三方程式進行導航。 | |
plus.maps.create | 建立Map對象。 | |
plus.maps.getMapById | 尋找已經建立的Map對象。 |
媒體
圖片
名稱 | 功能說明 | 連結 |
uni.chooseImage | 從本地相簿選擇圖片或使用相機拍照。 | |
uni.previewImage | 預覽圖片。 | |
uni.closePreviewImage | 關閉預覽圖片。 | |
uni.getImageInfo | 擷取圖片資訊。 | |
uni.saveImageToPhotoAlbum | 儲存圖片到系統相簿。 | |
uni.compressImage | 壓縮圖片介面，可選壓縮品質。 | |
plus.gallery.pick | 從本地相簿選擇圖片或視頻。 | |
plus.gallery.save | 儲存檔案到系統相簿中。 |
網路攝影機
名稱 | 功能說明 | 連結 |
plus.camera.getCamera | 擷取網路攝影機管理對象。 |
錄音管理
名稱 | 功能說明 | 連結 |
ni.getRecorderManager | 擷取全域唯一的錄音管理器recorderManager。 | |
plus.audio.getRecorder | 擷取當前裝置的錄音對象。 | |
plus.audio.createPlayer | 建立音頻播放器對象。 |
背景音頻播放管理
名稱 | 功能說明 | 連結 |
uni.getBackgroundAudioManager | 擷取全域唯一的背景音頻管理器backgroundAudioManager。 |
音頻組件控制
名稱 | 功能說明 | 連結 |
uni.createInnerAudioContext | 建立並返回內部audio上下文innerAudioContext對象。 |
視頻
名稱 | 功能說明 | 連結 |
uni.chooseVideo https://en.uniapp.dcloud.io/api/media/video.html | 拍攝視頻或從手機相簿中選視頻，返回視頻的臨時檔案路徑。 | |
uni.saveVideoToPhotosAlbum | 儲存視頻到系統相簿。 | |
uni.getVideoInfo | 擷取視頻詳細資料。 | |
uni.compressVideo | 壓縮視頻介面。 | |
plus.video.createVideoPlayer | 建立VideoPlayer對象。 | |
plus.video.createLivePusher | 建立LibePusher對象。 | |
plus.video.getVideoPlayerById | 尋找已經建立的VideoPlayer對象。 | |
plus.video.getLivePusherById | 尋找已經建立的LibePusher對象。 |
視頻組件控制
名稱 | 功能說明 | 連結 |
uni.createVideoContext | 建立並返回video上下文videoContext對象。在自訂群組件下，第二個參數傳入組件執行個體this，以操作組件內<video>組件。 |
裝置
系統
名稱 | 功能說明 | 連結 |
uni.getSystemInfo | 非同步擷取系統資訊。 | |
uni.getSystemInfoSync | 同步擷取系統資訊。 | |
uni.getDeviceInfo | 擷取裝置基礎資訊。 | |
uni.getWindowInfo | 擷取視窗資訊。 | |
uni.getSystemSetting | 擷取裝置設定。 | |
uni.openAppAuthorizeSetting | 跳轉系統授權管理頁。 | |
plus.device.beep | 發出蜂鳴聲。 | |
plus.device.getInfo | 擷取裝置資訊。 | |
plus.device.getOAID | 擷取匿名裝置標識符。 | |
plus.device.getVAID | 擷取開發人員匿名裝置標識。 | |
plus.device.getAAID | 擷取應用匿名裝置標識符。 | |
plus.device.getDeviceId | 擷取DCloud匿名裝置標識符。 | |
plus.device.getVolume | 擷取裝置系統音量。 | |
plus.device.setVolume | 設定裝置的系統音量。 | |
plus.device.isWakelock | 擷取程式是都一直保持喚醒狀態。 | |
plus.device.setWakelock | 設定應用是否保持喚醒狀態。 | |
plus.device.virate | 裝置震動。 | |
plus.navigator.checkPermission | 檢查運行環境的許可權。 | |
plus.navigator.closeSplashscreen | 關閉應用啟動介面。 | |
plus.navigator.hasNotchInScreen | 查詢裝置是否為劉海屏。 | |
plus.navigator.hasSplashscreen | 查詢應用啟動介面是否已關閉。 | |
plus.navigator.updateSplashscreen | 更新程式啟動介面。 | |
plus.navigator.createShortcut | 建立應用捷徑。 | |
plus.navigator.hasShortcut | 查詢是否存在應用捷徑。 | |
plus.navigator.hideSystemNavigation | 隱藏系統虛擬按鍵。 | |
plus.navigator.showSystemNavigation | 顯示系統虛擬按鍵。 | |
plus.navigator.isBackground | 判斷當前應用是否切換到後台。 | |
plus.navigator.isFullscreen | 判斷應用當前是否全螢幕模式。 | |
plus.navigator.isLogs | 判斷應用當前是否輸出日誌。 | |
plus.navigator.isRoot | 判斷當前裝置是否被Root破解。 | |
plus.navigator.isSimulator | 判斷當前應用是否運行在模擬器中。 | |
plus.navigator.setFullscreen | 設定應用是否全螢幕顯示。 | |
plus.navigator.setLogs | 設定應用是否輸出日誌。 | |
plus.navigator.setStatusBarBackground | 設定系統狀態列背景顏色。 | |
plus.navigator.getStatusBarBackground | 擷取系統狀態列背景顏色。 | |
plus.navigator.setStatusBarStyle | 設定系統狀態列樣式。 | |
plus.navigator.getStatusBarStyle | 擷取系統狀態列樣式。 | |
plus.navigator.getStatusbarHeight | 擷取系統狀態列高度。 | |
plus.navigator.isImmersedStatusbar | 判斷當前是否為沈浸式狀態列模式。 | |
plus.navigator.setUserAgent | 設定userAgent。 | |
plus.navigator.getUserAgent | 擷取userAgent。 | |
plus.navigator.setCookie | 設定Cookie值。 | |
plus.navigator.getCookie | 擷取Cookie值。 | |
plus.navigator.removeAllCookie | 刪除應用所有Cookie值。 | |
plus.navigator.removeCookie | 刪除應用Cookie。 | |
plus.navigator.removeSessionCooki | 刪除應用所有會話期Cookie值。 | |
plus.navigator.getSafeAreaInsets | 擷取應用的安全區域。 | |
plus.navigator.getOrientation | 擷取應用的橫豎屏狀態。 | |
plus.navigator.getUIStyle | 擷取系統外觀樣式（暗黑模式）。 | |
plus.navigator.getSignature | 擷取應用的簽名標識。 | |
plus.orientation.getCurrentOrientation | 擷取當前裝置的方向資訊，包括alpha、beta、gamma三個方向資訊。 | |
plus.orientation.watchOrientation | 監聽裝置方向資訊的變化。 | |
plus.orientation.clearWatch | 關閉監聽裝置方向資訊。 | |
plus.proximity.getCurrentProximity | 擷取當前裝置的接近距離資訊。 | |
plus.proximity.watchProximity | 監聽裝置接近距離的變化。 | |
plus.proximity.clearWatch | 關閉監聽裝置接近距離變化。 | |
plus.runtime.agreePrivacy | 使用者同意隱私政策。 | |
plus.runtime.disagreePrivacy | 使用者不同意隱私政策。 | |
plus.runtime.isAgreePrivacy | 查詢使用者是否同意隱私政策。 | |
plus.runtime.showPrivacyDialog | 顯示隱私政策框。 | |
plus.runtime.getProperty | 擷取指定APPID對應的應用資訊。 | |
plus.runtime.install | 安裝應用。 | |
plus.runtime.quit | 退出應用。 | |
plus.runtime.restart | 重啟當前應用。 | |
plus.runtime.setBadgeNumber | 設定應用表徵圖上顯示的角標數字。 | |
plus.runtime.openURL | 調用第三方程式開啟指定URL。 | |
plus.runtime.openWeb | 使用內建WebView視窗開啟URL。 | |
plus.runtime.openFile | 調用第三方程式開啟指定檔案。 | |
plus.runtime.processDirectPage | 處理直達頁面連結參數. | |
plus.runtime.launchApplication | 調用第三方程式。 | |
plus.runtime.isApplicationExist | 判斷第三方程式是否已存在。 | |
plus.runtime.isCustomLaunchPath | 判斷是否自訂應用啟動頁面載入地址。 |
網路狀態
名稱 | 功能說明 | 連結 |
uni.getNetworkType | 擷取網路類型。 | |
uni.onNetworkStatusChange | 監聽網路狀態變化。可使用uni.offNetworkStatusChange取消監聽。 | |
uni.offNetwokrStatusChange | 取消監聽網路狀態變化。 |
系統主題
名稱 | 功能說明 | 連結 |
uni.onThemeChange | 監聽系統主題狀態變化。 | |
uni.offThemeChange | 取消監聽系統主題狀態變化。 |
加速度
名稱 | 功能說明 | 連結 |
uni.onAccelerometerChange | 監聽加速度資料，頻率：5次/秒，介面調用後會自動開始監聽，可使用 uni.offAccelerometer取消監聽。 | |
uni.offAccelerometerChange | 取消監聽加速度資料。 | |
uni.startAccelerometer | 開始監聽加速度資料。 | |
uni.stopAccelerometer | 停止監聽加速度資料。 | |
plus.accelerometer.getCurrentAcceleration | 擷取當前裝置的加速度資訊。 | |
plus.accelerometer.watchAcceleration | 監聽裝置加速度變化資訊。 | |
plus.clearWatch | 關閉監聽裝置加速度資訊。 |
羅盤
名稱 | 功能說明 | 連結 |
uni.onCompassChange | 監聽羅盤資料，頻率：5次/秒，介面調用後會自動開始監聽，可使用 uni.offCompassChange取消監聽。 | |
uni.offCompassChange | 取消監聽羅盤資料。 | |
uni.startCompass | 開始監聽羅盤資料。 | |
uni.stopCompass | 停止監聽羅盤資料。 |
撥打到電話
名稱 | 功能說明 | 連結 |
uni.makePhoneCall | 撥打到電話 | |
plus.device.dial | 撥打到電話 |
掃碼
名稱 | 功能說明 | 連結 |
uni.scanCode | 調起用戶端掃碼介面，掃碼成功後返回對應的結果。 | |
plus.barcode.scan | 掃碼識別圖片中的條碼。 | |
plus.barcode.create | 建立掃碼識別控制項對象。 | |
plus.barcode.getBarcodeById | 尋找掃碼識別控制項對象。 |
剪下板
名稱 | 功能說明 | 連結 |
uni.setClipboardData | 設定系統剪貼簿的內容。 | |
uni.getClipboardData | 擷取系統剪貼簿內容。 |
螢幕亮度
名稱 | 功能說明 | 連結 |
uni.setScreenBrightness | 設定螢幕亮度。 | |
uni.getScreenBrightness | 擷取螢幕亮度。 | |
uni.setKeepScreenOn | 設定是否保持常亮狀態。僅在當前應用生效，離開應用後設定失效。 |
使用者截屏事件
名稱 | 功能說明 | 連結 |
uni.onUserCaptureScreen | 監聽使用者主動截屏事件，使用者使用系統截屏按鍵截屏時觸發此事件。 | |
uni.offUserCaptureScreen | 使用者主動截屏事件。取消事件監聽。 | |
uni.setUserCaptureScreen | 開啟/關閉防截屏。 |
震動
名稱 | 功能說明 | 連結 |
uni.vibrate | 使手機發生震動。 | |
uni.vibrateLong | 使手機發生較長時間的震動（400ms）。 | |
uni.vibrateShort | 使手機發生較短時間的震動（15ms）。 |
手機連絡人
名稱 | 功能說明 | 連結 |
uni.addPhoneContact | 調用後，使用者可以選擇將該表單以“新增連絡人”或“添加到已有連絡人”的方式（APP端目前沒有選擇步驟，將直接寫入），寫入手機系統通訊錄，完成手機通訊錄連絡人和連絡方式的增加。 | |
plus.contacts.getAddressBook | 擷取通訊錄對象。 |
簡訊/郵件
名稱 | 功能說明 | 連結 |
plus.messaging.createMessage | 建立訊息對象。 | |
plus.messaging.sendMessage | 發送訊息。 |
藍芽
名稱 | 功能說明 | 連結 |
uni.openBluetoothAdapter | 初始化藍芽模組。 | |
uni.startBluetoothDevicesDiscovery | 開始搜尋附近的藍芽外圍裝置。此操作比較耗費系統資源，請在搜尋並串連到裝置後調用 uni.stopBluetoothDevicesDiscovery方法停止搜尋。 | |
uni.onBluetoothDeviceFound | 監聽尋找到新裝置的事件。 | |
uni.stopBluetoothDevicesDiscovery | 停止搜尋附近的藍芽外圍裝置。若已經找到需要的藍牙裝置並不需要繼續搜尋時，建議調用該介面停止藍芽搜尋。 | |
uni.onBluetoothAdapterStateChange | 監聽藍芽適配器狀態變化事件。 | |
uni.getConnectedBluetoothDevices | 根據uuid擷取處於已串連狀態的裝置。 | |
uni.getBluetoothDevices | 擷取在藍芽模組生效期間所有已發現的藍牙裝置。包括已經和本機處於串連狀態的裝置。 | |
uni.getBluetoothAdapterState | 擷取本機藍芽適配器狀態。 | |
uni.closeBluetoothAdapter | 關閉藍芽模組。調用該方法將斷開所有已建立的串連並釋放系統資源。建議在使用藍芽流程後，與 uni.openBluetoothAdapter成對調用。 | |
plus.bluetooth.closeBluetoothAdapter | 關閉藍芽模組。 | |
plus.bluetooth.getBluetoothAdapterState | 擷取藍芽適配器狀態。 | |
plus.bluetooth.getBluetoothDevices | 擷取已搜尋到的藍牙裝置。 | |
plus.bluetooth.getConnectedBluetoothDevices | 根據uuid擷取處於已串連的裝置。 | |
plus.bluetooth.onBluetoothAdapterStateChange | 監聽藍芽適配器狀態變化事件。 | |
plus.bluetooth.onBluetoothDeviceFound | 監聽搜尋到新裝置的事件。 | |
plus.bluetooth.openBluetoothAdapter | 初始化藍芽模組。 | |
plus.bluetooth.startBluetoothDevicesDiscovery | 開始搜尋附近的藍牙裝置。 | |
plus.bluetooth.stopBluetoothDevicesDiscovery | 停止搜尋附近的藍牙裝置。 |
低功耗藍芽
名稱 | 功能說明 | 連結 |
uni.setBLEMTU | 設定藍芽傳輸單元最大值。需在 uni.createBLEConnection調用成功後調用，mtu設定範圍 (22,512)。安卓5.1以上有效 | |
uni.writeBLECharacteristicValue | 向低功耗藍牙裝置特徵值中寫入位元據。 | |
uni.readBLECharacteristicValue | 讀取低功耗藍牙裝置的特徵值的位元據值。 | |
uni.onBLEConnectionStateChange | 監聽低功耗藍芽串連狀態的改變事件。 | |
uni.onBLECharacteristicValueChange | 監聽低功耗藍牙裝置的特徵值變化事件。 | |
uni.notifyBLECharacteristicValueChange | 啟用低功耗藍牙裝置特徵值變化時的 notify功能，訂閱特徵值。 | |
uni.getBLEDeviceServices | 擷取藍牙裝置所有服務(service)。 | |
uni.getBLEDeviceRSSI | 擷取藍牙裝置的訊號強度。 | |
uni.getBLEDeviceCharacteristics | 擷取藍牙裝置某個服務中所有特徵值(characteristic)。 | |
uni.createBLEConnection | 串連低功耗藍牙裝置。 | |
uni.closeBLEConnection | 斷開與低功耗藍牙裝置的串連。 | |
plus.bluetooth.closeBLEConnection | 斷開與低功耗藍牙裝置的串連。 | |
plus.bluetooth.createBLEConnection | 串連低功耗藍牙裝置。 | |
plus.bluetooth.setBLEMTU | 設定藍芽傳輸單元最大值。 | |
plus.bluetooth.getBLEDeviceCharacteristics | 擷取藍牙裝置某個服務中所有特徵值(characteristic)。 | |
plus.bluetooth.getBLEDeviceRSSI | 擷取藍牙裝置的訊號強度。 | |
plus.bluetooth.getBLEDeviceServices | 擷取藍牙裝置所有服務（service）。 | |
plus.bluetooth.notifyBLECharacteristicValueChange | 啟用低功耗藍牙裝置特徵值變化時的 notify功能，訂閱特徵值。 | |
plus.bluetooth.onBLECharacteristicValueChange | 監聽低功耗藍牙裝置的特徵值變化事件。 | |
plus.bluetooth.onBLEConnectionStateChange | 監聽低功耗藍芽串連狀態的改變事件。 | |
plus.bluetooth.readBLECharacteristicValu | 讀取低功耗藍牙裝置的特徵值的位元據值。 | |
plus.bluetooth.writeBLECharacteristicValue | 向低功耗藍牙裝置特徵值中寫入位元據。 |
iBeacon
名稱 | 功能說明 | 連結 |
uni.onBeaconServiceChange | 監聽iBeacon服務狀態變化事件。 | |
uni.onBeaconUpdate | 監聽iBeacon裝置更新事件。 | |
uni.getBeacons | 擷取所有已搜尋到的iBeacon裝置。 | |
uni.startBeaconDiscovery | 開始搜尋附近的iBeacon裝置。 | |
uni.stopBeaconDiscovery | 停止搜尋附近的iBeacon裝置。 | |
plus.ibeacon.startBeaconDiscovery | 開始搜尋附近的iBeacon裝置。 | |
plus.ibeacon.stopBeaconDiscovery | 停止搜尋附近的iBeacon裝置。 | |
plus.ibeacon.getBeacons | 擷取所有已搜尋到的iBeacon裝置。 | |
plus.ibeacon.onBeaconUpdate | 監聽iBeacon裝置更新事件。 | |
plus.ibeacon.onBeaconServiceChange | 監聽iBeacon服務狀態變化事件。 |
生物認證
名稱 | 功能說明 | 說明 |
uni.startSoterAuthentication | 開始SOTER生物認證。 | |
uni.checkIsSupportSoterAuthentication | 擷取本機支援的SOTER生物認證方式。 | |
uni.checkIsSoterEnrolledInDevice | 擷取裝置內是否錄入如指紋等生物資訊的介面。 |
指紋
名稱 | 功能說明 | 說明 |
plus.fingerprint.isSupport | 當前裝置是否支援指紋識別。 | |
plus.fingerprint.isKeyguardSecure | 當前裝置是否設定密碼鎖屏。 | |
plus.fingerprint.isEnrolledFingerprints | 當前裝置是否已經錄入指紋。 | |
plus.fingerprint.authenticate | 指紋識別認證。 | |
plus.fingerprint.cancel | 取消指紋識別認證。 |
OAuth
名稱 | 功能說明 | 連結 |
plus.oauth.getServices | 擷取登入鑒權列表。 |
支付
名稱 | 功能說明 | 連結 |
plus.payment.getChannels | 擷取支付通道。 | |
plus.payment.request | 請求支付操作。 |
儲存
名稱 | 功能說明 | 連結 |
plus.storage.clear | 同步清除儲存資料。 | |
plus.storage.clearAsync | 非同步清除儲存資料。 | |
plus.storage.getAllKeys | 同步擷取所有鍵。 | |
plus.storage.getAllKeysAsync | 非同步擷取所有鍵。 | |
plus.storage.getLength | 擷取儲存資料的個數。 | |
plus.storage.getItem | 同步擷取儲存的索引值。 | |
plus.storage.getItemAsync | 非同步擷取儲存的索引值。 | |
plus.storage.key | 擷取索引值對中指定索引值的key值。 | |
plus.storage.setItem | 同步儲存索引值。 | |
plus.storage.setItemAsync | 非同步儲存索引值。 | |
plus.storage.removeItem | 同步刪除索引值。 | |
plus.storage.removeItemAsync | 非同步刪除索引值。 |
鍵盤/按鍵
名稱 | 功能說明 | 連結 |
uni.hideKeyboard | 隱藏軟鍵盤。 | |
uni.onKeyboardHeightChange | 監聽鍵盤高度變化。 | |
uni.offKeyboardHeightChange | 取消監聽鍵盤高度變化事件。 | |
uni.getSelectedTextRange | 在input、textarea等focus之後，擷取輸入框的游標位置。 | |
plus.key.hideSoftKeybord | 隱藏軟鍵盤。 | |
plus.key.setAssistantType | 設定輔助輸入類型。 | |
plus.key.showSoftKeybord | 顯示軟鍵盤。 | |
plus.key.addEventListener | 添加按鍵事件監聽器。 | |
plus.key.setVolumeButtonEnabled | 設定音量鍵是否生效。 | |
plus.key.removeEventListener | 移除按鍵事件監聽器。 |
介面
互動反饋
名稱 | 功能說明 | 連結 |
uni.showToast | 顯示訊息提示框。 | |
uni.hideToast | 隱藏訊息提示框。 | |
uni.showLoading | 顯示 loading 提示框, 需主動調用 uni.hideLoading才能關閉提示框。 | |
uni.hideLoading | 隱藏loading提示框。 | |
uni.showModal | 顯示模態彈窗，可以只有一個確定按鈕，也可以同時有確定和取消按鈕。類似於一個API整合了 html中：alert、confirm。 | |
uni.showActionSheet | 從底部向上彈出操作菜單。 | |
plus.nativeUI.actionSheet | 彈出系統選擇按鈕框。 | |
plus.nativeUI.alert | 彈出系統提示對話方塊。 | |
plus.nativeUI.confirm | 彈出系統確認對話方塊。 | |
plus.nativeUI.closePreviewImage | 關閉預覽圖片介面。 | |
plus.nativeUI.closeWaiting | 關閉系統等待對話方塊。 | |
plus.nativeUI.closeToast | 關閉自動訊息的提示訊息。 | |
plus.nativeUI.previewImage | 預覽圖片。 | |
plus.nativeUI.showWaiting | 顯示系統等待對話方塊。 | |
plus.nativeUI.pickDate | 彈出系統日期選擇對話方塊。 | |
plus.nativeUI.pickTime | 彈出系統時間對話方塊。 | |
plus.nativeUI.prompt | 彈出系統輸入對話方塊。 | |
plus.nativeUI.toast | 顯示自動消失的提示訊息。 | |
plus.nativeUI.setUIStyle | 設定原生介面樣式。 |
設定導航條
名稱 | 功能說明 | 連結 |
uni.setNavigationBarTitle | 動態設定當前頁面的標題。 | |
uni.setNavigationBarColor | 設定頁面導航條顏色。 說明 如果需要進入頁面就設定顏色，請順延強制，防止被架構內設定顏色邏輯覆蓋。 |
設定TabBar
名稱 | 功能說明 | 連結 |
uni.setTabBarItem | 動態設定TabBar某一項的內容。 | |
uni.setTabBarStyle | 動態設定TabBar的整體樣式。 | |
uni.hideTabBar | 隱藏TabBar。 | |
uni.showTabBar | 顯示TabBar。 | |
uni.setTabBarBadge | 為TabBar某一項的右上方添加文本。 | |
uni.removeTabBarBadge | 移除TabBar某一項右上方的文本。 | |
uni.showTabBarRedDot | 顯示TabBar某一項的右上方的紅點。 | |
uni.hideTabBarRedDot | 隱藏TabBar某一項的右上方的紅點。 | |
uni.onTabBarMidButtonTap | 監聽中間按鈕的點擊事件。 |
動畫
名稱 | 功能說明 | 連結 |
uni.createAnimation | 建立一個動畫執行個體animation。調用執行個體的方法來描述動畫。最後通過動畫執行個體的export方法匯出動畫資料傳遞給組件的animation屬性。 |
滾動
名稱 | 功能說明 | 連結 |
uni.pageScrollTo | 將頁面滾動到目標位置。 |
視窗
名稱 | 功能說明 | 連結 |
uni.onWindowResize | 監聽視窗尺寸變化事件。 | |
uni.offWindowResize | 取消監聽視窗尺寸變化事件。 |
字型
名稱 | 功能說明 | 連結 |
uni.loadFontFace | 動態載入網路字型，檔案地址需為下載類型。 | |
uni.upx2px | 將rpx單位值轉換成px。 |
下拉重新整理
名稱 | 功能說明 | 連結 |
uni.startPullDownRefresh | 開始下拉重新整理，調用後觸發下拉重新整理動畫，效果與使用者手動下拉重新整理一致。 | |
uni.stopPullDownRefresh | 停止當前頁面下拉重新整理。 |
節點資訊
名稱 | 功能說明 | 連結 |
uni.createSelectorQuery | 返回一個SelectorQuery對象執行個體。可以在這個執行個體上使用select等方法選擇節點，並使用boundingClientRect等方法選擇需要查詢的資訊。 |
節點布局相交狀態
名稱 | 功能說明 | 連結 |
uni.createIntersectionObserver | 建立並返回一個IntersectionObserver對象執行個體。 |
媒體查詢
名稱 | 功能說明 | 連結 |
uni.createMediaQueryObserver | 建立並返回一個MediaQueryObserver對象執行個體。 |
語言
名稱 | 功能說明 | 連結 |
uni.getLocale | 擷取當前設定的語言。 | |
uni.setLocale | 設定當前語言。 | |
uni.onLocaleChange | 用於監聽應用語言切換。 |
檔案
名稱 | 功能說明 | 連結 |
uni.saveFile | 儲存檔案到本地。 | |
uni.getSavedFileList | 擷取本地已儲存的檔案清單。 | |
uni.getSavedFileInfo | 擷取本地檔案的檔案資訊。此介面只能用於擷取已儲存到本地的檔案。 | |
uni.removeSavedFile | 刪除本機存放區的檔案。 | |
uni.getFileInfo | 擷取檔案資訊。 | |
uni.openDocument | 新開頁面開啟文檔，支援格式：doc、xls、ppt、pdf、docx、xlsx、pptx。 | |
plus.io.requestFileSystem | 請求本地檔案系統對象。 | |
plus.io.resolveLocalFileSystemURL | 通過URL參數擷取目錄對象或檔案對象。 | |
plus.io.convertLocalFileSystemURL | 將本地URL路徑轉換成平台絕對路徑。 | |
plus.io.convertAbsoluteFileSystem | 講評台絕對路徑轉換成本地URL路徑。 | |
plus.io.getAudioInfo | 擷取音頻資訊。 | |
plus.io.getFileInfo | 擷取檔案資訊。 | |
plus.io.getImageInfo | 擷取圖片資訊。 | |
plus.io.getVideoInfo | 擷取視頻檔案資訊。 |
下載
名稱 | 功能說明 | 連結 |
plus.downloader.createDownload | 建立下載任務。 | |
plus.downloader.enumerate | 枚舉下載任務。 | |
plus.downloader.clear | 清除下載任務。 | |
plus.downloader.startAll | 開發所有下載任務。 |
上傳
名稱 | 功能說明 | 連結 |
plus.uploader.createUpload | 建立上傳任務。 | |
plus.uploader.enumerate | 枚舉上傳任務。 | |
plus.uploader.clear | 清除上傳任務。 | |
plus.uploader.startAll | 開發所有上傳任務。 |
壓縮
名稱 | 功能說明 | 連結 |
plus.zip.compress | 壓縮產生zip檔案。 | |
plus.zip.decompress | 解壓縮zip檔案。 | |
plus.zip.compressImage | 圖片壓縮轉換。 | |
plus.zip.compressVideo | 視頻壓縮。 |
繪畫
名稱 | 功能說明 | 連結 |
uni.createCanvasContext | 建立canvas繪圖上下文（指定canvasId）。在自訂群組件下，第二個參數傳入組件執行個體this，以操作組件內<canvas/>組件。 | |
uni.canvasToTempFilePath | 把當前畫布指定地區的內容匯出產生指定大小的圖片，並返迴文件路徑。在自訂群組件下，第二個參數傳入自訂群組件執行個體，以操作組件內<canvas>組件。 | |
uni.canvasPutImageData | 將像素資料繪製到畫布的方法，在自訂群組件下，第二個參數傳入自訂群組件執行個體this，以操作組件內<canvas>組件。 | |
uni.canvasGetImageData | 返回一個數組，用來描述canvas地區隱含的像素資料，在自訂群組件下，第二個參數傳入自訂群組件執行個體this，以操作組件內<canvas>組件。 |
資料庫
名稱 | 功能說明 | 連結 |
plus.sqlite.openDatabase | 開啟資料庫。 | |
plus.sqlite.isOpenDatabase | 判斷資料庫是否開啟。 | |
plus.sqlite.closeDatabase | 關閉資料庫。 | |
plus.sqlite.transaction | 執行事務。 | |
plus.sqlite.executeSql | 執行增刪改等操作的SQL語句。 | |
plus.sqlite.selectSql | 執行查詢的SQL語句。 |
WebView
名稱 | 功能說明 | 連結 |
plus.webview.all | 擷取所有WebView視窗 | |
plus.webview.close | 關閉WebView視窗 | |
plus.webview.create | 建立新的WebView視窗 | |
plus.webview.currentWebview | 擷取當前視窗的WebviewObject對象 | |
plus.webview.getDisplayWebview | 擷取螢幕所有可視的WebView視窗 | |
plus.webview.getWebviewById | 尋找指定標識的WebViewObject視窗 | |
plus.webview.getLaunchWebview | 擷取應用首頁WebviewObject視窗對象 | |
plus.webview.getSecondWebview | 擷取應用第二個首頁WebviewObject視窗對象 | |
plus.webview.getTopWebview | 擷取應用顯示棧頂的WebviewObject視窗對象 | |
plus.webview.hide | 隱藏WebView視窗 | |
plus.webview.open | 建立並開啟WebView視窗 | |
plus.webview.prefetchURL | 預載網路頁面 | |
plus.webview.prefetchURLs | 預載網路頁面(多個地址) | |
plus.webview.show | 顯示Webview視窗 | |
plus.webview.startAnimation | Webview視窗組合動畫 | |
plus.webview.defaultHardwareAccelerated | 擷取Webview預設是否開啟硬體加速 |
三方服務
擷取服務供應商
名稱 | 功能說明 | 連結 |
uni.getProvider | 擷取服務供應商 |
登入
名稱 | 功能說明 | 連結 |
uni.login | uni.login是一個用戶端API，統一封裝了各個平台的各種常見的登入方式，包括App手機號一鍵登入、三方登入（微信、微博、QQ、Apple、google、facebook）、各家小程式內建登入。 | |
uni.getUserInfo | 擷取使用者資訊。 | |
uni.preLogin | 預登入。用於App手機號一鍵登入。 | |
uni.closeAuthView | 關閉一鍵登入頁面。 按照中國移動、中國聯通、中國電信等電訊廠商的要求，一鍵登入必須有介面。可用此API關閉頁面 | |
uni.getCheckBoxState | 擷取一鍵登入條款勾選框狀態。 | |
uni.getUniverifyManager | 擷取全域唯一的一鍵登入管理器 univerifyManager。 |
語音辨識
名稱 | 功能說明 | 連結 |
plus.speech.startRecognize | 啟動語音辨識。 | |
plus.speech.stopRecognize | 停止語音辨識。 | |
plus.speech.addEventListener | 監聽語音辨識時間。 |
分享
名稱 | 功能說明 | 連結 |
uni.share | uni-app的App引擎已經封裝了微信、QQ、微博的分享SDK，開發人員可以直接調用相關功能。 | |
uni.shareWithSystem | 調用系統分享組件發送分享訊息，不需要配置分享SDK。 | |
plus.share.sendWithSystem | 調用系統的分享組件。 | |
plus.share.getServices | 擷取分享服務。 |
支付
名稱 | 功能說明 | 連結 |
uni.requestPayment | 支付。 |
推送
名稱 | 功能說明 | 連結 |
uni.getPushClientId | 擷取用戶端唯一的推送標識。 | |
uni.onPushMessage | 啟動監聽推送訊息事件。 | |
uni.offPushMessage | 關閉推送訊息監聽事件。 | |
uni.createPushMessage | 建立本地通知欄訊息。 | |
plus.push.addEventListener | 添加推送訊息時間監聽器。 | |
plus.push.clear | 清空所有推送訊息。 | |
plus.push.createMessage | 建立本地訊息。 | |
plus.push.getAllMessage | 擷取所有推送訊息。 | |
plus.push.getClientInfo | 擷取用戶端推送標識資訊。 | |
plus.push.getClientInfoAsync | 非同步擷取用戶端推送標識資訊。 | |
plus.push.setAutoNotification | 設定程式是否將訊息顯示在系統訊息中心。 | |
plus.push.remove | 刪除推送訊息。 |
ID Verification
名稱 | 功能說明 | 連結 |
uni.getFacialRecognitionMetaInfo | 擷取ID Verification裝置資訊。 | |
uni.startFacialRecognitionVerify | ID Verification，開啟刷臉認證介面。 |
統計
名稱 | 功能說明 | 連結 |
plus.statistic.eventTrig | 觸發事件。 | |
plus.statistic.eventDuration | 精確持續事件。 |