このトピックでは、WVUIDialog API について説明します。この API を使用すると、HTML5 アプリやミニアプリで、アラート、確認ダイアログ、プロンプト、権限ガイダンスダイアログなど、さまざまなダイアログを作成できます。
WVUIDialog.alert
アラートを表示します。
iOS | Android の場合 |
|
|
入力パラメーター
message(string):アラートに表示するメッセージ。okbutton(string):OK ボタンのテキスト。identifier(string):アラートの識別子。
イベント
ユーザーがアラートに応答すると、WV.Event.Alert がトリガーされます。
イベントパラメーター
identifier(string):アラートの識別子。
コールバックパラメーター
アラートが正常に表示されると、 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の場合 |
|
|
入力パラメーター
message(string):確認ダイアログに表示するメッセージ。okbutton(string):OK ボタンのテキスト。cancelbutton(string):キャンセルボタンのテキスト。_index(int):確認ダイアログを識別するための一意なインデックス。
コールバックパラメーター
確認ダイアログが正常に表示されると、success コールバックが呼び出されます。エラーが発生した場合、failure コールバックが呼び出されます。コールバックではパラメーターは返されません。
イベント
ユーザーが確認ダイアログに応答すると、wv.dialog がトリガーされます。
イベントパラメーター
type(文字列): タップされたボタンのテキストです。この値は、okbuttonまたはcancelbutton入力パラメーターと一致します。_index(int):_index入力パラメーターと一致する確認ダイアログのインデックス。
document.addEventListener('wv.dialog', function(e) {
alert(JSON.stringify(e.param));
}, false);
var params = {
// 確認ダイアログに表示するメッセージ。
message: 'Are you really really sure?',
// OK ボタンのテキスト。
okbutton: 'OK',
// キャンセルボタンのテキスト。
cancelbutton: 'Cancel',
// 確認ダイアログのインデックス。
_index: 10086
};
window.WindVane.call('WVUIDialog', 'confirm', params, function(e) {
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});
WVUIDialog.enableAlertBeforeUnload
この API は、WindVane for Android 1.0.3.4 以降でのみサポートされています。
ユーザーがミニアプリのページを離れる際に、確認アラートを有効にします。有効にすると、戻るボタンを押してページを閉じるときにこのアラートがトリガーされます。
入力パラメーター
message(string):オプション。ダイアログに表示するメッセージ。このパラメーターを省略した場合、デフォルトのメッセージは "Leave this page?" です。
コールバックパラメーター
成功コールバック:
なし。
失敗コールバック:
msg (
string):エラーメッセージ。
var params = {
// ダイアログの内容。
message: 'Are you sure you want to leave this page?',
};
window.WindVane.call('WVUIDialog', 'enableAlertBeforeUnload', params, function(e) {
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});WVUIDialog.disableAlertBeforeUnload
この API は、WindVane for Android 1.0.3.4 以降でのみサポートされています。
ユーザーがミニアプリのページから離れようとするときに表示される確認アラートを無効にします。
入力パラメーター
なし。
コールバックパラメーター
成功コールバック:
なし。
失敗コールバック:
msg (
string):エラーメッセージ。
window.WindVane.call('WVUIDialog', 'disableAlertBeforeUnload', {}, function(e) {
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});WVUIDialog.prompt
この API は、WindVane for Android 1.0.3.4 以降でのみサポートされています。
テキスト入力用のプロンプトを表示します。
入力パラメーター
title(string):オプション。プロンプトのタイトル。message(string):プロンプトに表示されるメッセージ。デフォルト:"Please enter content."hint(string):オプション。入力フィールドのプレースホルダーテキスト。okbutton(string):オプション。OK ボタンのテキスト。デフォルト:"OK"cancelbutton(string):オプション。キャンセルボタンのテキスト。デフォルト:"Cancel"
コールバックパラメーター
成功コールバック:
ok(boolean):OK ボタンがタップされた場合はtrueを、キャンセルボタンがタップされた場合はfalseを返します。inputValue(string):okがtrueの場合、このパラメーターにはユーザーが入力したテキストが含まれます。
失敗コールバック:
msg (
string):エラーメッセージ。
var params = {
title: 'Prompt',
message: 'Please enter xxx',
hint: 'Please enter xxx',
okbutton: 'OK',
cancelbutton: 'Cancel'
};
window.WindVane.call('WVUIDialog', 'prompt', params, function(e) {
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});WVUIDialog.showAuthGuide
この API は、WindVane for Android 1.0.3.4 以降でのみサポートされています。
テキストと画像を使用して、ユーザーに特定の権限を付与するよう案内する権限ガイダンスダイアログを表示します。
入力パラメーター
permission(string):cameraやaddress bookなどの権限の名前。okbutton(string):OK ボタンのテキスト。jumpToSettings(string):オプション。ユーザーが OK ボタンをタップした後にアプリ詳細ページにリダイレクトするかどうかを指定します。リダイレクトするには1を、リダイレクトしない場合は0を設定します。デフォルト:0。
コールバックパラメーター
成功コールバック:
なし。
失敗コールバック:
msg (
string):エラーメッセージ。
var params = {
permission: 'address book',
cancelbutton: 'Cancel',
okbutton:'OK'
};
window.WindVane.call('WVUIDialog', 'showAuthGuide', params, function(e) {
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});WVUIDatePicker.show
日付ピッカーを表示します。デフォルトの日付を設定できます。設定しない場合、現在の日付がデフォルトとして使用されます。
入力パラメーター
year(string):デフォルトで選択される年。month(string):デフォルトで選択される月。dayOfMonth(string):デフォルトで選択される日。minYear(string):選択可能な最小の年。minMonth(string):選択可能な最小の月。minDayOfMonth(string):選択可能な最小の日。maxYear(string):選択可能な最大の年。maxMonth(string):選択可能な最大の月。maxDayOfMonth(string):選択可能な最大の日。
コールバックパラメーター
選択が成功すると success コールバックが呼び出され、選択された日付をパラメーターとして受け取ります。操作が失敗すると failure コールバックが呼び出されます。
year(string):選択された年。month(string):選択された月。dayOfMonth(string):選択された日。
var params = {
year: 2022,
month: 11,
dayOfMonth: 15
};
window.WindVane.call('WVUIDatePicker', 'show', params, function(e) {
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});


