Página Inicial>Relacionado com a programação>Código-Fonte de IA
Baixar

mpapi

mpapi (miniProgram API), um plug-in compatível com API de miniprograma, escrito uma vez e executado em vários terminais.

⏰ Data de atualização: 31/05/2019, as funções do mini programa estão em constante atualização, a nova versão pode ser diferente, preste atenção.

O problema que este projeto resolve : Encontre as diferenças entre as diferentes APIs de miniprogramas e tente usar um conjunto de APIs para ser compatível com vários miniprogramas .

Características

  • Escreva uma vez, execute em vários terminais, suporte: miniprograma WeChat, miniprograma Alipay, miniprograma inteligente Baidu, miniprograma ByteDance
  • Suporta Promise (inclui apenas retorno de chamada de sucesso)
  • Otimizado para determinados usos de API, como: api.showToast pode passar string diretamente, api.setStorageSync não precisa chamar try catch 等
  • Suporta processamento de eventos de APIs especiais, como: request , downloadFile , details
  • Suporta julgamento em diferentes fins, api.isWechat , api.isAlipay , api.isSwan , api.isTt

Instalar 

npm install mpapi --save

Método de instalação não-npm, basta introduzir mpapi.js no diretório lib diretamente no projeto

usar 

 const api = require ( 'mpapi' )

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

visualização rápida

  • Lista de APIs compatíveis
  • Outras APIs empacotadas como Promise
  • Diferenças de API
  • Instruções de uso
  • Processamento especial de eventos de API, request , downloadFile , uploadFile etc.
  • Documentação oficial da API: miniprograma WeChat, miniprograma Alipay, miniprograma inteligente Baidu, miniprograma ByteDance

Lista de APIs compatíveis

API que pode ser usada por todos os miniprogramas

  • interação

    • alert
    • confirm
    • showToast
    • showLoading
    • showActionSheet

  • Barra de navegação

    • setNavigationBarTitle
    • setNavigationBarColor

  • documento

    • saveFile
    • getFileInfo
    • getSavedFileInfo
    • getSavedFileList
    • removeSavedFile

  • foto

    • chooseImage
    • previewImage
    • compressImage
    • saveImageToPhotosAlbum

  • perguntar

    • request
    • uploadFile
    • downloadFile

  • Cache de dados

    • setStorageSync
    • getStorageSync
    • clearStorageSync
    • getStorageInfoSync
    • removeStorageSync

  • Equipamento do sistema

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

Outras APIs empacotadas como Promise

Suportado apenas em miniprogramas específicos

Miniaplicativo WeChatwx , miniaplicativo Alipaymeu , Miniaplicativo inteligente Baiducisne , miniaplicativo ByteDancett , se houver um ícone, significa que apenas o miniaplicativo correspondente é suportado; se não houver nenhum ícone, significa que todos são suportados.

  • interação

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

  • esconderijo

    • getStorage
    • setStorage
    • removeStorage
    • getStorageInfo

  • roteamento

    • reLaunch
    • switchTab
    • redirectTo
    • navigateTo
    • navigateBack

  • Localização

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

  • Imagem do arquivo

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

  • Áudio

    • 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 %>

  • Barra de navegação

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

  • fundo

    • 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 %>

  • Puxe para baixo para atualizar

    • startPullDownRefresh
    • stopPullDownRefresh

  • rolar

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

  • fixar no topo

    • setTopBarText%= lbl %>

  • tela

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

  • Compartilhe e encaminhe

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

  • Login, autorização, informações do usuário

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

  • pagar

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

  • interface aberta

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

  • Interface aberta - miniaplicativo WeChat

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

  • Interface aberta - miniaplicativo Alipay

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

  • Interface aberta - miniaplicativo inteligente Baidu

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

  • Pessoa de contato

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

  • Carregamento de fonte

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

  • Informações do sistema

    • 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 sem fio

    • 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 %>

  • Plataforma de terceiros

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

  • API de nível profundo, observação: os métodos são prefixados com $

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

  • Alguma nova instância do objeto acima da 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 %>

Por exemplo: Nota: O método é prefixado com $ 

 let ctx = api . createMapContext ( 'maper' )

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

Diferenças de API entre miniaplicativos

1. Transmissão de parâmetros inconsistente

Por exemplo: método showLoading , cópia de exibição carregada, parâmetro title no WeChat e Baidu e parâmetro content no Alipay, como segue 

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

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

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

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

2. Os parâmetros de retorno são inconsistentes

Por exemplo: método showActionSheet , após a execução, obtenha o índice selecionado No WeChat e Baidu, é res.tapIndex , no Alipay, é res.index , como segue. 

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

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

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

3. Não suportado, mas compatível

Por exemplo: Alipay tem my.alert , mas WeChat e Baidu não têm esse método. No entanto, você pode encapsular um método alert por meio de wx.showModal do WeChat ou swan.showModal do Baidu, como segue. 

 api . alert ( '提示内容' )

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

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

4. Não suportado e incompatível

Algumas APIs são válidas apenas em terminais específicos e não podem ser processadas em compatibilidade, como segue: 

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

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

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

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

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

Instruções de uso

1. Estilo Promise de suporte

Todas as APIs de miniprogramas, desde que incluam retornos de chamada success , foram encapsuladas com Promise e podem ser usadas diretamente. Ambos os métodos de escrita são suportados, por exemplo. 

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

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

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

2. Os parâmetros passados ​​​​e retornados no método compatível estão sujeitos à chamada do miniaplicativo WeChat . Os parâmetros incompatíveis com outros terminais não são processados ​​(alguns parâmetros não podem ser processados ​​e não são suportados por miniprogramas específicos. Os desenvolvedores precisam prestar atenção, como). 

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

Tratamento de eventos para APIs especiais

Algumas APIs precisam dar suporte ao Promise e chamar seus eventos, portanto os seguintes métodos podem ser usados:

antes: 

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

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

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

Depois 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') // 取消下载任务

Outras APIs podem ser tratadas de forma semelhante, como: request , uploadFile , connectSocket

Problemas

Se você encontrar bugs durante o uso ou tiver boas sugestões, sinta-se à vontade para reportá-los.

Registro de alterações

Registro de alterações

Licença

Expandir
Informações adicionais
Aplicativos Relacionados
Recomendado para você
Informações Relacionadas Todos