このトピックでは、WindVane ミニアプリの JavaScript API の機能と使用方法について説明します。
WVBase
API | 機能 | Android | iOS |
WVBase.checkWindVaneSDK | 指定されたバージョンの WindVane SDK と現在のバージョンの WindVane SDK を比較します。 | サポートされていません | サポートされています |
WVBase.copyToClipboard | 指定されたテキストをクリップボードにコピーします。 | サポートされています | サポートされています |
WVBase.isInstall | 指定されたアプリがインストールされているかどうかを確認します。 | サポートされています | サポートされています |
WVBase.isAppsInstalled | 指定されたアプリがインストールされているかどうかを確認します。 | サポートされています | サポートされています |
WVBase.isWindVaneSDK | 現在のバージョンの WindVane SDK を取得します。 | サポートされています | サポートされています |
WVBase.notify |
| サポートされていません | サポートされています |
WVBase.openBrowser | 新しい Safari ページを開いて、指定された URL にアクセスします。 | サポートされていません | サポートされています |
WVBase.setBackgroundColor | WebView の背景色を設定します。 | サポートされていません | サポートされています |
WVBase.canIUse | 現在の WindVane SDK バージョンで API がサポートされているかどうかを確認します。 | サポートされています | サポートされています |
WVMiniApp.close | ミニアプリを閉じます。 | サポートされています | サポートされています |
ナビゲーション
API | 機能 | Android | iOS |
WVNavigator.pop | 現在のページを閉じます。 | サポートされています | サポートされています |
WVNavigator.push | ミニアプリで新しいページを開きます。 | サポートされています | サポートされています |
インタラクション
API | 機能 | Android | iOS |
WVUI.showLoadingBox | ローディングメッセージを表示します。 | サポートされています | サポートされています |
WVUI.hideLoadingBox | ローディングメッセージを非表示にします。 | サポートされています | サポートされています |
WVUI.hideKeyboard | キーボードを非表示にします。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVUIToast.toast | 画面の中央にトーストを表示します。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVUIDialog.alert | 警告メッセージを表示します。 | サポートされています | サポートされています |
WVUIDialog.confirm | 確認メッセージを表示します。 | サポートされています | サポートされています |
WVUI.enableAlertBeforeUnload | ユーザーが戻るボタンをクリックしてミニアプリを閉じようとすると、確認メッセージが表示されます。 | サポートされています | サポートされています |
WVUI.disableAlertBeforeUnload | ユーザーが戻るボタンをクリックしてミニアプリを閉じようとすると、確認メッセージは表示されません。 | サポートされています | サポートされています |
WVUIDialog.prompt | ユーザーがテキストを入力できるテキストボックスを表示します。 | サポートされています | サポートされています |
WVUIDialog.showAuthGuide | 権限の付与をユーザーに促すダイアログボックスを表示します。ダイアログボックスには、テキストとイラストが表示されます。 | サポートされています | サポートされています |
WVUIDatePicker.show | 日付ピッカーを表示します。デフォルトの日付を設定できます。デフォルトの日付を設定しない場合は、現在の日付が使用されます。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVUIActionSheet.show | アクションシートを表示します。画面の下部にボタンのリストが表示されます。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVNavigationBar.update | 現在のページのナビゲーションバーを設定します。 | サポートされています | サポートされています |
WVNavigationBar.getHeight | ミニアプリのナビゲーションバーの高さを取得します。 | サポートされています | サポートされています |
マルチメディア
API | 機能 | Android | iOS |
WVImage.saveImage | HTTP または HTTPS URL からの画像、または Base64 でエンコードされた画像をアルバムに保存します。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVVideo.chooseVideo | ビデオを撮影するか、アルバムからビデオを選択します。 | サポートされています | サポートされています |
WVVideo.saveVideoToPhotosAlbum | オンラインビデオをローカルアルバムに保存します。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVAudio.playSystemSound | 指定されたシステムサウンドを再生します。 | サポートされていません | サポートされています |
API | 機能 | Android | iOS |
WVCamera.takePhoto | 写真を撮るか、アルバムから写真を選択します。ユーザーは写真の自動アップロードを有効にするかどうかを決定できます。写真の自動アップロード機能は、ネイティブアプリケーションで実装する必要があります。 | サポートされています | サポートされています |
WVCamera.confirmUploadPhoto | 写真のアップロードを確認します。 | サポートされています | サポートされています |
キャッシュ
API | 機能 | Android | iOS |
WVStorage.setItem | ローカルキャッシュに指定されたキーの値を設定します。 | サポートされています | サポートされています |
WVStorage.getItem | ローカルキャッシュから指定されたキーの値を取得します。 | サポートされています | サポートされています |
WVStorage.removeItem | ローカルキャッシュから指定されたキーの値を削除します。 | サポートされています | サポートされています |
WVStorage.clearStorage | ローカルデータキャッシュを非同期でクリアします。 | サポートされています | サポートされています |
WVStorage.clearStorageSync | ローカルデータキャッシュを同期的にクリアします。 | サポートされています | サポートされています |
ファイル
API | 機能 | Android | iOS |
WVFile.write | 指定されたコンテンツをディスクに書き込みます。 | サポートされています | サポートされています |
WVFile.read | 指定されたファイルのコンテンツを読み取ります。 | サポートされています | サポートされています |
WVFile.getFileInfo | ファイルに関する情報を取得します。 | サポートされています | サポートされています |
WVFile.downloadFile | 指定された URL からファイルをダウンロードします。 | サポートされています | サポートされています |
WVFile.uploadFile | ファイルを指定されたサーバー URL にアップロードします。 | サポートされています | サポートされています |
地理位置情報
API | 機能 | Android | iOS |
WVLocation.getLocation | 現在の地理位置情報を取得します。 | サポートされています | サポートされています |
WVLocation.searchLocation | 指定された住所を検索し、緯度と経度を取得します。 | サポートされていません | サポートされています |
Cookie
API | 機能 | Android | iOS |
WVCookie.read | 指定された URL からすべての Cookie を読み取ります。 | サポートされています | サポートされています |
WVCookie.write | Cookie を書き込みます。 | サポートされています | サポートされています |
デバイス
API | 機能 | Android | iOS |
WVSystem.getSystemInfo | デバイスのシステム情報を取得します。 | サポートされています | サポートされています |
WVSystem.getSystemInfoSync | デバイスのシステム情報を同期的に取得します。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVNativeDetector.isSimulator | デバイスがシミュレートされているかどうかを確認します。 | サポートされています | サポートされています |
WVNativeDetector.getCurrentUsage | 現在の CPU 使用率とメモリ使用量を取得します。 | サポートされています | サポートされています |
WVNativeDetector.getDeviceYear | デバイスの発売年を取得します。発売年に基づいてデバイスのパフォーマンスを把握できます。 iOS デバイスのモデルを簡単に識別し、そのパフォーマンスがビジネス要件を満たしているかどうかを判断できます。 Android デバイスの場合、発売年に基づいてのみ、パフォーマンスが十分かどうかを判断できます。 | サポートされています | サポートされています |
WVNativeDetector.getModelInf | デバイスモデルなどのデバイス情報を取得します。 | サポートされています | サポートされています |
WVNativeDetector.getSafeAreaInsets | 現在のビューのセーフエリア情報を取得します。この API は、全画面ページでのみ使用できます。 | サポートされていません | サポートされています |
API | 機能 | Android | iOS |
WVNetwork.getNetworkType | 現在のネットワークタイプを取得します。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVScreen.getOrientation | 現在のアクティビティまたはビューコントローラーの表示方向 (横向きまたは縦向き) を取得します。 | サポートされています | サポートされています |
WVScreen.setOrientation | 現在のアクティビティまたはビューコントローラーの表示方向 (横向きまたは縦向き) を設定します。 | サポートされています | サポートされています |
WVScreen.setScreenBrightness | 画面の明るさを設定します。 | サポートされています | サポートされています |
WVScreen.getScreenBrightness | 画面の明るさを取得します。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVScreenCapture.capture | WebView に表示されているコンテンツのスクリーンショットを撮ります。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVMotion.listenBlow | 吹くジェスチャを監視します。 | サポートされています | サポートされています |
WVMotion.stopListenBlow | 吹くジェスチャの監視を停止します。 | サポートされています | サポートされています |
WVMotion.listenGyro | ジャイロスコープの監視を有効または無効にします。 | サポートされています | サポートされています |
WVMotion.listeningShake | シェイクジェスチャの監視を有効または無効にします。 | サポートされています | サポートされています |
WVMotion.vibrate | 電話を振動させます。 | サポートされています | サポートされています |
WVMotion.startAccelerometer | 加速度データを監視します。 | サポートされています | サポートされています |
WVMotion.stopAccelerometer | 加速度データの監視を停止します。 | サポートされています | サポートされています |
WVMotion.startCompass | コンパスデータを監視します。 | サポートされています | サポートされています |
WVMotion.stopCompass | コンパスデータの監視を停止します。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVNotification.beep | 電話からビープ音を鳴らします。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVCall.dial | 電話のキーパッドを表示します。 | サポートされています | サポートされています |
WVCall.call | 電話を直接かけます。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVApplication.appState | アプリケーションのステータスを返します。ステータスは、アプリケーションがフォアグラウンドで実行されているかどうかを示します。 | サポートされていません | サポートされています |
WVApplication.getNotificationSettings | アプリケーションの通知設定を返します。 | サポートされていません | サポートされています |
WVApplication.openSettings | アプリケーションの設定ページを表示します。 | サポートされていません | サポートされています |
API | 機能 | Android | iOS |
WVContacts.askAuth | 連絡先へのアクセスをリクエストします。 | サポートされていません | サポートされています |
WVContacts.authStatus | 連絡先へのアクセス許可が付与されているかどうかを確認します。 | サポートされていません | サポートされています |
WVContacts.choose | 連絡先を表示します。ユーザーが連絡先を選択すると、連絡先の名前と電話番号が HTML5 ページに返されます。 | サポートされています | サポートされています |
WVContacts.find | 名前と電話番号を指定して連絡先を検索します。 | サポートされています | サポートされています |
WVContacts.addPhoneContact | 連絡先を追加します。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVScan.scan | スキャン機能を有効にします。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVBattery.getBatteryInfo | バッテリー残量を非同期で取得します。 | サポートされています | サポートされています |
WVBattery.getBatteryInfoSync | バッテリー残量を同期的に取得します。 | サポートされています | サポートされています |
API | 機能 | Android | iOS |
WVBluetooth.requestAuthorization | Bluetooth の権限をリクエストし、Bluetooth を有効にします。 | サポートされています | サポートされています |
WVBluetooth.scan | Bluetooth Low Energy（BLE）デバイスを検索します。 | サポートされています | サポートされています |
WVBluetooth.stopScan | BLE デバイスの検索を停止します。 | サポートされています | サポートされています |
WVBluetooth.connect | アプリケーションが実行されているデバイスを、指定された Bluetooth アドレスを持つ Bluetooth デバイスに接続します。 | サポートされています | サポートされています |
WVBluetooth.disconnect | 接続されている Bluetooth デバイスを切断します。 | サポートされています | サポートされています |
WVBluetooth.getServices | BLE デバイスサービスの検索を開始します。 | サポートされています | サポートされています |
WVBluetooth.getCharacteristics | BLE デバイスのすべての特徴の値を取得します。 | サポートされています | サポートされています |
WVBluetooth.writeValue | 接続されている BLE デバイスに指定された特性の値を設定します。 | サポートされています | サポートされています |
WVBluetooth.readValue | 接続されている BLE デバイスから指定された特性の値を読み取ります。 | サポートされています | サポートされています |
WVBluetooth.startNotifications | 特性値の変更の通知を有効にします。 | サポートされています | サポートされています |
WVBluetooth.stopNotifications | 特性値の変更の通知を無効にします。 | サポートされています | サポートされています |
通信
API | 機能 | Android | iOS |
WVStandardEventCenter.postNotificationToNative | ミニアプリからネイティブアプリケーションにイベントを送信します。イベント名は、ネイティブアプリケーションのビジネス要件に基づいて変更できます。 | サポートされています | サポートされています |
情報レポート
API | 機能 | Android | iOS |
WVReporter.reportDomLoad | 現在のページの最初のバイトまでの時間（TTFB）とドキュメントオブジェクトモデル（DOM）の読み込み時間を報告します。 | サポートされています | サポートされています |
WVReporter.reportError | 現在のページの JavaScript エラーを報告します。 | サポートされています | サポートされています |
その他の機能
API | 機能 | Android | iOS |
WindVaneReady | ページが読み込まれると、WindVane は WindVaneReady イベントをトリガーします。ページはこのイベントをリッスンして、ページの読み込みステータスを取得できます。 | サポートされています | サポートされています |
Background | アプリケーションがバックグラウンドで実行を開始すると（たとえば、ユーザーが別のアプリに切り替えたり、通知バーを開いたりした場合）、WindVane は WV.Event.APP.Background イベントをトリガーします。ページはこのイベントをリッスンして、アプリケーションがバックグラウンドに切り替わるかどうかを判断できます。 | サポートされています | サポートされています |
Active | アプリケーションがバックグラウンドからフォアグラウンドに切り替わると、WindVane は WV.Event.APP.Active イベントをトリガーします。ページはこのイベントをリッスンして、アプリケーションがアクティブかどうかを判断できます。 | サポートされています | サポートされています |
Pull Refresh | iOS では、プルして更新機能はデフォルトで有効になっています。プルして更新機能はデフォルトで有効になっています。この機能を手動で無効にする必要があります。 | サポートされていません | サポートされています |
Infinite Scroll | 無限スクロール機能を有効にします。ユーザーがページの下部までスクロールすると、さらにコンテンツが読み込まれます。無限スクロールはデフォルトで無効になっています。この機能を手動で有効にする必要があります。 | サポートされていません | サポートされています |