SuperApp:JavaScript API

API

説明

Android

iOS

WVBase.copyToClipboard

指定されたテキストをクリップボードにコピーします。

Y

Y

WVBase.isInstall

指定されたアプリがインストールされているかどうかを確認します。

Y

Y

WVBase.isAppsInstalled

指定されたアプリがインストールされているかどうかを確認します。

Y

Y

WVBase.notify

指定された名前とパラメーターで document 上にイベントをディスパッチします。

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

API

説明

Android

iOS

WVUI.showLoadingBox

ローディングボックスを表示します。

Y

Y

WVUI.hideLoadingBox

ローディングボックスを非表示にします。

Y

Y

WVUI.hideKeyboard

キーボードを非表示にします。

Y

Y

API

説明

Android

iOS

WVUIToast.toast

トースト (画面中央に短時間表示される簡単なメッセージ) を表示します。

Y

Y

API

説明

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

API

説明

Android

iOS

WVUIActionSheet.show

アクションシート (画面下部に表示されるアクションのリスト) を表示します。

Y

Y

API

説明

Android

iOS

WVNavigationBar.update

現在のページのナビゲーションバーを設定します。

Y

Y

WVNavigationBar.getHeight

ミニアプリのナビゲーションバーの高さを取得します。

Y

Y

API

説明

Android

iOS

WVImage.saveImage

HTTP(S) URL または base64 エンコードされた文字列から画像をアルバムに保存します。

Y

Y

API

説明

Android

iOS

WVVideo.chooseVideo

ビデオを撮影するか、アルバムからビデオを選択します。

Y

Y

WVVideo.saveVideoToPhotosAlbum

ビデオをシステムアルバムに保存します。

Y

Y

API

説明

Android

iOS

WVAudio.playSystemSound

指定されたシステムサウンドを再生します。

N

Y

API

説明

Android

iOS

WVCamera.takePhoto

カメラで写真を撮るか、アルバムから写真を選択します。写真を自動的にアップロードするかどうかを指定できます。これには、ネイティブアプリがアップロードプロトコルを実装する必要があります。

Y

Y

WVCamera.confirmUploadPhoto

写真のアップロードを確認します。

Y

Y

パラメーター

説明

Android

iOS

WVStorage.setItem

指定されたキーのデータをローカルキャッシュに保存します。

Y

Y

WVStorage.getItem

ローカルキャッシュから指定されたキーのデータを取得します (非同期)。

Y

Y

WVStorage.removeItem

ローカルキャッシュから指定されたキーのデータを削除します。

Y

Y

WVStorage.clearStorage

ローカルキャッシュをクリアします (非同期)。

Y

Y

WVStorage.clearStorageSync

ローカルキャッシュをクリアします (同期)。

Y

Y

API

説明

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

アップロードするローカルファイルを 1 つ以上選択します。

Y

Y

WVFile.getDataByFilePath

パスによってローカルファイルのデータを取得します。

Y

Y

パラメーター

説明

Android

iOS

WVLocation.getLocation

現在の位置情報を取得します。

サポート済み

サポート済み

WVLocation.searchLocation

住所の緯度と経度を検索します。

サポート対象外

サポート済み

パラメーター

説明

Android

iOS

WVCookie.read

指定された URL からすべての Cookie を読み取ります。

Y

Y

WVCookie.write

指定された URL の 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

現在のページのセーフエリアインセットを取得します。この API はフルスクリーンページにのみ適用されます。

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

連絡先リストを開きます。ユーザーが連絡先を選択すると、API は連絡先の名前と電話番号を HTML5 ページに返します。

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

Bluetooth 権限をリクエストし、Bluetooth を有効にします。

Y

Y

WVBluetooth.scan

近くの Bluetooth Low Energy (BLE) デバイスをスキャンします。

Y

Y

WVBluetooth.stopScan

BLE デバイスのスキャンを停止します。

Y

Y

WVBluetooth.connect

指定されたアドレスの BLE デバイスに接続します。

Y

Y

WVBluetooth.disconnect

接続されている BLE デバイスから切断します。

Y

Y

WVBluetooth.getServices

接続されている BLE デバイス上のサービスを検出します。

Y

Y

WVBluetooth.getCharacteristics

指定されたサービスのキャラクタリスティックを検出します。

Y

Y

WVBluetooth.writeValue

接続されている BLE デバイスの指定されたキャラクタリスティックに値を書き込みます。

Y

Y

WVBluetooth.readValue

接続されている BLE デバイスから指定されたキャラクタリスティックの値を読み取ります。

Y

Y

WVBluetooth.startNotifications

キャラクタリスティックの値の変更に関する通知を有効にします。

Y

Y

WVBluetooth.stopNotifications

キャラクタリスティックの値の変更に関する通知を無効にします。

Y

Y

API

説明

Android

iOS

WVStandardEventCenter.postNotificationToNative

ミニアプリからネイティブアプリにイベントを送信します。イベント名は、ネイティブアプリチームと合意した任意の名前にすることができます。

Y

Y

API

説明

Android

iOS

WindVaneReady

ページの読み込みが完了すると、WindVane は WindVaneReady イベントをトリガーします。このイベントをリッスンして、ページのロード状態を確認します。

Y

Y

Background

アプリケーションがバックグラウンドに移動すると (たとえば、ユーザーがアプリケーションを切り替えたり、通知シェードを開いたりした場合)、WindVane は WV.Event.APP.Background イベントをトリガーします。このイベントをリッスンして、アプリケーションがバックグラウンドに入ったことを検出できます。

Y

Y

Active

アプリケーションがバックグラウンドから復帰すると、WindVane は WV.Event.APP.Active イベントをトリガーします。このイベントをリッスンして、アプリケーションがアクティブになったことを検出できます。

Y

Y