すべてのプロダクト
Search
ドキュメントセンター

SuperApp:ダイアログ

最終更新日:Jan 18, 2025

このトピックでは、WVUIDialog の JavaScript API について説明します。 HTML5 アプリまたはミニアプリを作成する際に、このトピックを参照できます。 WVUIDialog の JavaScript API は、プロンプトメッセージ、確認メッセージ、警告メッセージ、権限ガイダンスメッセージなど、さまざまな機能を提供します。

WVUIDialog.alert

警告メッセージを表示します。

iOS デバイスでの効果

Android デバイスでの効果

WVUIDialog_alert_iOS@2x.png

WVUIDialog_alert_Android@2x.png

入力パラメーター

  • [string] message:表示する警告メッセージ。

  • [string] okbutton:警告メッセージの [OK] ボタン。

  • [string] identifier:警告メッセージの識別子。

イベントリスニング

WV.Event.Alert イベントは、警告メッセージに応答したことを示します。

イベントパラメーター:

  • [string] identifier:警告メッセージの識別子。

コールバックパラメーター

コールバックパラメーターはありません。警告メッセージが表示された場合は、success コールバックが呼び出されます。それ以外の場合は、failure コールバックが呼び出されます。

var params = {
        // 表示する警告メッセージ。
        message: 'Hello World!',
        // 警告メッセージの [OK] ボタン。
        okbutton: 'OK',
};
window.WindVane.call('WVUIDialog', 'alert', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVUIDialog.confirm

確認メッセージを表示します。

iOS デバイスでの効果

Android デバイスでの効果

WVUIDialog_confirm_iOS@2x.png

WVUIDialog_confirm_Android@2x.png

入力パラメーター

  • [string] message:表示する確認メッセージ。

  • [string] okbutton:確認メッセージの [OK] ボタン。

  • [string] cancelbutton:確認メッセージの [キャンセル] ボタン。

  • [int] _index:確認メッセージのインデックス。インデックスは、確認メッセージを一意に識別します。

コールバックパラメーター

コールバックパラメーターはありません。確認メッセージが表示された場合は、success コールバックが呼び出されます。それ以外の場合は、failure コールバックが呼び出されます。

イベントリスニング

wv.dialog イベントは、確認メッセージに応答したことを示します。

イベントパラメーター:

  • [string] type:タップしたボタンのテキスト。値は、入力パラメーターの okbutton または canclebutton です。

  • [int] _index:確認メッセージのインデックス。値は、入力パラメーター _index の値と同じです。

document.addEventListener('wv.dialog', function(e) {
alert(JSON.stringify(e.param));
}, false);

var params = {
// 表示する確認メッセージ。
message: '本当に本当によろしいですか?',
// 確認メッセージの [OK] ボタン。
okbutton: 'OK',
// 確認メッセージの [キャンセル] ボタン。
canclebutton: 'キャンセル',
// 確認メッセージのインデックス。
_index: 10086
};
window.WindVane.call('WVUIDialog', 'confirm', params, function(e) {
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});

WVUIDialog.enableAlertBeforeUnload

説明

この API は、WindVane Android 1.0.3.4 以降、WindVane iOS 2.1.4 以降でのみ使用できます。

ミニアプリページを閉じるための問い合わせダイアログを有効にします。この機能が有効になっている場合、[戻る] ボタンをクリックしてミニアプリページを閉じようとすると、「終了を確認」ダイアログが表示されます。

入力パラメーター

  • [string] message:オプション。ダイアログに表示されるメッセージ。メッセージを指定しない場合、デフォルトのメッセージは「終了を確認しますか?」です。

コールバックパラメーター

成功コールバックのパラメーター:

  • コールバックパラメーターはありません。

失敗コールバックのパラメーター:

  • [string] msg:エラーメッセージ。

var params = {
    // ダイアログの内容。
    message: '終了を確認しますか?',
};

window.WindVane.call('WVUI', 'enableAlertBeforeUnload', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVUIDialog.disableAlertBeforeUnload

説明

この API は、WindVane Android 1.0.3.4 以降、WindVane iOS 2.1.4 以降でのみ使用できます。

ミニアプリページを閉じるための問い合わせダイアログを無効にします。

入力パラメーター

  • 入力パラメーターはありません。

コールバックパラメーター

成功コールバックのパラメーター:

  • コールバックパラメーターはありません。

失敗コールバックのパラメーター:

  • [string] msg:エラーメッセージ。

window.WindVane.call('WVUI', 'disableAlertBeforeUnload', {}, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVUIDialog.prompt

説明

この API は、WindVane Android 1.0.3.4 以降、WindVane iOS 2.1.4 以降でのみ使用できます。

表示されるダイアログにテキストを入力します。

入力パラメーター

  • [string] title:オプション。プロンプトメッセージのタイトル。

  • [string] message:プロンプトメッセージのテキスト。デフォルトのパラメーター値は「内容を入力してください」です。

  • [string] hint:オプション。入力ボックスのプロンプトコンテンツ。

  • [string] okbutton:確認メッセージの [OK] ボタン。オプション。デフォルト値は「OK」です。

  • [string] cancelbutton:確認メッセージの [キャンセル] ボタン。オプション。デフォルトのパラメーター値は「キャンセル」です。

コールバックパラメーター

成功コールバックのパラメーター:

  • [boolean] ok:[OK] をクリックすると、true が返されます。[キャンセル] をクリックすると、false が返されます。

  • [string] inputValue:[OK] をクリックすると、true とタップした内容が返されます。

失敗コールバックのパラメーター:

  • [string] msg:エラーメッセージ。

var params = {
  	    title: 'プロンプトメッセージ'
        message: 'xxx を入力してください'
  		  hint: 'xxx を入力してください'
        okbutton: 'OK',
  		  cancelbutton: 'キャンセル'
};
window.WindVane.call('WVUIDialog', 'prompt', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVUIDialog.showAuthGuide

説明

この API は、WindVane Android 1.0.3.4 以降、WindVane iOS 2.1.4 以降でのみ使用できます。

権限ガイダンスモジュールを介して、画像とテキスト形式で表示されるダイアログで対応する権限を有効にします。

入力パラメーター

  • [string] permission:権限のテキスト。例:「カメラ」、「アドレス帳」など。

  • [string] okbutton:確認メッセージの [OK] ボタン。

  • [string] jumpToSettings:[OK] ボタンをクリックした後にアプリの詳細ページにリダイレクトするかどうかを指定します。「0」は、アプリの詳細ページにリダイレクトされないことを示します。「1」は、アプリの詳細ページにリダイレクトされることを示します。デフォルト値は「0」です。このパラメーターはオプションです。

コールバックパラメーター

成功コールバックのパラメーター:

  • コールバックパラメーターはありません。

失敗コールバックのパラメーター:

  • [string] msg:エラーメッセージ。

var params = {
  	    permission: 'アドレス帳'
  		  cancelbutton: 'キャンセル'
};
window.WindVane.call('WVUIDialog', 'showAuthGuide', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});