Inicio>Relacionado con la programación>Código Fuente de IA
Descargar

mapi

mpapi (miniProgram API), un complemento compatible con miniprograma API, escrito una vez y ejecutado en múltiples terminales.

⏰ Fecha de actualización: 2019-05-31, las funciones del mini programa se actualizan constantemente, la nueva versión puede ser diferente, preste atención.

El problema que resuelve este proyecto : encuentre las diferencias entre diferentes mini API de programas e intente utilizar un conjunto de API para que sean compatibles con múltiples mini programas .

Características

  • Escriba una vez, ejecútelo en múltiples terminales, admita: miniprograma WeChat, miniprograma Alipay, miniprograma inteligente Baidu, miniprograma ByteDance
  • Admite promesa (solo incluye devolución de llamada exitosa)
  • Optimizado para cierto uso de API, como: api.showToast puede pasar string directamente, api.setStorageSync no necesita llamar try catch 等
  • Admite el procesamiento de eventos de API especiales, como: request , downloadFile , detalles
  • Admite juicio en diferentes extremos, api.isWechat , api.isAlipay , api.isSwan , api.isTt

Instalar 

npm install mpapi --save

Método de instalación que no es npm, simplemente introduzca mpapi.js en el directorio lib directamente en el proyecto

usar 

 const api = require ( 'mpapi' )

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

vista rápida

  • Lista de API compatibles
  • Otras API empaquetadas como Promise
  • Diferencias API
  • Instrucciones de uso
  • Procesamiento de eventos API especiales, request , downloadFile , uploadFile etc.
  • Documentación oficial de API: miniprograma WeChat, miniprograma Alipay, miniprograma inteligente Baidu, miniprograma ByteDance

Lista de API compatibles

API que puede ser utilizada por todos los mini programas.

  • interacción

    • alert
    • confirm
    • showToast
    • showLoading
    • showActionSheet

  • barra de navegación

    • setNavigationBarTitle
    • setNavigationBarColor

  • documento

    • saveFile
    • getFileInfo
    • getSavedFileInfo
    • getSavedFileList
    • removeSavedFile

  • imagen

    • chooseImage
    • previewImage
    • compressImage
    • saveImageToPhotosAlbum

  • preguntar

    • request
    • uploadFile
    • downloadFile

  • caché de datos

    • setStorageSync
    • getStorageSync
    • clearStorageSync
    • getStorageInfoSync
    • removeStorageSync

  • Equipo del sistema

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

Otras API empaquetadas como Promise

Solo es compatible con miniprogramas específicos

subprograma WeChatwx , subprograma Alipaymi , subprograma inteligente de Baiducisne , subprograma ByteDancett , si hay un ícono, significa que solo se admite el subprograma correspondiente, si no hay ningún ícono, significa que todos son compatibles.

  • interacción

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

  • cache

    • getStorage
    • setStorage
    • removeStorage
    • getStorageInfo

  • enrutamiento

    • reLaunch
    • switchTab
    • redirectTo
    • navigateTo
    • navigateBack

  • Ubicación

    • getLocation
    • openLocation
    • chooseLocation%= libras %>%= libras %>%= libras %>

  • Imagen de archivo

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

  • Audio

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

  • barra de navegación

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

  • fondo

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

  • Tira hacia abajo para actualizar

    • startPullDownRefresh
    • stopPullDownRefresh

  • voluta

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

  • fijar hacia arriba

    • setTopBarText%= libras %>

  • lienzo

    • canvasGetImageData%= libras %>%= libras %>%= libras %>
    • canvasPutImageData%= libras %>%= libras %>%= libras %>
    • canvasToTempFilePath%= libras %>%= libras %>%= libras %>

  • Compartir y reenviar

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

  • Inicio de sesión, autorización, información de usuario.

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

  • pagar

    • tradePay%= libras %>
    • requestPayment%= libras %>%= libras %>
    • requestPolymerPayment%= libras %>

  • interfaz abierta

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

  • Interfaz abierta: subprograma WeChat

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

  • Interfaz abierta: subprograma Alipay

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

  • Interfaz abierta: subprograma inteligente de Baidu

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

  • Persona de contacto

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

  • Carga de fuentes

    • loadFontFace%= libras %>%= libras %>

  • Información del sistema

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

  • bluetooth inalámbrico

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

  • Plataforma de terceros

    • getExtConfig%= libras %>%= libras %>

  • API de nivel profundo, nota: los métodos tienen el prefijo $

    • api.apmi
      • api.ap.$faceVerify
      • api.ap.$navigateToAlipayPage
      • ...
    • api.aicisne
      • api.ai.$ocrIdCard
      • api.ai.$ocrBankCard
      • ...

  • Alguna nueva instancia del objeto encima de la API.

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

Por ejemplo: Nota: El método tiene el prefijo $ 

 let ctx = api . createMapContext ( 'maper' )

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

Diferencias API entre subprogramas

1. Transmisión de parámetros inconsistente

Por ejemplo: método showLoading , copia de visualización cargada, parámetro title en WeChat y Baidu y parámetro content en Alipay, de la siguiente manera 

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

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

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

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

2. Los parámetros de retorno son inconsistentes

Por ejemplo: método showActionSheet , después de la ejecución, obtiene el índice seleccionado. En WeChat y Baidu, es res.tapIndex , en Alipay, es res.index , de la siguiente manera. 

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

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

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

3. No compatible, pero compatible

Por ejemplo: Alipay tiene my.alert , pero WeChat y Baidu no tienen este método. Sin embargo, puede encapsular un método alert a través de wx.showModal de WeChat o swan.showModal de Baidu, de la siguiente manera. 

 api . alert ( '提示内容' )

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

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

4. No compatible e incompatible

Algunas API solo son válidas en terminales específicos y no se pueden procesar en compatibilidad, de la siguiente manera: 

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

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

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

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

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

Instrucciones de uso

1. Estilo Promise de soporte

Todas las API de mini programas, siempre que incluyan devoluciones de llamadas success , se han encapsulado con Promise y se pueden usar directamente. Se admiten ambos métodos de escritura, por ejemplo. 

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

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

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

2. Los parámetros pasados ​​​​y devueltos en el método compatible están sujetos a la llamada del subprograma WeChat . Los parámetros que son incompatibles con otros terminales no se procesan (algunos parámetros no se pueden procesar y no son compatibles con miniprogramas específicos. Los desarrolladores deben prestar atención, como por ejemplo). 

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

Manejo de eventos para API especiales

Algunas API necesitan admitir Promise y llamar a sus eventos, por lo que se pueden utilizar los siguientes métodos:

antes: 

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

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

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

Después de usar 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') // 取消下载任务

Otras API se pueden manejar de manera similar, como: request , uploadFile , connectSocket

Asuntos

Si encuentra errores durante el uso o tiene buenas sugerencias, no dude en informarlos.

Registro de cambios

Registro de cambios

Licencia

Expandir
Información adicional
Aplicaciones relacionadas
Recomendado para ti
Información relacionada Todo