Ringkasan antara muka WeChat JS dan penjelasan terperinci tentang kemahiran usage_javascript

Arahan asas

Arahan penggunaan

1. Import fail JS
Perkenalkan fail JS berikut ke dalam halaman yang perlu memanggil antara muka JS (menyokong https): http://res.wx.qq.com/open/js/jweixin-1.0.0.js

Nota: Menyokong pemuatan menggunakan kaedah pemuatan modul standard AMD/CMD

2. Suntikan antara muka konfigurasi konfigurasi
Semua halaman yang perlu menggunakan JSSDK mesti terlebih dahulu menyuntik maklumat konfigurasi, jika tidak, halaman tersebut tidak akan dipanggil (URL yang sama hanya perlu dipanggil sekali dan apl web SPA yang menukar URL boleh dipanggil setiap kali URL berubah).

Salin kod Kod adalah seperti berikut:

wx.config({
debug: true, // Hidupkan mod penyahpepijatan Nilai pulangan semua panggilan api akan dimaklumkan pada bahagian klien Jika anda ingin melihat parameter masuk, anda boleh membukanya di sebelah PC dicetak melalui log, hanya pada bahagian PC sahaja yang akan dicetak.
appId: '', // Diperlukan, pengecam unik akaun rasmi
cap masa: , // Diperlukan, cap masa untuk menjana tandatangan
nonceStr: '', // Diperlukan, jana rentetan rawak tandatangan
tandatangan: '',//Diperlukan, tandatangan, lihat Lampiran 1
jsApiList: [] // Diperlukan, senarai antara muka JS yang perlu digunakan Untuk senarai semua antara muka JS, lihat Lampiran 2
});

3. Sahkan melalui antara muka sedia

Salin kod Kod adalah seperti berikut:

wx.ready(function(){

// Kaedah sedia akan dilaksanakan selepas maklumat konfigurasi disahkan Semua panggilan antara muka mesti dibuat selepas antara muka konfigurasi memperoleh hasil konfigurasi adalah operasi tak segerak pada bahagian klien, jadi jika anda perlu memanggil yang berkaitan antara muka apabila halaman dimuatkan, anda mesti meletakkan yang berkaitan Antara muka dipanggil dalam fungsi sedia untuk memastikan pelaksanaan yang betul. Untuk antara muka yang dipanggil hanya apabila dicetuskan oleh pengguna, ia boleh dipanggil terus dan tidak perlu diletakkan dalam fungsi sedia.
});

4. Antara muka ralat kegagalan pengesahan

Salin kod Kod adalah seperti berikut:

wx.error(function(res){
// Jika pengesahan maklumat konfigurasi gagal, fungsi ralat akan dilaksanakan Jika tandatangan tamat tempoh dan pengesahan gagal, maklumat ralat tertentu boleh dilihat dengan membuka mod nyahpepijat konfigurasi atau dalam parameter res yang dikembalikan. tandatangan boleh dikemas kini di sini.
});

Arahan panggilan antara muka
Semua antara muka dipanggil melalui objek wx (objek jWeixin juga boleh digunakan Parameter adalah objek Selain parameter yang perlu dilalui oleh setiap antara muka itu sendiri, terdapat juga parameter biasa berikut:

kejayaan: Fungsi panggil balik dilaksanakan apabila panggilan antara muka berjaya.
gagal: Fungsi panggil balik dilaksanakan apabila panggilan antara muka gagal.
complete: Fungsi panggil balik dilaksanakan apabila panggilan antara muka selesai, tanpa mengira kejayaan atau kegagalan.
batal: Fungsi panggil balik apabila pengguna mengklik batal Ia hanya digunakan oleh beberapa API apabila pengguna membatalkan operasi.
pencetus: Kaedah yang dicetuskan apabila butang dalam Menu diklik Kaedah ini hanya menyokong antara muka yang berkaitan dalam Menu.

Fungsi di atas semuanya mempunyai parameter jenis objek Selain data yang dikembalikan oleh setiap antara muka itu sendiri, terdapat juga atribut umum errMsg, yang format nilainya adalah seperti berikut:

Apabila panggilan berjaya: "xxx:ok", dengan xxx ialah nama antara muka yang dipanggil
Apabila pengguna membatalkan: "xxx:cancel", dengan xxx ialah nama antara muka yang dipanggil
Apabila panggilan gagal: nilainya ialah mesej ralat khusus

Antara muka asas
Tentukan sama ada versi klien semasa menyokong antara muka JS yang ditentukan

Salin kod Kod adalah seperti berikut:

wx.checkJsApi({
jsApiList: ['chooseImage'] // Senarai antara muka JS yang perlu dikesan Lihat Lampiran 2 untuk senarai semua antara muka JS,
kejayaan: function(res) {
//Kembalian dalam bentuk pasangan nilai kunci, nilai API yang tersedia adalah benar dan nilai API yang tidak tersedia adalah palsu
// Contohnya: {"checkResult":{"chooseImage":true},"errMsg":"checkJsApi:ok"}

});

Perkongsian antara muka

Dapatkan status klik butang "Kongsi ke Detik" dan sesuaikan antara muka kandungan perkongsian

Salin kod Kod adalah seperti berikut:

wx.onMenuShareTimeline({
Tajuk: '', // Kongsi tajuk
Pautan: '', // Kongsi pautan
imgUrl: '', // Kongsi ikon
kejayaan: fungsi () {
//Fungsi panggil balik dilaksanakan selepas pengguna mengesahkan perkongsian
},
batalkan: fungsi () {
//Fungsi panggil balik dilaksanakan selepas pengguna membatalkan perkongsian
}
});

Dapatkan status klik butang "Kongsi kepada Rakan" dan sesuaikan antara muka kandungan perkongsian

Salin kod Kod adalah seperti berikut:

wx.onMenuShareAppMessage({
Tajuk: '', // Kongsi tajuk
desc: '', // Kongsi penerangan
Pautan: '', // Kongsi pautan
imgUrl: '', // Kongsi ikon
Taip: '', // Jenis perkongsian, muzik, video atau pautan, jika dibiarkan kosong, lalainya ialah pautan
dataUrl: '', // Jika jenis ialah muzik atau video, pautan data mesti disediakan, yang kosong secara lalai
kejayaan: fungsi () {
//Fungsi panggil balik dilaksanakan selepas pengguna mengesahkan perkongsian
},
batalkan: fungsi () {
//Fungsi panggil balik dilaksanakan selepas pengguna membatalkan perkongsian
}
});

Dapatkan status klik butang "Kongsi ke QQ" dan sesuaikan antara muka kandungan perkongsian

Salin kod Kod adalah seperti berikut:

wx.onMenuShareQQ({
Tajuk: '', // Kongsi tajuk
desc: '', // Kongsi penerangan
Pautan: '', // Kongsi pautan
imgUrl: '' // Kongsi ikon
kejayaan: fungsi () {
//Fungsi panggil balik dilaksanakan selepas pengguna mengesahkan perkongsian
},
batalkan: fungsi () {
//Fungsi panggil balik dilaksanakan selepas pengguna membatalkan perkongsian
}
});

Dapatkan status klik butang "Kongsi ke Tencent Weibo" dan sesuaikan antara muka kandungan perkongsian

Salin kod Kod adalah seperti berikut:

wx.onMenuShareWeibo({
Tajuk: '', // Kongsi tajuk
desc: '', // Kongsi penerangan
Pautan: '', // Kongsi pautan
imgUrl: '' // Kongsi ikon
kejayaan: fungsi () {
//Fungsi panggil balik dilaksanakan selepas pengguna mengesahkan perkongsian
},
batalkan: fungsi () {
//Fungsi panggil balik dilaksanakan selepas pengguna membatalkan perkongsian
}
});

Antara muka imej

Antara muka untuk mengambil gambar atau memilih gambar daripada album telefon bimbit

Salin kod Kod adalah seperti berikut:

wx.chooseImej({
Kejayaan: fungsi (res) {
            var localIds = res.localIds; // Kembalikan senarai ID setempat foto yang dipilih, localId boleh digunakan sebagai atribut src tag img untuk memaparkan imej
}
});

Pratonton antara muka gambar

Salin kod Kod adalah seperti berikut:

wx.previewImej({
Semasa: '', // pautan imej dipaparkan pada masa ini
url: [] // Senarai pautan imej yang perlu dipratonton
});

Muat naik antara muka gambar

Salin kod Kod adalah seperti berikut:

wx.uploadImej({
localId: '', // ID setempat bagi imej yang akan dimuat naik, diperoleh melalui antara muka chooseImage
isShowProgressTips: 1// Lalai ialah 1, menunjukkan petua kemajuan
Kejayaan: fungsi (res) {
          var serverId = res.serverId; // Kembalikan ID pelayan imej
}
});

Nota: Anda boleh menggunakan antara muka fail multimedia muat turun WeChat untuk memuat turun gambar yang dimuat naik ServerId yang diperolehi di sini ialah media_id Rujuk dokumen../12/58bfcfabbd501c7cd77c19bd9cfa8354.html

.

Muat turun antara muka gambar

Salin kod Kod adalah seperti berikut:

wx.downloadImej({
serverId: '', // ID pelayan imej yang akan dimuat turun, diperoleh melalui antara muka muat naik Imej
isShowProgressTips: 1// Lalai ialah 1, menunjukkan petua kemajuan
Kejayaan: fungsi (res) {
          var localId = res.localId; // Kembalikan ID setempat selepas memuat turun imej
}
});

Antara Muka Audio

Mulakan rakaman antara muka

Salin kod Kod adalah seperti berikut:

wx.startRecord();

Berhenti merakam antara muka

Salin kod Kod adalah seperti berikut:

wx.stopRecord({
Kejayaan: fungsi (res) {
      var localId = res.localId;
}
});

Memantau antara muka berhenti automatik rakaman

Salin kod Kod adalah seperti berikut:

wx.onVoiceRecordEnd({
// Panggilan balik lengkap akan dilaksanakan apabila masa rakaman melebihi satu minit tanpa berhenti
lengkap: fungsi (res) {
var localId = res.localId; }
});

Main antara muka suara

Salin kod Kod adalah seperti berikut:

wx.playVoice({
LocalId: '' // ID setempat bagi audio yang akan dimainkan, diperoleh melalui antara muka stopRecord
});

Jeda antara muka main balik

Salin kod Kod adalah seperti berikut:

wx.pauseVoice({
LocalId: '' // ID setempat bagi audio yang perlu dijeda, diperoleh melalui antara muka stopRecord
});

Hentikan antara muka main balik

Salin kod Kod adalah seperti berikut:

wx.stopVoice({
LocalId: '' // ID setempat bagi audio yang perlu dihentikan, diperoleh melalui antara muka stopRecord
});

Antara muka untuk memantau penyiapan main balik suara

Salin kod Kod adalah seperti berikut:

wx.onVoicePlayEnd({
ServerId: '', // ID pelayan audio yang akan dimuat turun diperolehi melalui antara muka muat naikVoice
Kejayaan: fungsi (res) {
          var localId = res.localId; // Kembalikan ID setempat audio
}
});

Muat naik antara muka suara

Salin kod Kod adalah seperti berikut:

wx.uploadVoice({
localId: '', // ID setempat bagi audio yang akan dimuat naik, diperoleh melalui antara muka stopRecord
isShowProgressTips: 1// Lalai ialah 1, menunjukkan petua kemajuan
Kejayaan: fungsi (res) {
          var serverId = res.serverId; // Kembalikan ID pelayan audio
}
});

Nota: Suara yang dimuat naik boleh dimuat turun melalui antara muka muat turun fail multimedia WeChat ServerId yang diperolehi di sini ialah media_id, rujuk dokumen../12/58bfcfabbd501c7cd77c19bd9cfa8354.html

Muat turun antara muka suara

Salin kod Kod adalah seperti berikut:

wx.downloadVoice({
serverId: '', // ID pelayan audio yang akan dimuat turun, diperoleh melalui antara muka muat naikVoice
isShowProgressTips: 1// Lalai ialah 1, menunjukkan petua kemajuan
Kejayaan: fungsi (res) {
          var localId = res.localId; // Kembalikan ID setempat audio
}
});

Antara Muka Pintar

Kecam audio dan kembalikan antara muka hasil pengecaman

Salin kod Kod adalah seperti berikut:

wx.translateVoice({
localId: '', // ID setempat bagi audio yang perlu dikenali, diperoleh daripada antara muka berkaitan rakaman
isShowProgressTips: 1, //Lalai ialah 1, menunjukkan petua kemajuan
kejayaan: fungsi (res) {
alert(res.translateResult); // Hasil pengecaman pertuturan
}
});

Maklumat Peranti

Dapatkan antara muka status rangkaian

Salin kod Kod adalah seperti berikut:

wx.getNetworkType({
Kejayaan: fungsi (res) {
           var networkType = res.networkType; // Kembalikan jenis rangkaian 2g, 3g, 4g, wifi
}
});

Lokasi geografi

Gunakan peta terbina dalam WeChat untuk melihat antara muka lokasi

Salin kod Kod adalah seperti berikut:

wx.openLocation({
Latitud: 0, // Latitud, nombor titik terapung, julat ialah 90 ~ -90
Longitud: 0, // Longitud, nombor titik terapung, julat ialah 180 ~ -180.
nama: '', // nama lokasi
Alamat: '', // Butiran alamat
Skala: 1, // Aras zum peta, nilai bentuk, antara 1 hingga 28. Lalai ialah maks
infoUrl: '' // Hiperpautan yang dipaparkan di bahagian bawah antara muka lokasi paparan boleh diklik untuk melompat
});

Dapatkan antara muka lokasi geografi

Salin kod Kod adalah seperti berikut:

wx.getLocation({
Cap masa: 0, // Cap masa tandatangan lokasi, hanya disediakan apabila serasi dengan versi sebelum 6.0.2
nonceStr: '', // Letakkan rentetan rawak tandatangan, hanya disediakan apabila serasi dengan versi sebelum 6.0.2
​​adrSign: '', // Tandatangan lokasi, hanya diberikan apabila serasi dengan versi sebelum 6.0.2, lihat Lampiran 4
untuk butiran Kejayaan: fungsi (res) {
           var longitud = res.longitud; // Latitud, nombor titik terapung, julat ialah 90 ~ -90
        var latitud = res.latitude; // Longitud, nombor titik terapung, julat ialah 180 ~ -180.
           var speed = res.speed; // Kelajuan, dalam meter/saat
        var accuracy = res.acuracy; // Ketepatan kedudukan
}
});

Kendalian antara muka

Salin kod Kod adalah seperti berikut:

Sembunyikan antara muka menu di penjuru kanan sebelah atas
wx.hideOptionMenu();
Paparkan antara muka menu di penjuru kanan sebelah atas
wx.showOptionMenu();
Tutup antara muka tetingkap web semasa
wx.closeWindow();
Antara muka butang fungsi tersembunyi kelompok
wx.hideMenuItems({
menuList: [] // Item menu untuk disembunyikan, lihat Lampiran 3 untuk semua item menu
});
Antara muka butang fungsi paparan kelompok
wx.showMenuItems({
menuList: [] // Item menu untuk dipaparkan, lihat Lampiran 3
untuk semua item menu });
Sembunyikan semua antara muka butang bukan asas
wx.hideAllNonBaseMenuItem();
Tunjukkan semua antara muka butang fungsi
wx.showAllNonBaseMenuItem();
Imbas pada WeChat
Buka antara muka pengimbasan WeChat
wx.scanQRCode({
desc: 'scanQRCode desc',
needResult: 0, // Lalai ialah 0, hasil imbasan diproses oleh WeChat, 1 mengembalikan hasil imbasan secara langsung,
scanType: ["qrCode","barCode"], // Anda boleh menentukan sama ada untuk mengimbas kod QR atau kod 1D, kedua-duanya tersedia secara lalai
kejayaan: fungsi () {
var result = res.resultStr; // Apabila needResult ialah 1, hasilnya dikembalikan dengan mengimbas kod QR
}
});

Alamat tuaian

Edit antara muka alamat penghantaran

Salin kod Kod adalah seperti berikut:

wx.editAddress(
Cap masa: 0, // Cap masa tandatangan lokasi, hanya disediakan apabila serasi dengan versi sebelum 6.0.2
nonceStr: '', // Letakkan rentetan rawak tandatangan, hanya disediakan apabila serasi dengan versi sebelum 6.0.2
​​adrSign: '', // Tandatangan lokasi, hanya diberikan apabila serasi dengan versi sebelum 6.0.2, lihat Lampiran 4
untuk butiran Kejayaan: fungsi (res) {
          var userName = res.userName; // Nama penerima
        var telNumber = res.telNumber; // nombor telefon penerima
        var PostalCode = res.postalCode; // Poskod
           var provinceName = res.provinceName; // Alamat peringkat pertama alamat penghantaran standard kebangsaan
           var cityName = res.cityName; // Alamat penghantaran standard kebangsaan alamat peringkat kedua
           var countryName = res.countryName; // Alamat penghantaran standard kebangsaan alamat peringkat ketiga
          var address = res.address; // Maklumat alamat penghantaran terperinci
          var nationalCode = res.nationalCode; // Kod negara alamat penghantaran
}
});

Dapatkan antara muka alamat penghantaran terdekat

Salin kod Kod adalah seperti berikut:

wx.getLatestAddress({
Cap masa: 0, // Cap masa tandatangan lokasi, hanya disediakan apabila serasi dengan versi sebelum 6.0.2
nonceStr: '', // Letakkan rentetan rawak tandatangan, hanya disediakan apabila serasi dengan versi sebelum 6.0.2
​​adrSign: '', // Tandatangan lokasi, hanya diberikan apabila serasi dengan versi sebelum 6.0.2, lihat Lampiran 4
untuk butiran Kejayaan: fungsi (res) {
          var userName = res.userName; // Nama penerima
        var telNumber = res.telNumber; // nombor telefon penerima
        var PostalCode = res.postalCode; // Poskod
          var provinceName = res.provinceName; // Alamat peringkat pertama alamat penghantaran standard kebangsaan
          var cityName = res.cityName; // Alamat penghantaran standard kebangsaan alamat peringkat kedua
           var countryName = res.countryName; // Alamat penghantaran standard kebangsaan alamat peringkat ketiga
          var address = res.address; // Maklumat alamat penghantaran terperinci
          var nationalCode = res.nationalCode; // Kod negara alamat penghantaran
}
});

Kedai WeChat

Lompat ke antara muka halaman produk WeChat

Salin kod Kod adalah seperti berikut:

wx.openProductSpecificView({
productId: '', // id produk
viewType: '' // 0. Nilai lalai, halaman butiran produk biasa 1. Imbas halaman butiran produk 2. Simpan halaman butiran produk
});

Kupon WeChat

Memanggil senarai kad dan kupon yang berkenaan dengan kedai dan mendapatkan senarai pilihan pengguna

Salin kod Kod adalah seperti berikut:

wx.chooseCard({
shopId: '', // StoreId
CardType: '', // Jenis kad
Id Kad: '', // Id kupon kad
cap masa: 0, // Cap masa tandatangan kad
nonceStr: '', // Rentetan rawak tandatangan kad
cardSign: '', //Tandatangan kad dan kupon, lihat Lampiran 6
untuk butiran Kejayaan: fungsi (res) {
          var cardList= res.cardList; // Maklumat senarai kad dipilih oleh pengguna
}
});

Tambahan kelompok antara muka untuk kad dan kupon

Salin kod Kod adalah seperti berikut:

wx.addCard({
Senarai kad: [{
ID kad: '',
cardExt: ''
}], // Senarai kad dan kupon untuk ditambahkan
Kejayaan: fungsi (res) {
        var cardList = res.cardList; //Menambahkan maklumat senarai kad dan kupon
}
});

Lihat antara muka kad dan kupon dalam pakej kad WeChat

Salin kod Kod adalah seperti berikut:

wx.openCard({
Senarai kad: [{
ID kad: '',
kod: ''
}]//Senarai kad dan kupon yang perlu dibuka
});

WeChat Pay

Mulakan permintaan pembayaran WeChat

Salin kod Kod adalah seperti berikut:

wx.chooseWXPay({
cap masa: 0, // Cap masa tandatangan pembayaran
noncestr: '', // Rentetan rawak tandatangan pembayaran
pakej: '', // Rentetan sambungan butiran pesanan, lihat Lampiran 5
untuk butiran paySign: '', // Tandatangan pembayaran, lihat Lampiran 5 untuk butiran
});