Spesifikasi dan batasan - SuperApp

Topik ini menjelaskan spesifikasi dan batasan yang menjadi dasar penggunaan API JavaScript dari miniapps WindVane.

Spesifikasi UA

WindVane menambahkan tag WindVane, versi SDK WindVane, User-Agent (UA) tambahan dari klien, serta resolusi layar saat ini ke nilai UA default untuk membantu Anda mengidentifikasi lingkungan.

UA lengkap mencakup elemen-elemen berikut: UA Default (termasuk nama aplikasi atau versi aplikasi), Versi WindVane atau WindVane SDK, UA Tambahan dari klien, Resolusi (WxH). Setiap item dipisahkan oleh spasi.

Contoh UA Android:

Mozilla/5.0 (Linux; Android 10; TAS-AN00 Build/HUAWEITAS-AN00; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/88.0.4324.93 Mobile Safari/537.36 TTID/aaa WindVane/8.5.0

Contoh UA iOS:

Mozilla\/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit\/605.1.15 (KHTML, like Gecko) Mobile\/19F70 AliApp(EMASDemo\/2.0.0) WindVane\/8.6.1 TBIOS 1170x2532

WindVane iOS memungkinkan Anda menggunakan metode setAppUA untuk mengonfigurasi UA tambahan dari klien. Pastikan huruf kecil x digunakan saat menyertakan resolusi dalam UA.
WindVane Android tidak menyediakan metode untuk mengonfigurasi UA tambahan dari klien. Pastikan huruf besar X digunakan saat menyertakan resolusi dalam UA.

Penting

Kami menyarankan agar Anda tidak menggunakan UA tambahan dari klien untuk menentukan sistem operasi dan versi klien.

Spesifikasi API JavaScript

Anda dapat menggunakan window.WindVane.call(className, methodName, params, successCallback, failureCallback, timeout) untuk memanggil fitur-fitur klien.

Catatan

API JavaScript tidak dapat dipanggil di dalam iframe.

Parameter Input

Tipe	Parameter	Deskripsi
`string`	className	Nama kelas klien yang ingin Anda panggil.
`string`	methodName	Nama metode klien yang ingin Anda panggil.
`object`	params	Parameter yang ingin Anda lewatkan ke klien.
`function`	successCallback	Callback yang dilakukan setelah JSBridge dipanggil.
`function`	failureCallback	Callback yang dilakukan setelah JSBridge gagal dipanggil.
`number`	timeout	Opsional. Pemanggilan JSBridge mengalami waktu habis. Jika terjadi waktu habis, parameter `{ret:['HY_TIMEOUT']}` secara otomatis disertakan dalam fungsi callback.

Baik successCallback maupun failureCallback dipanggil oleh aplikasi asli. Jika Anda ingin menggunakan try...catch untuk menangkap pengecualian, tulis try...catch dalam fungsi callback.

Dalam topik ini, nama kelas klien dan metode yang perlu dipanggil ditentukan dalam format className.methodName.

Parameter Callback: Jika API klien berhasil dipanggil, callback success dilakukan. Jika pemanggilan API klien gagal, callback failure dilakukan. Parameter fungsi callback bervariasi berdasarkan API yang dipanggil.

ret dalam Parameter Callback: Parameter callback mungkin mencakup properti ret. Properti ini menunjukkan status callback. Tabel berikut menjelaskan nilai-nilai valid dari properti ret.

Nilai	Deskripsi
`'HY_SUCCESS'`	Menunjukkan bahwa pemanggilan API berhasil. Nilai ini hanya digunakan dalam callback `success`.
`'HY_CLOSED'`	Menunjukkan bahwa fitur JSBridge dinonaktifkan secara paksa. Dalam banyak kasus, masalah ini terjadi karena URL halaman tidak ditentukan dalam daftar domain tepercaya atau fitur JSBridge tidak diaktifkan untuk aplikasi asli. Jika masalah ini terjadi, periksa URL atau hubungi pengembang kontainer HTML5 asli untuk menyelesaikan masalah.
`'HY_NO_HANDLER'`	Menunjukkan bahwa klien saat ini tidak menyediakan API ini. Periksa apakah JSBridge yang dipanggil benar dan hubungi penyedia aplikasi asli untuk JSBridge untuk menyelesaikan masalah.
`'HY_PARAM_ERR'`	Menunjukkan bahwa parameter input tidak valid. Pastikan parameter input valid.
`'HY_NO_PERMISSION'`	Menunjukkan bahwa halaman saat ini tidak memiliki izin untuk memanggil API ini.
`'HY_FAILED'`	Menunjukkan bahwa pemanggilan API gagal. Hubungi penyedia aplikasi asli untuk JSBridge untuk menyelesaikan masalah.
`'HY_EXCEPTION'`	Menunjukkan bahwa terjadi kesalahan saat API dipanggil. Hubungi penyedia aplikasi asli untuk JSBridge untuk menyelesaikan masalah.
`'HY_USER_DENIED'`	Menunjukkan bahwa API tidak diberi izin untuk melakukan operasi. Misalnya, klien ingin memanggil API ini untuk mengakses album, tetapi klien tidak diizinkan mengakses album.
`'HY_USER_CANCELLED'`	Menunjukkan bahwa pengguna membatalkan permintaan API saat ini.
`'HY_RET_PHOTO_CANCLE'`	Menunjukkan bahwa pengguna membatalkan permintaan untuk mengambil foto dengan menggunakan API yang disediakan oleh WVCamera.
`'HY_TIMEOUT'`	Menunjukkan bahwa pemanggilan JSBridge mengalami waktu habis.
`'HY_RESULT_PARSE_ERROR'`	Menunjukkan bahwa format data yang dilewatkan oleh aplikasi asli ke HTML5 tidak valid.
`'HY_NOT_IN_WINDVANE'`	Menunjukkan bahwa lingkungan saat ini bukan WindVane seperti browser, atau bahwa UserAgent WindVane yang disediakan oleh klien tidak valid. Sebagai alternatif, JavaScript halaman salah memodifikasi variabel lingkungan dalam file windvane.js. Misalnya, `WindVane.isAvailable` disetel ke false.
`'HY_NOT_SUPPORT_DEVICE'`	Menunjukkan bahwa JSBridge dipanggil pada perangkat atau dalam lingkungan yang tidak didukung, seperti browser. Sebagai alternatif, tindakan JavaScript pada halaman salah memodifikasi variabel lingkungan dalam file windvane.js. Misalnya, `WindVane.isAvailable` disetel ke false.
`'HY_NO_HANDLER_ON_WP'`	Menunjukkan bahwa JSBridge dipanggil pada perangkat Windows atau dalam lingkungan yang tidak didukung, seperti browser.
`'WV_ERR::PARAM_PARSE_ERROR'`	Menunjukkan bahwa format data yang dilewatkan oleh aplikasi asli ke HTML5 tidak valid.

Nilai properti ret bervariasi berdasarkan API JavaScript yang dipanggil. Nilai properti ret bisa berupa string kosong, string, atau array. ret[0] mencakup status eksekusi API klien. Tidak semua API JavaScript dapat memanggil fungsi callback. Pemanggilan fungsi callback menggunakan API JavaScript terkait dengan implementasi klien. Dokumentasi API JavaScript menjelaskan skenario penggunaan di mana callback sukses atau callback gagal terjadi.