SuperApp:WVBase クラスの JavaScript API

WVBase.copyToClipboard

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

入力パラメーター

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

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

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

var params = {
        text: "text to copy"
};
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 用のアプリ識別子で、URL scheme です。例：'taobao://'。

• [string] 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] 一意のアプリ名 (例：taobao) を、以下のプロパティを持つオブジェクトに対応付けるオブジェクトです。

  • [string] ios：iOS 用のアプリ識別子で、URL scheme です。例：'taobao://'。

  • [string] android：Android 用のアプリ識別子で、パッケージ名です。例：'com.taobao.taobao'。

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

success コールバックは結果を含むオブジェクトを受け取ります。エラーが発生した場合は failure コールバックが呼び出されます。

• [object] 各入力アプリ名をブール値にマッピングするオブジェクトです。アプリがインストールされている場合は true、そうでない場合は false になります。

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.notify

指定されたパラメーターを使用して、document オブジェクトでカスタム イベントをトリガーします。

入力パラメーター

• [string] event：トリガーするイベントの名前です。

• [object] param：イベントと共に渡すオブジェクトです。

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

このメソッドはコールバックパラメーターを返さず、success または failure コールバックを呼び出しません。

イベントリスニング

イベントは event で指定され、イベントパラメーターは param で指定されたオブジェクトです。

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

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

WVBase.openBrowser

新しい Safari ブラウザウィンドウで URL を開きます。

入力パラメーター

• [string] url：Safari で開く URL です。

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

コールバックパラメーターは返されません。URL が正常に開かれた場合は success コールバックが呼び出されます。それ以外の場合は、failure コールバックが呼び出されます。

var params = {
        // ブラウザに表示する 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 までの値です。

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

このメソッドはコールバックパラメーターを返しません。成功した場合は 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 が現在の SDK バージョンでサポートされているかどうかを確認します。

入力パラメーター

• [string] api：API クラスの名前です。例：WVBase、WVMotion。

• [string] method：[任意] API クラス内のメソッドの名前です。例：isWindVaneSDK、copyToClipboard。このパラメーターを省略した場合、メソッドは API クラスの可用性のみをチェックします。

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

• [boolean] canUse：指定された API またはメソッドがサポートされている場合は true、そうでない場合は false になります。

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');
});