本文介紹Windvane小程式JSAPI的能力和使用方式,便於您在使用Windvane小程式JSAPI時參考。
基礎
名稱 | 功能說明 | Android | iOS |
WVBase.copyToClipboard | 將指定的文本複製到剪貼簿。 | Y | Y |
WVBase.isInstall | 判斷是否已安裝指定的應用程式。 | Y | Y |
WVBase.isAppsInstalled | 判斷是否已安裝指定的多個應用程式。 | Y | Y |
WVBase.notify | 在 | N | Y |
WVBase.openBrowser | 開啟指定URL的Safari新視窗。 | N | Y |
WVBase.setBackgroundColor | 設定WebView的背景顏色。 | N | Y |
WVBase.canIUse | 判斷傳入的API在目前的版本是否支援。 | Y | Y |
WVMiniApp.close | 關閉小程式。 | Y | Y |
路由
名稱 | 功能說明 | Android | iOS |
WVNavigator.pop | 退出當前介面 | Y | Y |
WVNavigator.push | 開啟一個新的小程式介面 | Y | Y |
互動反饋
名稱 | 功能說明 | Android | iOS |
WVUI.showLoadingBox | 顯示一個載入提示框。 | Y | Y |
WVUI.hideLoadingBox | 隱藏載入提示框。 | Y | Y |
WVUI.hideKeyboard | 隱藏鍵盤。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVUIToast.toast | 顯示一個Toast(顯示在螢幕中央的簡單提示)。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVUIDialog.alert | 顯示一個警告框。 | Y | Y |
WVUIDialog.confirm | 顯示一個確認框。 | Y | Y |
WVUIDialog.enableAlertBeforeUnload | 開啟小程式頁面返回詢問對話方塊,開啟後當使用者使用返回鍵嘗試關閉小程式頁面時,會彈出"是否確認離開"的對話方塊。 | Y | Y |
WVUIDialog.disableAlertBeforeUnload | 關閉小程式頁面返回詢問對話方塊。 | Y | Y |
WVUIDialog.prompt | 彈出一個對話方塊,讓使用者在對話方塊內輸入文本。 | Y | Y |
WVUIDialog.showAuthGuide | 通過許可權引導模組以圖文形式向使用者彈出對話方塊,引導使用者開啟相應的許可權。 | Y | Y |
WVUIDatePicker.show | 顯示一個日期選取器,可以設定預設選擇日期,未設定則預設當天。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVUIActionSheet.show | 顯示一個ActionSheet(顯示在螢幕下方的動作列表)。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVNavigationBar.update | 動態設定當前頁面的標題列。 | Y | Y |
WVNavigationBar.getHeight | 擷取小程式標題列高度。 | Y | Y |
多媒體
名稱 | 功能說明 | Android | iOS |
WVImage.saveImage | 允許儲存HTTP(S)地址或者base64格式的圖片到相簿中。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVVideo.chooseVideo | 拍攝視頻或從手機相簿中選視頻。 | Y | Y |
WVVideo.saveVideoToPhotosAlbum | 儲存視頻到系統相簿。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVAudio.playSystemSound | 播放指定的系統聲音。 | N | Y |
名稱 | 功能說明 | Android | iOS |
WVCamera.takePhoto | 使用者自選調用相機拍照或者直接從相簿選擇照片,得到照片後可以指定是否自動上傳照片。需要Native端上實現上傳協議。 | Y | Y |
WVCamera.confirmUploadPhoto | 確認上傳照片。 | Y | Y |
緩衝
名稱 | 功能說明 | Android | iOS |
WVStorage.setItem | 將資料存放區在本機快取中指定的 key中。 | Y | Y |
WVStorage.getItem | 從本機快取中非同步擷取指定key的內容。 | Y | Y |
WVStorage.removeItem | 從本機快取中刪除指定key的內容。 | Y | Y |
WVStorage.clearStorage | 非同步清除緩衝。 | Y | Y |
WVStorage.clearStorageSync | 同步清除緩衝。 | Y | Y |
檔案
名稱 | 功能說明 | Android | iOS |
WVFile.write | 將指定的檔案內容寫入磁碟。 | Y | Y |
WVFile.read | 讀取指定檔案的內容。 | Y | Y |
WVFile.getFileInfo | 擷取檔案資訊。 | Y | Y |
WVFile.downloadFile | 下載檔案資源到本地。 | Y | Y |
WVFile.uploadFile | 上傳檔案至指定伺服器URL。 | Y | Y |
WVFile.chooseFiles | 選擇上傳本地檔案 | Y | Y |
WVFile.getDataByFilePath | 擷取本地檔案資料 | Y | Y |
地理位置
名稱 | 功能說明 | Android | iOS |
WVLocation.getLocation | 擷取當前的地理位置。 | Y | Y |
WVLocation.searchLocation | 搜尋給定地址的地理位置經緯度。 | N | Y |
跨域
名稱 | 功能說明 | Android | iOS |
WVCookie.read | 讀取指定URL的所有Cookie。 | Y | Y |
WVCookie.write | 寫入指定的Cookie。 | Y | Y |
裝置
名稱 | 功能說明 | Android | iOS |
WVSystem.getSystemInfo | 擷取手機系統資訊。 | Y | Y |
WVSystem.getSystemInfoSync | 擷取手機系統資訊同步方法。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVNativeDetector.isSimulator | 擷取當前環境是否是模擬器。 | Y | Y |
WVNativeDetector.getCurrentUsage | 擷取當前的CPU和記憶體使用量率資訊。 | Y | Y |
WVNativeDetector.getDeviceYear | 擷取裝置的發布日期,可以用於估算裝置的效能。iOS可以基本準確地獲得裝置的發布日期,估算Android裝置效能。 | Y | Y |
WVNativeDetector.getModelInfo | 擷取裝置型號等資訊。 | Y | Y |
WVNativeDetector.getSafeAreaInsets | 擷取當前頁面的安全區域資訊,僅適用於全屏頁面。 | N | Y |
名稱 | 功能說明 | Android | iOS |
WVNetwork.getNetworkType | 擷取當前網路類型。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVScreen.getOrientation | 返回當前Activity/ViewController的顯示方向(橫屏/豎屏)。 | Y | Y |
WVScreen.setOrientation | 設定當前ViewController/Activity的顯示方向(橫屏/豎屏)。 | Y | Y |
WVScreen.setScreenBrightness | 設定螢幕亮度。 | Y | Y |
WVScreen.getScreenBrightness | 擷取螢幕亮度。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVScreenCapture.capture | 截取當前WebView顯示的部分為圖片。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVMotion.listenBlow | 開啟吹氣動作的監聽。 | Y | Y |
WVMotion.stopListenBlow | 停止吹氣動作的監聽。 | Y | Y |
WVMotion.listenGyro | 開啟或關閉陀螺儀的監聽。 | Y | Y |
WVMotion.listeningShake | 開啟或關閉搖一搖的監聽。 | Y | Y |
WVMotion.vibrate | 令手機震動。 | Y | Y |
WVMotion.startAccelerometer | 開始監聽加速度資料。 | Y | Y |
WVMotion.stopAccelerometer | 停止監聽加速度資料。 | Y | Y |
WVMotion.startCompass | 開始監聽羅盤資料。 | Y | Y |
WVMotion.stopCompass | 停止監聽羅盤資料。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVNotification.beep | 令手機蜂鳴。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVCall.dial | 調起鍵盤。 | Y | Y |
WVCall.call | 直接撥打到電話。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVApplication.appState | 返回當前應用的狀態(是否在前台)。 | N | Y |
WVApplication.getNotificationSettings | 返回當前應用的通知狀態。 | N | Y |
WVApplication.openSettings | 開啟當前應用的設定頁面。 | N | Y |
名稱 | 功能說明 | Android | iOS |
WVContacts.askAuth | 請求訪問通訊錄的許可權。 | N | Y |
WVContacts.authStatus | 擷取當前對於通訊錄的存取權限狀態。 | N | Y |
WVContacts.choose | 拉起通訊錄列表,使用者選擇一個連絡人之後將連絡人的名字和電話返回給H5端。 | Y | Y |
WVContacts.find | 通過指定的名字和電話號碼尋找通訊錄。 | Y | Y |
WVContacts.addPhoneContact | 新增連絡人...。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVScan.scan | 掃一掃功能。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVBattery.getBatteryInfo | 擷取電量的非同步介面。 | Y | Y |
WVBattery.getBatteryInfoSync | 擷取電量的同步介面。 | Y | Y |
名稱 | 功能說明 | Android | iOS |
WVBluetooth.requestAuthorization | 申請藍芽相關許可權並開啟藍芽。 | Y | Y |
WVBluetooth.scan | 尋找藍芽低功耗(LE)裝置。 | Y | Y |
WVBluetooth.stopScan | 停止尋找藍牙裝置。 | Y | Y |
WVBluetooth.connect | 串連指定藍芽地址的藍牙裝置。 | Y | Y |
WVBluetooth.disconnect | 同已串連的藍牙裝置中斷連線。 | Y | Y |
WVBluetooth.getServices | 開始尋找低功耗藍牙裝置的服務 | Y | Y |
WVBluetooth.getCharacteristics | 擷取低功耗藍牙裝置的所有特徵值。 | Y | Y |
WVBluetooth.writeValue | 向已串連的低功耗藍牙裝置寫入指定的特徵值。 | Y | Y |
WVBluetooth.readValue | 從已串連的低功耗藍牙裝置中讀取指定特徵值。 | Y | Y |
WVBluetooth.startNotifications | 開啟特徵值變化通知。 | Y | Y |
WVBluetooth.stopNotifications | 關閉特徵值變化通知。 | Y | Y |
通訊
名稱 | 功能說明 | Android | iOS |
WVStandardEventCenter.postNotificationToNative | 小程式端向Native端發送事件,具體的事件名稱可以是與Native業務方商議一致的任意名稱 | Y | Y |
其它特性
名稱 | 功能說明 | Android | iOS |
WindVaneReady | 當頁面載入完畢後,WindVane會引發WindVaneReady事件,頁面可以監聽這一事件,擷取頁面載入狀態。 | Y | Y |
Background | 當應用被切換到後台(如切換應用、開啟通知欄等操作)時,WindVane會引發WV.Event.APP.Background事件,頁面可以監聽這一事件,獲知應用已被切換到後台。 | Y | Y |
Active | 當應用被切換到後台再切換回來時,WindVane會引發WV.Event.APP.Active事件,頁面可以監聽這一事件,獲知應用已經被啟用。 | Y | Y |