Beranda>Terkait pemrograman>Kode Sumber AI
Unduh

mpapi

mpapi (miniProgram API), sebuah plug-in yang kompatibel dengan API program mini, ditulis sekali dan dijalankan di banyak terminal.

⏰ Tanggal pembaruan: 31-05-2019, fungsi program mini terus diperbarui, versi baru mungkin berbeda, harap diperhatikan.

Masalah yang dipecahkan oleh proyek ini : Temukan perbedaan antara API program mini yang berbeda, dan coba gunakan sekumpulan API agar kompatibel dengan beberapa program mini .

Fitur

  • Tulis sekali, jalankan di beberapa terminal, dukung: program mini WeChat, program mini Alipay, program mini pintar Baidu, program mini ByteDance
  • Mendukung Janji (hanya mencakup panggilan balik yang berhasil)
  • Dioptimalkan untuk penggunaan API tertentu, seperti: api.showToast dapat meneruskan string secara langsung, api.setStorageSync tidak perlu memanggil try catch 等
  • Mendukung pemrosesan peristiwa API khusus, seperti: request , downloadFile , detail
  • Mendukung penilaian di berbagai tujuan, api.isWechat , api.isAlipay , api.isSwan , api.isTt

Memasang 

npm install mpapi --save

Metode instalasi non-npm, cukup masukkan mpapi.js di direktori lib langsung ke proyek

menggunakan 

 const api = require ( 'mpapi' )

api . alert ( { ... } ) . then ( ( res ) => { } )
api . confirm ( { ... } ) . then ( ( res ) => { } )
api . getLocation ( ) . then ( ( res ) => { } )
. . .

tampilan cepat

  • Daftar API yang kompatibel
  • API lain yang dikemas sebagai Promise
  • Perbedaan API
  • Petunjuk Penggunaan
  • Pemrosesan peristiwa API khusus, request , downloadFile , uploadFile dll.
  • Dokumentasi API resmi: Program mini WeChat, program mini Alipay, program mini pintar Baidu, program mini ByteDance

Daftar API yang kompatibel

API yang dapat digunakan oleh semua mini program

  • interaksi

    • alert
    • confirm
    • showToast
    • showLoading
    • showActionSheet

  • Bilah navigasi

    • setNavigationBarTitle
    • setNavigationBarColor

  • dokumen

    • saveFile
    • getFileInfo
    • getSavedFileInfo
    • getSavedFileList
    • removeSavedFile

  • gambar

    • chooseImage
    • previewImage
    • compressImage
    • saveImageToPhotosAlbum

  • bertanya

    • request
    • uploadFile
    • downloadFile

  • Tembolok data

    • setStorageSync
    • getStorageSync
    • clearStorageSync
    • getStorageInfoSync
    • removeStorageSync

  • Peralatan sistem

    • getSystemInfoSync
    • setScreenBrightness
    • getScreenBrightness
    • makePhoneCall
    • scanCode
    • setClipboardData
    • getClipboardData

API lain yang dikemas sebagai Promise

Hanya didukung dalam program mini tertentu

apel WeChatwx , applet Alipay-ku , applet pintar Baiduangsa , applet ByteDancett , jika ada icon berarti hanya applet yang sesuai yang didukung, jika tidak ada icon berarti semua didukung.

  • interaksi

    • hideToast
    • hideLoading
    • showModal%= pon %> %= pon %>%= pon %>
    • prompt%= pon %>

  • cache

    • getStorage
    • setStorage
    • removeStorage
    • getStorageInfo

  • rute

    • reLaunch
    • switchTab
    • redirectTo
    • navigateTo
    • navigateBack

  • Lokasi

    • getLocation
    • openLocation
    • chooseLocation%= pon %> %= pon %>%= pon %>

  • Gambar berkas

    • saveImage%= pon %>
    • getImageInfo
    • chooseVideo%= pon %> %= pon %>%= pon %>
    • chooseMessageFile%= pon %>
    • saveVideoToPhotosAlbum%= pon %> %= pon %>%= pon %>
    • openDocument%= pon %> %= pon %>

  • Audio

    • stopVoice%= pon %>
    • playVoice%= pon %>
    • getAvailableAudioSources%= pon %>
    • stopBackgroundAudio%= pon %>
    • playBackgroundAudio%= pon %>
    • seekBackgroundAudio%= pon %>
    • pauseBackgroundAudio%= pon %>
    • getBackgroundAudioPlayerState%= pon %>
    • setInnerAudioOption%= pon %> %= pon %>
    • startRecord%= pon %>
    • stopRecord%= pon %>
    • stopRecord%= pon %>

  • Bilah navigasi

    • getTitleColor%= pon %>
    • setNavigationBar%= pon %>
    • showNavigationBarLoading%= pon %> %= pon %>%= pon %>
    • hideNavigationBarLoading%= pon %> %= pon %>%= pon %>

  • latar belakang

    • setBackgroundTextStyle%= pon %> %= pon %>%= pon %>
    • setBackgroundColor%= pon %> %= pon %>%= pon %>
    • showTabBar%= pon %> %= pon %>%= pon %>
    • hideTabBar%= pon %> %= pon %>%= pon %>
    • setTabBarItem%= pon %> %= pon %>%= pon %>
    • setTabBarStyle%= pon %> %= pon %>%= pon %>
    • showTabBarRedDot%= pon %> %= pon %>%= pon %>
    • hideTabBarRedDot%= pon %> %= pon %>%= pon %>
    • setTabBarBadge%= pon %> %= pon %>%= pon %>
    • removeTabBarBadge%= pon %> %= pon %>%= pon %>

  • Tarik ke bawah untuk menyegarkan

    • startPullDownRefresh
    • stopPullDownRefresh

  • menggulir

    • pageScrollTo
    • sendSocketMessage%= pon %> %= pon %>%= pon %>
    • connectSocket
    • closeSocket%= pon %> %= pon %>%= pon %>
    • startLocalServiceDiscovery%= pon %>
    • stopLocalServiceDiscovery%= pon %>

  • sematkan ke atas

    • setTopBarText%= pon %>

  • kanvas

    • canvasGetImageData%= pon %> %= pon %>%= pon %>
    • canvasPutImageData%= pon %> %= pon %>%= pon %>
    • canvasToTempFilePath%= pon %> %= pon %>%= pon %>

  • Bagikan dan teruskan

    • getShareInfo%= pon %>
    • updateShareMenu%= pon %>
    • showShareMenu%= pon %> %= pon %>
    • hideShareMenu%= pon %> %= pon %>%= pon %>
    • showFavoriteGuide%= pon %>
    • openShare%= pon %>

  • Login, otorisasi, informasi pengguna

    • login%= pon %> %= pon %>%= pon %>
    • checkSession%= pon %> %= pon %>%= pon %>
    • getUserInfo%= pon %> %= pon %>%= pon %>
    • getAuthCode%= pon %>
    • getAuthUserInfo%= pon %>
    • getPhoneNumber%= pon %>
    • authorize%= pon %> %= pon %>

  • membayar

    • tradePay%= pon %>
    • requestPayment%= pon %> %= pon %>
    • requestPolymerPayment%= pon %>

  • antarmuka terbuka

    • getSetting
    • openSetting
    • reportAnalytics
    • chooseInvoiceTitle%= pon %> %= pon %>
    • navigateToMiniProgram%= pon %> %= pon %>
    • navigateBackMiniProgram%= pon %> %= pon %>

  • Buka antarmuka - applet WeChat

    • addCard%= pon %>
    • openCard%= pon %>
    • chooseInvoice%= pon %>
    • startSoterAuthentication%= pon %>
    • checkIsSoterEnrolledInDevice%= pon %>
    • checkIsSupportSoterAuthentication%= pon %>
    • getWeRunData%= pon %>

  • Buka antarmuka - applet Alipay

    • startZMVerify%= pon %>
    • textRiskIdentification%= pon %>
    • addCardAuth%= pon %>
    • getRunScene%= pon %>
    • chooseCity%= pon %>
    • datePicker%= pon %>
    • optionsSelect%= pon %>
    • multiLevelSelect%= pon %>
    • rsa%= pon %>

  • Buka antarmuka - applet pintar Baidu

    • getSwanId%= pon %>
    • navigateToSmartProgram%= pon %>
    • navigateBackSmartProgram%= pon %>
    • setPageInfo%= pon %>
    • setMetaDescription%= pon %>
    • setMetaKeywords%= pon %>
    • setDocumentTitle%= pon %>
    • loadSubPackage%= pon %>

  • Kontak person

    • chooseAddress%= pon %> %= pon %>%= pon %>
    • chooseContact%= pon %>
    • choosePhoneContact%= pon %>
    • chooseAlipayContact%= pon %>
    • addPhoneContact%= pon %> %= pon %>%= pon %>

  • Pemuatan font

    • loadFontFace%= pon %> %= pon %>

  • Informasi sistem

    • getSystemInfo
    • getBatteryInfo%= pon %> %= pon %>%= pon %>
    • getNetworkType
    • setKeepScreenOn%= pon %> %= pon %>%= pon %>
    • startAccelerometer%= pon %> %= pon %>%= pon %>
    • stopAccelerometer%= pon %> %= pon %>%= pon %>
    • startCompass%= pon %> %= pon %>%= pon %>
    • stopCompass%= pon %> %= pon %>%= pon %>
    • startDeviceMotionListening%= pon %> %= pon %>
    • stopDeviceMotionListening%= pon %> %= pon %>
    • startGyroscope%= pon %> %= pon %>
    • stopGyroscope%= pon %> %= pon %>
    • vibrate%= pon %>
    • vibrateShort
    • vibrateLong
    • watchShake%= pon %>
    • setEnableDebug%= pon %> %= pon %>
    • getServerTime%= pon %>
    • scan%= pon %>

  • nirkabel bluetooth

    • getBeacons%= pon %> %= pon %>
    • startBeaconDiscovery%= pon %> %= pon %>
    • stopBeaconDiscovery%= pon %> %= pon %>
    • startWifi%= pon %>
    • stopWifi%= pon %>
    • setWifiList%= pon %>
    • getWifiList%= pon %>
    • connectWifi%= pon %>
    • getConnectedWifi%= pon %>
    • getBLEDeviceServices%= pon %> %= pon %>
    • getBLEDeviceCharacteristics%= pon %> %= pon %>
    • createBLEConnection%= pon %> %= pon %>
    • closeBLEConnection%= pon %> %= pon %>
    • writeBLECharacteristicValue%= pon %> %= pon %>
    • readBLECharacteristicValue%= pon %> %= pon %>
    • notifyBLECharacteristicValueChange%= pon %> %= pon %>
    • startBluetoothDevicesDiscovery%= pon %> %= pon %>
    • stopBluetoothDevicesDiscovery%= pon %> %= pon %>
    • openBluetoothAdapter%= pon %> %= pon %>
    • getConnectedBluetoothDevices%= pon %> %= pon %>
    • getBluetoothDevices%= pon %> %= pon %>
    • getBluetoothAdapterState%= pon %> %= pon %>
    • closeBluetoothAdapter%= pon %> %= pon %>
    • stopHCE%= pon %>
    • startHCE%= pon %>
    • getHCEState%= pon %>
    • sendHCEMessage%= pon %>

  • Platform pihak ketiga

    • getExtConfig%= pon %> %= pon %>

  • API tingkat dalam, catatan: metode diawali dengan $

    • api.ap-ku
      • api.ap.$faceVerify
      • api.ap.$navigateToAlipayPage
      • ...
    • api.aiangsa
      • api.ai.$ocrIdCard
      • api.ai.$ocrBankCard
      • ...

  • Beberapa contoh baru dari objek di atas API

    • createMapContext%= pon %> %= pon %>%= pon %>
    • createVideoContext%= pon %> %= pon %>
    • createAudioContext%= pon %>
    • createCameraContext%= pon %> %= pon %>
    • createInnerAudioContext%= pon %> %= pon %>%= pon %>
    • createLivePusherContext%= pon %>
    • createLivePlayerContext%= pon %>
    • getBackgroundAudioManager%= pon %> %= pon %>
    • getRecorderManager%= pon %> %= pon %>%= pon %>
    • createSelectorQuery
    • getFileSystemManager%= pon %>
    • createARCameraContext%= pon %>

Misalnya: Catatan: Metode ini diawali dengan $ 

 let ctx = api . createMapContext ( 'maper' )

ctx . $getCenterLocation ( ) . then ( ( res ) => {
  console . log ( 'createMapContext:getCenterLocation' )
  console . log ( res )
} )

Perbedaan API antar applet

1. Transmisi parameter tidak konsisten

Misalnya: metode showLoading , salinan tampilan yang dimuat, parameter title di WeChat dan Baidu, dan parameter content di Alipay, sebagai berikut 

 // 微信
wx . showLoading ( {
  title : '加载中'
} )

// 百度
swan . showLoading ( {
  title : '加载中'
} )

// 支付宝
my . showLoading ( {
  content : '加载中'
} )

// 使用 mpapi 之后，多端兼容
api . showLoading ( '加载中' )
api . showLoading ( {
  title : '提示内容'
} )

2. Parameter pengembalian tidak konsisten

Misalnya: metode showActionSheet , setelah eksekusi, dapatkan indeks yang dipilih. Di WeChat dan Baidu, itu adalah res.tapIndex , di Alipay, itu adalah res.index , sebagai berikut 

 // 微信
wx . showActionSheet ( {
  itemList : [ '台球' , '羽毛球' , '篮球' ] ,
  success : ( res ) => {
    // res.tapIndex
  }
} )

// 支付宝
my . showActionSheet ( {
  items : [ '台球' , '羽毛球' , '篮球' ] ,
  success : ( res ) => {
    // res.index
  }
} )

// 使用 mpapi，多端兼容
api . showActionSheet ( {
  itemList : [ '台球' , '羽毛球' , '篮球' ] ,
  success : ( res ) => {
    // res.tapIndex
  }
} )

3. Tidak didukung, tapi kompatibel

Misalnya: Alipay memiliki my.alert , tetapi WeChat dan Baidu tidak memiliki metode ini. Namun, Anda dapat merangkum metode alert melalui wx.showModal milik WeChat atau swan.showModal milik Baidu, sebagai berikut 

 api . alert ( '提示内容' )

api . alert ( {
  content : '提示内容'
} )

// 请求数据，兼容多端
api . request ( { ... } ) . then ( ( res ) => { } )

4. Tidak didukung dan tidak kompatibel

Beberapa API hanya valid di terminal tertentu dan tidak dapat diproses secara kompatibilitas, sebagai berikut: 

 // 只在支付宝里面有效，微信和百度小程序里面会报错
api . startZMVerify ( { ... } )

// 建议这样处理
if ( api . isAlipay ) {
  api . startZMVerify ( { ... } )
}

// 只在微信里面有效，支付宝或百度小程序里面会报错
api . setTopBarText ( { ... } )

// 建议这样处理
if ( api . isWechat ) {
  api . setTopBarText ( { ... } )
}

// 百度智能小程序的特殊 API 一样的道理
if ( api . isSwan ) {
  api . getSwanId ( ) . then ( ( res ) => { } )
}

Petunjuk Penggunaan

1. Mendukung gaya Promise

Semua API program mini, asalkan menyertakan callback success , telah dienkapsulasi dengan Promise dan dapat digunakan secara langsung, misalnya, kedua metode penulisan 

 // 使用回调
api . showActionSheet ( {
  itemList : [ '台球' , '羽毛球' , '篮球' ] ,
  success : ( res ) => {
    // res.tapIndex
  }
} )

// 或者
api . showActionSheet ( {
  itemList : [ '台球' , '羽毛球' , '篮球' ]
} ) . then ( ( res ) => {
    // res.tapIndex
} )

// 其它
api . setStorage ( { ... } ) . then ( ( res ) => { } )
api . chooseImage ( { ... } ) . then ( ( res ) => { } )
. . .

2. Parameter yang diteruskan dan dikembalikan dalam metode yang kompatibel tunduk pada panggilan applet WeChat . Parameter yang tidak kompatibel dengan terminal lain tidak diproses (beberapa parameter tidak dapat diproses dan tidak didukung oleh program mini tertentu yang perlu diperhatikan oleh Pengembang). 

 api . chooseImage ( {
  count : 1 ,
  sizeType : [ 'original' , 'compressed' ] , // 只在微信可用
  sourceType : [ 'album' , 'camera' ] ,
} ) . then ( ( res ) => {
  // res.tempFilePaths 在微信和支付宝都可用
  // res.tempFiles 只在微信可用
} )

Penanganan acara untuk API khusus

Beberapa API perlu mendukung Promise dan memanggil kejadiannya, sehingga metode berikut dapat digunakan:

sebelum: 

 const downloadTask = wx . downloadFile ( {
  url : 'https://example.com/audio/123' , // 仅为示例，并非真实的资源
  success ( res ) {
    console . log ( res )
  }
} )

downloadTask . onProgressUpdate ( ( res ) => {
  console . log ( res )
} )

downloadTask . abort ( ) // 取消下载任务

Setelah menggunakan mpapi : 

 const api = require ( 'mpapi' )

const downloadTask = api . downloadFile ( {
  url : 'https://example.com/audio/123' // 仅为示例，并非真实的资源
} ) . then ( ( res ) => {
  console . log ( 'success' )
  console . log ( res )
} )

downloadTask . $event ( 'onProgressUpdate' , ( res ) => {
  console . log ( res )
} )

// downloadTask.$event('abort') // 取消下载任务

API lain dapat ditangani dengan cara yang sama, seperti: request , uploadFile , connectSocket

Masalah

Jika Anda menemukan bug saat digunakan atau memiliki saran bagus, silakan laporkan.

log perubahan

Ubah catatan

Lisensi

Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua