SuperApp:WVBase

WVBase.checkWindVaneSDK

指定されたバージョンの WindVane SDK と現在のバージョンの WindVane SDK を比較します。

入力パラメーター

• [string]v: 現在のバージョンの WindVane SDK と比較するバージョン。例: '5.3.0'。

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

コールバックパラメーターは、コールバックメソッドに渡されます。指定されたバージョンの WindVane SDK が現在のバージョンの WindVane と比較された場合、success コールバックが呼び出されます。それ以外の場合、failure コールバックが呼び出されます。

• [string]isHigher: 指定されたバージョンの WindVane SDK が現在のバージョンの WindVane よりも新しいかどうかを示します。有効な値：

  • '1': 指定されたバージョンの WindVane SDK は、現在のバージョンの WindVane SDK よりも新しいです。

  • '0': 指定されたバージョンの WindVane SDK は、現在のバージョンの WindVane SDK と同じです。

  • '-1': 指定されたバージョンの WindVane SDK は、現在のバージョンの WindVane SDK よりも古いバージョンです。

var params = {
        // 現在のバージョンの WindVane SDK と比較するバージョン。
        v: '5.3.0'
};
window.WindVane.call('WVBase', 'checkWindVaneSDK', params, function(e) {
        alert('success: ' + JSON.stringify(e));
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVBase.copyToClipboard

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

入力パラメーター

• [string]text: クリップボードにコピーするテキスト。

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

コールバックパラメーターはありません。テキストがクリップボードにコピーされると、success コールバックが呼び出されます。それ以外の場合、failure コールバックが呼び出されます。

var params = {
        text: "コピーするテキスト"
};
window.WindVane.call('WVBase', 'copyToClipboard', params, function(e) {
        alert('success' + JSON.stringify(e));
}, function(e) {
        alert('failure' + JSON.stringify(e));
});

WVBase.isInstall

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

入力パラメーター

• [string]ios: iOS で使用されるアプリラベル。iOS では、アプリのスキーマがラベルとして使用されます。例: 'taobao://'。

• [string]android: Android で使用されるアプリラベル。Android では、アプリのパッケージ名がラベルとして使用されます。例: 'com.taobao.taobao'。

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

コールバックパラメーターはありません。指定されたアプリがインストールされている場合、success コールバックが呼び出されます。それ以外の場合、failure コールバックが呼び出されます。

var params = {
        // iOS で使用されるアプリラベル。
        ios: 'taobao://',
        // Android で使用されるアプリラベル。
        android: 'com.taobao.taobao'
};
window.WindVane.call('WVBase', 'isInstall', params, function(e) {
        alert('success');
}, function(e) {
        alert('failure');
});

WVBase.isAppsInstalled

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

入力パラメーター

• [object]appName: インストール状態を確認するアプリ。このパラメーターの値はオブジェクトで、次のプロパティが含まれています。

  • [string]ios: iOS で使用されるアプリラベル。iOS では、アプリのスキーマがラベルとして使用されます。例: 'taobao://'。

  • [string]android: Android で使用されるアプリラベル。Android では、アプリのパッケージ名がラベルとして使用されます。例: 'com.taobao.taobao'。

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

コールバックパラメーターは、コールバックメソッドに渡されます。指定されたアプリがインストールされている場合、success コールバックが呼び出されます。それ以外の場合、failure コールバックが呼び出されます。

• [boolean]appName: 指定されたアプリがインストールされているかどうかを示します。

var params = {
        taobao: {
                ios: 'taobao://',
                android: 'com.taobao.taobao'
        },
        tmall: {
                ios: 'tmall://',
                android: 'com.tmall.tmall'
        }
};
window.WindVane.call('WVBase', 'isAppsInstalled', params, function(e) {
        alert('success: ' + JSON.stringify(e));
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVBase.isWindVaneSDK

現在の WindVane SDK のバージョンを取得します。現在の WindVane SDK のバージョンは、ユーザーエージェント (UA) からも取得できます。

入力パラメーター

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

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

コールバックパラメーターは、コールバックメソッドに渡されます。現在の WindVane SDK のバージョンが正常に返された場合、success コールバックが呼び出されます。それ以外の場合、failure コールバックが呼び出されます。

• [string]os: プラットフォームタイプ。有効な値: 'ios' および 'android'。

• [string]version: WindVane SDK のバージョン。

• [string]env: クライアント環境。有効な値: 'release'、'pre'、および 'daily'。このパラメーターは、WindVane iOS 8.1.0 以降で使用されます。

• [string]container: コンテナのタイプ。有効な値: 'WVWebView'、'WVWKWebView'、'WVUCWebView'、および 'Weex'。このパラメーターは、WindVane iOS 8.1.0 以降で使用されます。

window.WindVane.call('WVBase', 'isWindVaneSDK', {}, function(e) {
        alert('success: ' + JSON.stringify(e));
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVBase.notify

document 内の指定されたイベントをトリガーします。

入力パラメーター

• [string]event: WVBase.notify API がトリガーするために呼び出されるイベントの名前。

• [object]param: WVBase.notify API がトリガーするために呼び出されるイベントのパラメーター。

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

コールバックパラメーターはなく、success コールバックも failure コールバックも呼び出されません。

イベントリスニング

イベントは event パラメーターで指定され、イベントのパラメーターは param パラメーターで指定されます。

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

var params = {
        // WVBase.notify API がトリガーするために呼び出されるイベントの名前。
        event: 'MyNotifyName',
        // WVBase.notify API がトリガーするために呼び出されるイベントのパラメーター。
        param: { MyEventParam: 'paramValue' }
};
window.WindVane.call('WVBase', 'notify', params);

WVBase.openBrowser

新しい Safari ページを開いて、指定された URL にアクセスします。

入力パラメーター

• [string]url: Safari に表示される URL。

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

コールバックパラメーターはありません。指定された URL を使用して Safari ページが正常に開かれた場合、success コールバックが呼び出されます。それ以外の場合、failure コールバックが呼び出されます。

var params = {
        // Safari に表示される URL。
        url: 'http://www.baidu.com'
};
window.WindVane.call('WVBase', 'openBrowser', params, function(e) {
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVBase.setBackgroundColor

WebView の背景色を設定します。

入力パラメーター

• [string]color: WebView の背景色の 16 進カラーコード。0X または # プレフィックスがサポートされています。

• [number]alpha: オプション。WebView の背景色の不透明度。有効な値: [0, 1]。

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

コールバックパラメーターはありません。WebView の背景色の不透明度が正常に設定された場合、success コールバックが呼び出されます。それ以外の場合、failure コールバックが呼び出されます。

var params = {
        color: 'FF0000',
        alpha: 0.3
};
window.WindVane.call('WVBase', 'setBackgroundColor', params, function(e) {
        alert('success: ' + JSON.stringify(e));
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVBase.canIUse

API が現在の WindVane SDK バージョンでサポートされているかどうかを確認します。

入力パラメーター

• [string]api: API の名前。例: WVBase および WVMotion。

• [string]method: (オプション) API のメソッド。例: isWindVaneSDK および copyToClipboard。メソッドを指定しない場合、この API は、現在の WindVane SDK バージョンが指定した API をサポートしているかどうかについての情報のみを返します。

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

• [boolean]canUse: true は、API が現在の WindVane SDK バージョンでサポートされていることを示し、false は、API が現在の WindVane SDK バージョンでサポートされていないことを示します。

var params = {
        api: 'WVMotion',
        method: 'vibrate'
};
window.WindVane.call('WVBase', 'canIUse', params, function(e) {
        alert('success: ' + JSON.stringify(e));
}, function(e) {
        alert('failure: ' + JSON.stringify(e));
});

WVMiniApp.close

ミニアプリを閉じます。

入力パラメーター:

なし。

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

なし。

window.WindVane.call('WVMiniApp', 'close', {}, function(e) {
  			alert('success');
}, function(e) {
  			alert('failure');
});