ホーム>プログラミング関連>AI ソースコード
ダウンロード

ムパピ

mpapi (miniProgram API) は、一度記述すれば複数の端末で実行できるミニプログラム API 互換プラグインです。

⏰ 更新日：2019-05-31、ミニプログラム機能は常に更新されており、新しいバージョンは異なる場合がありますので、ご注意ください。

このプロジェクトが解決する問題: さまざまなミニ プログラム API 間の違いを見つけ、複数のミニ プログラムと互換性のある API セットを使用してみます。

特徴

  • 一度書いて、複数の端末で実行、サポート: WeChat ミニ プログラム、Alipay ミニ プログラム、Baidu スマート ミニ プログラム、ByteDance ミニ プログラム
  • Promise をサポート (成功コールバックのみを含む)
  • 特定の API の使用法に合わせて最適化されています。たとえば、 api.showToast stringを直接渡すことができ、 api.setStorageSync try catch 等
  • request 、 downloadFile 、details などの特別な API のイベント処理をサポートします。
  • 異なるエンドでの判断をサポート、 api.isWechat 、 api.isAlipay 、 api.isSwan 、 api.isTt

インストール

npm install mpapi --save

npm 以外のインストール方法。lib libにあるmpapi.jsプロジェクトに直接導入するだけです。

使用

 const api = require ( 'mpapi' )

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

クイックビュー

  • 対応API一覧
  • Promise としてパッケージ化されたその他の API
  • APIの違い
  • 使用説明書
  • 特別な API イベント処理、 request 、 downloadFile 、 uploadFileなど。
  • 公式 API ドキュメント: WeChat ミニ プログラム、Alipay ミニ プログラム、Baidu スマート ミニ プログラム、ByteDance ミニ プログラム

対応API一覧

すべてのミニプログラムで使用できるAPI

  • 交流

    • alert
    • confirm
    • showToast
    • showLoading
    • showActionSheet

  • ナビゲーションバー

    • setNavigationBarTitle
    • setNavigationBarColor

  • 書類

    • saveFile
    • getFileInfo
    • getSavedFileInfo
    • getSavedFileList
    • removeSavedFile

  • 写真

    • chooseImage
    • previewImage
    • compressImage
    • saveImageToPhotosAlbum

  • 聞く

    • request
    • uploadFile
    • downloadFile

  • データキャッシュ

    • setStorageSync
    • getStorageSync
    • clearStorageSync
    • getStorageInfoSync
    • removeStorageSync

  • システム機器

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

Promise としてパッケージ化されたその他の API

特定のミニ プログラムでのみサポートされます

WeChat アプレットwx、Alipay アプレット私の、Baidu スマート アプレット白鳥、ByteDance アプレットって, アイコンがある場合は、対応するアプレットのみがサポートされていることを意味し、アイコンがない場合はすべてがサポートされていることを意味します。

  • 交流

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

  • キャッシュ

    • getStorage
    • setStorage
    • removeStorage
    • getStorageInfo

  • ルーティング

    • reLaunch
    • switchTab
    • redirectTo
    • navigateTo
    • navigateBack

  • 位置

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

  • ファイル画像

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

  • オーディオ

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

  • ナビゲーションバー

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

  • 背景

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

  • プルダウンして更新します

    • startPullDownRefresh
    • stopPullDownRefresh

  • スクロール

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

  • 上にピン留めする

    • setTopBarText%= lbl %>

  • キャンバス

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

  • 共有して転送する

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

  • ログイン、認証、ユーザー情報

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

  • 支払う

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

  • オープンインターフェース

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

  • オープンインターフェース - WeChat アプレット

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

  • オープンインターフェース - Alipay アプレット

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

  • オープンインターフェース - Baidu スマートアプレット

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

  • 連絡担当者

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

  • フォントの読み込み

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

  • システム情報

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

  • ブルートゥースワイヤレス

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

  • サードパーティのプラットフォーム

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

  • ディープレベル API、注意: メソッドには接頭辞$が付きます

    • api.ap私の
      • api.ap.$faceVerify
      • api.ap.$navigateToAlipayPage
      • ...
    • api.ai白鳥
      • api.ai.$ocrIdCard
      • api.ai.$ocrBankCard
      • ...

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

例:注: メソッドには$接頭辞が付きます。 

 let ctx = api . createMapContext ( 'maper' )

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

アプレット間の API の違い

1. 一貫性のないパラメータ送信

例: showLoadingメソッド、ロードされた表示コピー、WeChat と Baidu のtitleパラメータ、Alipay のcontentパラメータは次のようになります。 

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

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

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

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

2. 戻りパラメータが矛盾している

例: showActionSheetメソッドの実行後、次のように、WeChat と Baidu ではres.tapIndex 、Alipay ではres.index取得します。 

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

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

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

3. サポートされていませんが、互換性があります

例: Alipay にはmy.alertがありますが、WeChat と Baidu にはこのメソッドがありません。ただし、次のように、WeChat のwx.showModalまたは Baidu のswan.showModalを通じてalertメソッドをカプセル化できます。 

 api . alert ( '提示内容' )

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

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

4. サポートされておらず、互換性がありません

以下に示すように、一部の API は特定の端末でのみ有効であり、互換性で処理できません。 

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

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

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

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

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

使用説明書

1. Promiseスタイルをサポート

すべてのミニ プログラム API は、 successコールバックが含まれている限り、 Promiseでカプセル化されており、たとえば、両方の記述方法がサポートされています。 

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

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

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

2. 互換性のあるメソッドで渡され返されるパラメータは、WeChat アプレット呼び出しの対象となります。他の端末と互換性のないパラメータは処理されません（一部のパラメータは処理できず、特定のミニプログラムでサポートされていないため、開発者は注意が必要です）。 

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

特別な API のイベント処理

一部の API は Promise をサポートし、そのイベントを呼び出す必要があるため、次のメソッドを使用できます。

前に： 

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

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

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

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

request 、 uploadFile 、 connectSocketなどの他の API も同様に処理できます。

問題

使用中にバグを発見した場合、または良い提案がある場合は、お気軽に報告してください。

変更履歴

変更ログ

ライセンス

拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて