Topik ini menjelaskan API JavaScript dari WVBase. Anda dapat merujuk ke topik ini saat mengembangkan program mini. Gunakan API JavaScript dari WVBase untuk mendapatkan dan membandingkan versi SDK, menyalin dan menempel teks, mengonfigurasi warna latar belakang UI, serta memeriksa apakah aplikasi tertentu terpasang dan apakah API didukung oleh versi SDK WindVane saat ini.
WVBase.checkWindVaneSDK
API ini hanya tersedia untuk WindVane iOS.
Membandingkan versi tertentu dari SDK WindVane dengan versi saat ini dari SDK WindVane.
Parameter Input
[
string] v: Versi yang ingin dibandingkan dengan versi saat ini dari SDK WindVane. Contoh:'5.3.0'.
Parameter Callback
Parameter callback diteruskan dalam metode callback. Jika versi tertentu dari SDK WindVane lebih tinggi atau sama dengan versi saat ini, callback success dipanggil. Sebaliknya, callback failure dipanggil.
[
string] isHigher: Menunjukkan apakah versi tertentu dari SDK WindVane lebih baru daripada versi saat ini. Nilai valid:'1': Versi tertentu dari SDK WindVane lebih baru daripada versi saat ini.'0': Versi tertentu dari SDK WindVane sama dengan versi saat ini.'-1': Versi tertentu dari SDK WindVane lebih lama daripada versi saat ini.
var params = {
// Versi yang ingin Anda bandingkan dengan versi saat ini dari SDK WindVane.
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
Menyalin teks tertentu ke clipboard.
Parameter Input
[
string] text: Teks yang ingin disalin ke clipboard.
Parameter Callback
Tidak ada parameter callback. Jika teks berhasil disalin ke clipboard, callback success dipanggil. Sebaliknya, callback failure dipanggil.
var params = {
text: "teks untuk disalin"
};
window.WindVane.call('WVBase', 'copyToClipboard', params, function(e) {
alert('success' + JSON.stringify(e));
}, function(e) {
alert('failure' + JSON.stringify(e));
});
WVBase.isInstall
Memeriksa apakah aplikasi tertentu telah terpasang.
Pada iOS 9 atau lebih baru, Anda dapat memeriksa apakah suatu aplikasi terpasang berdasarkan skema yang dikonfigurasi di LSApplicationQueriesSchemes dari info.plist.
Parameter Input
[
string] ios: Label aplikasi yang digunakan di iOS. Di iOS, skema aplikasi digunakan sebagai label. Contoh:'taobao://'.[
string] android: Label aplikasi yang digunakan di Android. Di Android, nama paket aplikasi digunakan sebagai label. Contoh:'com.taobao.taobao'.
Parameter Callback
Tidak ada parameter callback. Jika aplikasi tertentu terpasang, callback success dipanggil. Sebaliknya, callback failure dipanggil.
var params = {
// Label aplikasi yang digunakan di iOS.
ios: 'taobao://',
// Label aplikasi yang digunakan di Android.
android: 'com.taobao.taobao'
};
window.WindVane.call('WVBase', 'isInstall', params, function(e) {
alert('success');
}, function(e) {
alert('failure');
});
WVBase.isAppsInstalled
Memeriksa apakah aplikasi tertentu telah terpasang.
Pada iOS 9 atau lebih baru, Anda dapat memeriksa apakah suatu aplikasi terpasang berdasarkan skema yang dikonfigurasi di LSApplicationQueriesSchemes dari info.plist.
Parameter Input
[
object] appName: Aplikasi yang status pemasangannya ingin diperiksa. Nilai parameter ini adalah objek dan mencakup properti berikut:[
string] ios: Label aplikasi yang digunakan di iOS. Di iOS, skema aplikasi digunakan sebagai label. Contoh:'taobao://'.[
string] android: Label aplikasi yang digunakan di Android. Di Android, nama paket aplikasi digunakan sebagai label. Contoh:'com.taobao.taobao'.
Parameter Callback
Parameter callback diteruskan dalam metode callback. Jika aplikasi tertentu terpasang, callback success dipanggil. Sebaliknya, callback failure dipanggil.
[
boolean] appName: Menunjukkan apakah aplikasi tertentu telah terpasang.
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
Mendapatkan versi saat ini dari SDK WindVane. Anda juga dapat mendapatkan versi saat ini dari SDK WindVane dari User-Agent (UA).
Parameter Input
Tidak ada parameter input.
Parameter Callback
Parameter callback diteruskan dalam metode callback. Jika versi saat ini dari SDK WindVane berhasil dikembalikan, callback success dipanggil. Sebaliknya, callback failure dipanggil.
[
string] os: Jenis platform. Nilai valid:'ios'dan'android'.[
string] version: Versi dari SDK WindVane.[
string] env: Lingkungan klien. Nilai valid:'release','pre', dan'daily'.Parameter ini digunakan di WindVane iOS 8.1.0 atau lebih baru.[
string] container: Jenis kontainer. Nilai valid:'WVWebView','WVWKWebView','WVUCWebView', dan'Weex'.Parameter ini digunakan di WindVane iOS 8.1.0 atau lebih baru.
window.WindVane.call('WVBase', 'isWindVaneSDK', {}, function(e) {
alert('success: ' + JSON.stringify(e));
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});
WVBase.notify
API ini hanya tersedia untuk WindVane iOS.
Memicu event tertentu di document.
Parameter Input
[
string] event: Nama event yang dipicu oleh pemanggilan API WVBase.notify.[
object] param: Parameter dari event yang dipicu oleh pemanggilan API WVBase.notify.
Parameter Callback
Tidak ada parameter callback, dan tidak ada callback success atau failure yang dipanggil.
Pemantauan Event
Event ditentukan oleh parameter event dan parameter dari event ditentukan oleh parameter param.
document.addEventListener('MyNotifyName', function(e) {
alert(JSON.stringify(e.param));
}, false);
var params = {
// Nama event yang dipicu oleh pemanggilan API WVBase.notify.
event: 'MyNotifyName',
// Parameter dari event yang dipicu oleh pemanggilan API WVBase.notify.
param: { MyEventParam: 'paramValue' }
};
window.WindVane.call('WVBase', 'notify', params);
WVBase.openBrowser
API ini hanya tersedia untuk WindVane iOS.
Membuka halaman Safari baru untuk mengakses URL tertentu.
Parameter Input
[
string] url: URL yang ditampilkan di Safari.
Gunakan JSBridge hanya jika Anda perlu memastikan bahwa URL dibuka di Safari. Dalam kasus lain, gunakan hyperlink <a>, konfigurasikan location.href, atau konfigurasikan iframe untuk mengakses URL tertentu.
Parameter Callback
Tidak ada parameter callback. Jika halaman Safari berhasil dibuka menggunakan URL tertentu, callback success dipanggil. Sebaliknya, callback failure dipanggil.
var params = {
// URL yang ditampilkan di Safari.
url: 'http://www.baidu.com'
};
window.WindVane.call('WVBase', 'openBrowser', params, function(e) {
}, function(e) {
alert('failure: ' + JSON.stringify(e));
});
WVBase.setBackgroundColor
API ini hanya tersedia untuk WindVane iOS.
Mengonfigurasi warna latar belakang WebView.
Parameter Input
[
string] color: Kode warna heksadesimal dari warna latar belakang WebView. Awalan0Xatau#didukung.[
number] alpha: Opsional. Tingkat opasitas warna latar belakang WebView. Nilai valid:[0, 1].
Parameter Callback
Tidak ada parameter callback. Jika tingkat opasitas warna latar belakang WebView berhasil dikonfigurasi, callback success dipanggil. Sebaliknya, callback failure dipanggil.
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 ini hanya tersedia untuk WindVane Android 1.0.3.4 atau lebih baru.
Memeriksa apakah API didukung oleh versi SDK WindVane saat ini.
Parameter Input
[
string] api: Nama API. Contoh: WVBase dan WVMotion.[
string] method: (Opsional) Metode dari API. Contoh: isWindVaneSDK dan copyToClipboard. Jika Anda tidak menentukan metode, API ini hanya mengembalikan informasi tentang apakah versi SDK WindVane saat ini mendukung API yang Anda tentukan.
Parameter Callback
[
boolean] canUse: true menunjukkan bahwa API didukung oleh versi SDK WindVane saat ini, dan false menunjukkan bahwa API tidak didukung oleh versi SDK WindVane saat ini.
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
Menutup program mini.
Parameter Input:
Tidak ada.
Parameter Callback:
Tidak ada.
window.WindVane.call('WVMiniApp', 'close', {}, function(e) {
alert('success');
}, function(e) {
alert('failure');
});