このトピックでは、WVApplication の JavaScript API について説明します。HTML5 アプリまたはミニアプリを作成する際に、このトピックを参照できます。 WVApplication の JavaScript API を使用して、アプリのステータスを返し、アプリの設定ページを開くことができます。
WVApplication.appState
この API は WindVane iOS でのみ使用できます。
アプリのステータス(アプリがフォアグラウンドで実行されているかどうか)を返します。
入力パラメーター
入力パラメーターはありません。
コールバックパラメーター
コールバックパラメーターは、コールバックメソッドを使用して渡されます。アプリのステータスが返された場合は、success コールバックが呼び出されます。それ以外の場合は、failure コールバックが呼び出されます。
[
string]state: アプリのステータス。有効な値:'active': アプリはフォアグラウンドでアクティブです。'inactive': アプリはフォアグラウンドで非アクティブです。たとえば、通知バーがプルダウンされている場合、ホームキーをダブルタップしてタスクマネージャーを開いている場合、または画面がロックされている場合などです。'background': アプリはバックグラウンドで実行されています。'unknown': アプリのステータスは不明です。
window.WindVane.call('WVApplication', 'appState', {}, function(e) {
alert('success: ' + JSON.stringify(e));
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});
WVApplication.getNotificationSettings
この API は WindVane iOS でのみ使用できます。
アプリの通知ステータスを返します。
入力パラメーター
入力パラメーターはありません。
コールバックパラメーター
コールバックパラメーターは、コールバックメソッドを使用して渡されます。アプリの通知ステータスが返された場合は、success コールバックが呼び出されます。それ以外の場合は、failure コールバックが呼び出されます。
[
string]status: アプリの通知ステータス。有効な値:'authorized': ユーザーは通知を許可しています。'denied': ユーザーは通知を拒否しています。'notDetermined': ユーザーは通知を許可するかどうかを決定していません。この値は、iOS アプリが通知許可をリクエストする前に返される場合があります。'unknown': アプリの通知ステータスは不明です。
window.WindVane.call('WVApplication', 'getNotificationSettings', {}, function(e) {
alert('success: ' + JSON.stringify(e));
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});
WVApplication.openSettings
この API は WindVane iOS でのみ使用できます。
アプリの設定ページを開きます。
入力パラメーター
[
string]type: (オプション)開きたい設定ページの種類。値が指定されていない場合は、アプリの設定ページが開きます。有効な値:
'Notification': アプリの通知設定ページを開くように指定します。iOS では、アプリの設定ページは常に表示されます。
コールバックパラメーター
コールバックパラメーターはありません。設定ページが開かれた場合は、success コールバックが呼び出されます。それ以外の場合は、failure コールバックが呼び出されます。
window.WindVane.call('WVApplication', 'openSettings', {}, function(e) {
alert('success: ' + JSON.stringify(e));
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});