Topik ini menjelaskan API JavaScript untuk kelas WVBase dalam pengembangan miniapp. API ini memungkinkan Anda menyalin teks ke clipboard, mengatur warna latar antarmuka pengguna (UI), memeriksa apakah suatu aplikasi telah terinstal, serta memverifikasi dukungan API pada versi saat ini.
WVBase.copyToClipboard
Menyalin teks yang ditentukan ke clipboard.
Parameter input
[
string] text: Teks yang akan disalin ke clipboard.
Parameter callback
Metode ini tidak mengembalikan parameter callback. Callback success dipanggil jika teks berhasil disalin ke clipboard; jika tidak, callback failure dipanggil.
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
Memeriksa apakah aplikasi tertentu telah terinstal.
Pada iOS 9 atau versi lebih baru, pemeriksaan ini hanya berfungsi jika scheme aplikasi dideklarasikan dalam kunci LSApplicationQueriesSchemes pada file info.plist.
Parameter input
[
string] ios: Identifier aplikasi untuk iOS, yaituschemeURL. Contohnya,'taobao://'.[
string] android: Identifier aplikasi untuk Android, yaitupackage name. Contohnya,'com.taobao.taobao'.
Parameter callback
Metode ini tidak mengembalikan parameter callback. Callback success dipanggil jika aplikasi telah terinstal; jika tidak, callback failure dipanggil.
var params = {
// Identifier aplikasi untuk iOS.
ios: 'taobao://',
// Identifier aplikasi untuk Android.
android: 'com.taobao.taobao'
};
window.WindVane.call('WVBase', 'isInstall', params, function(e) {
alert('success');
}, function(e) {
alert('failure');
});
WVBase.isAppsInstalled
Memeriksa apakah beberapa aplikasi tertentu telah terinstal.
Pada iOS 9 atau versi lebih baru, pemeriksaan ini hanya berfungsi jika scheme aplikasi dideklarasikan dalam kunci LSApplicationQueriesSchemes pada file info.plist.
Parameter input
[
object] Objek yang memetakan nama aplikasi unik (sepertitaobao) ke objek dengan properti berikut:[
string] ios: Identifier aplikasi untuk iOS, yaituschemeURL. Contohnya,'taobao://'.[
string] android: Identifier aplikasi untuk Android, yaitupackage name. Contohnya,'com.taobao.taobao'.
Parameter callback
Callback success menerima objek berisi hasilnya. Callback failure dipanggil jika terjadi error.
[
object] Objek yang memetakan setiap nama aplikasi input ke nilai boolean:truejika aplikasi telah terinstal, danfalsejika sebaliknya.
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
API ini hanya tersedia di iOS.
Memicu event kustom pada objek document dengan parameter yang ditentukan.
Parameter input
[
string] event: Nama event yang akan dipicu.[
object] param: Objek yang akan dikirim bersama event tersebut.
Parameter callback
Metode ini tidak mengembalikan parameter callback dan tidak memanggil callback success maupun failure.
Event Listening
Event ditentukan oleh event, dan parameter event adalah objek yang ditentukan oleh param.
document.addEventListener('MyNotifyName', function(e) {
alert(JSON.stringify(e.param));
}, false);
var params = {
// Nama event yang akan dipicu.
event: 'MyNotifyName',
// Parameter untuk event tersebut.
param: { MyEventParam: 'paramValue' }
};
window.WindVane.call('WVBase', 'notify', params);
WVBase.openBrowser
API ini hanya tersedia di iOS.
Membuka URL di jendela browser Safari baru.
Parameter input
[
string] url: URL yang akan dibuka di Safari.
Gunakan API ini hanya untuk memaksa URL dibuka di Safari. Jika tidak, navigasikan menggunakan tag <a> standar, location.href, atau atribut src pada iframe.
Parameter callback
Tidak ada parameter callback yang dikembalikan. Callback success dipanggil jika URL berhasil dibuka. Jika tidak, callback failure dipanggil.
var params = {
// URL yang akan ditampilkan di browser.
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 di iOS.
Mengatur warna latar WebView.
Parameter input
[
string] color:hexadecimal color codeuntukbackground colorWebView. Awalan seperti0xatau#didukung.[
number] alpha: [Opsional]opacitylatar belakang WebView. Nilainya berkisar dari0hingga1.
Parameter callback
Metode ini tidak mengembalikan parameter callback. Callback success dipanggil jika berhasil; jika tidak, 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 tersedia di WindVane untuk Android 1.0.3.4 dan versi lebih baru.
Memeriksa apakah API tertentu didukung oleh versi SDK saat ini.
Parameter input
[
string] api: Nama kelas API, sepertiWVBaseatauWVMotion.[
string] method: [Opsional] Nama metode dalam kelas API, sepertiisWindVaneSDKataucopyToClipboard. Jika parameter ini dihilangkan, metode hanya memeriksa ketersediaan kelas API tersebut.
Parameter callback
[
boolean] canUse:truejika API atau metode yang ditentukan didukung;falsejika tidak.
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 miniapp.
Parameter input
Tidak ada.
Parameter callback
Tidak ada.
window.WindVane.call('WVMiniApp', 'close', {}, function(e) {
alert('success');
}, function(e) {
alert('failure');
});