Page d'accueil>Lié à la programmation>Code Source AI
Télécharger

mpapi

mpapi (miniProgram API), un plug-in compatible avec l'API de mini-programme, écrit une seule fois et exécuté sur plusieurs terminaux.

⏰ Date de mise à jour : 31/05/2019, les fonctions du mini-programme sont constamment mises à jour, la nouvelle version peut être différente, veuillez faire attention.

Le problème que ce projet résout : trouvez les différences entre les différentes API de mini-programmes et essayez d'utiliser un ensemble d'API pour être compatible avec plusieurs mini-programmes .

Caractéristiques

  • Écrivez une fois, exécutez sur plusieurs terminaux, prise en charge : mini-programme WeChat, mini-programme Alipay, mini-programme intelligent Baidu, mini-programme ByteDance
  • Prend en charge la promesse (inclut uniquement le rappel de réussite)
  • Optimisé pour certaines utilisations de l'API, telles que : api.showToast peut transmettre string directement, api.setStorageSync n'a pas besoin d'appeler try catch 等
  • Prise en charge du traitement des événements d'API spéciales, telles que : request , downloadFile , détails
  • Prend en charge le jugement à différentes extrémités, api.isWechat , api.isAlipay , api.isSwan , api.isTt

Installer 

npm install mpapi --save

Méthode d'installation non npm, introduisez simplement mpapi.js dans le répertoire lib directement dans le projet

utiliser 

 const api = require ( 'mpapi' )

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

vue rapide

  • Liste des API compatibles
  • Autres API regroupées sous Promise
  • Différences API
  • Mode d'emploi
  • Traitement des événements API spéciaux, request , downloadFile , uploadFile etc.
  • Documentation officielle de l'API : mini-programme WeChat, mini-programme Alipay, mini-programme intelligent Baidu, mini-programme ByteDance

Liste des API compatibles

API pouvant être utilisée par tous les mini-programmes

  • interaction

    • alert
    • confirm
    • showToast
    • showLoading
    • showActionSheet

  • Barre de navigation

    • setNavigationBarTitle
    • setNavigationBarColor

  • document

    • saveFile
    • getFileInfo
    • getSavedFileInfo
    • getSavedFileList
    • removeSavedFile

  • image

    • chooseImage
    • previewImage
    • compressImage
    • saveImageToPhotosAlbum

  • demander

    • request
    • uploadFile
    • downloadFile

  • Cache de données

    • setStorageSync
    • getStorageSync
    • clearStorageSync
    • getStorageInfoSync
    • removeStorageSync

  • Équipement système

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

Autres API regroupées sous Promise

Uniquement pris en charge dans le cadre de mini-programmes spécifiques

Applet WeChatwx , Applet Alipaymon , Applet intelligent Baiducygne , Applet ByteDancett , s'il y a une icône, cela signifie que seule l'applet correspondante est prise en charge, s'il n'y a pas d'icône, cela signifie que toutes sont prises en charge.

  • interaction

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

  • cache

    • getStorage
    • setStorage
    • removeStorage
    • getStorageInfo

  • routage

    • reLaunch
    • switchTab
    • redirectTo
    • navigateTo
    • navigateBack

  • Emplacement

    • getLocation
    • openLocation
    • chooseLocation%= lbl %> %= lbl %>%= lbl %>

  • Image du fichier

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

  • Audio

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

  • Barre de navigation

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

  • arrière-plan

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

  • Déroulez pour actualiser

    • startPullDownRefresh
    • stopPullDownRefresh

  • rouleau

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

  • épingler en haut

    • setTopBarText%= lbl %>

  • toile

    • canvasGetImageData%= lbl %> %= lbl %>%= lbl %>
    • canvasPutImageData%= lbl %> %= lbl %>%= lbl %>
    • canvasToTempFilePath%= lbl %> %= lbl %>%= lbl %>

  • Partager et transférer

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

  • Connexion, autorisation, informations utilisateur

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

  • payer

    • tradePay%= lbl %>
    • requestPayment%= lbl %> %= lbl %>
    • requestPolymerPayment%= lbl %>

  • interface ouverte

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

  • Interface ouverte - Applet WeChat

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

  • Interface ouverte - Applet Alipay

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

  • Interface ouverte - Applet intelligent Baidu

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

  • Personne de contact

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

  • Chargement des polices

    • loadFontFace%= lbl %> %= lbl %>

  • Informations système

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

  • Bluetooth sans fil

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

  • Plateforme tierce

    • getExtConfig%= lbl %> %= lbl %>

  • API de niveau approfondi, remarque : les méthodes sont préfixées par $

    • api.apmon
      • api.ap.$faceVerify
      • api.ap.$navigateToAlipayPage
      • ...
    • api.aicygne
      • api.ai.$ocrIdCard
      • api.ai.$ocrBankCard
      • ...

  • Une nouvelle instance de l'objet au-dessus de l'API

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

Par exemple : Remarque : La méthode est préfixée par $ 

 let ctx = api . createMapContext ( 'maper' )

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

Différences API entre les applets

1. Transmission de paramètres incohérente

Par exemple : la méthode showLoading , la copie d'affichage chargée, title dans WeChat et Baidu et le paramètre content dans Alipay, comme suit 

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

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

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

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

2. Les paramètres de retour sont incohérents

Par exemple : méthode showActionSheet , après exécution, obtenez l'index sélectionné Dans WeChat et Baidu, c'est res.tapIndex , dans Alipay, c'est res.index , comme suit. 

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

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

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

3. Non pris en charge, mais compatible

Par exemple : Alipay a my.alert , mais WeChat et Baidu n'ont pas cette méthode. Cependant, vous pouvez encapsuler une méthode alert via wx.showModal de WeChat ou swan.showModal de Baidu, comme suit. 

 api . alert ( '提示内容' )

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

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

4. Non pris en charge et incompatible

Certaines API ne sont valables que dans des terminaux spécifiques et ne peuvent pas être traitées en compatibilité, comme suit : 

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

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

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

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

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

Mode d'emploi

1. Style Promise de soutien

Toutes les API des mini-programmes, à condition qu'elles incluent des rappels success , ont été encapsulées avec Promise et peuvent être utilisées directement. Les deux méthodes d'écriture sont prises en charge, par exemple. 

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

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

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

2. Les paramètres transmis et renvoyés dans la méthode compatible sont soumis à l'appel de l'applet WeChat . Les paramètres incompatibles avec d'autres terminaux ne sont pas traités (certains paramètres ne peuvent pas être traités et ne sont pas pris en charge par des mini-programmes spécifiques, comme par exemple). 

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

Gestion des événements pour les API spéciales

Certaines API doivent prendre en charge Promise et appeler ses événements. Les méthodes suivantes peuvent donc être utilisées :

avant: 

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

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

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

Après avoir utilisé 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') // 取消下载任务

D'autres API peuvent être gérées de la même manière, telles que : request , uploadFile , connectSocket

Problèmes

Si vous trouvez des bugs lors de l'utilisation ou avez de bonnes suggestions, n'hésitez pas à les signaler.

Journal des modifications

Journal des modifications

Licence

Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout