微信小程序与支付宝小程序的api异同

916 阅读51分钟

canIUse

接口描述:判断小程序的 API,回调,参数,组件等是否在当前版本可用

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getSystemInfoSync

接口描述:获取系统信息同步版本

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 返回值属性值缺失

  • 返回值差异:
参数差异描述
safeArea安全区位置信息
SDKVersion客户端基础库版本
benchmarkLevel仅 Android 小游戏 设备性能等级取值为:-2 或 0
albumAuthorized允许微信使用相册的开关 仅 iOS 有效
cameraAuthorized允许微信使用摄像头的开关
locationAuthorized允许微信使用定位的开关
microphoneAuthorized允许微信使用麦克风的开关
notificationAuthorized允许微信通知的开关
notificationAlertAuthorized允许微信通知带有提醒的开关 仅 iOS 有效
notificationBadgeAuthorized允许微信通知带有标记的开关 仅 iOS 有效
notificationSoundAuthorized允许微信通知带有声音的开关 仅 iOS 有效
bluetoothEnabled蓝牙的系统开关
locationEnabled地理位置的系统开关
wifiEnabledWi-Fi 的系统开关

getSystemInfo

接口描述:获取系统信息

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 返回值属性值缺失

  • 返回值差异:
参数差异描述
SDKVersion客户端基础库版本
benchmarkLevel仅 Android 小游戏 设备性能等级取值为:-2 或 0
albumAuthorized允许微信使用相册的开关 仅 iOS 有效
cameraAuthorized允许微信使用摄像头的开关
locationAuthorized允许微信使用定位的开关
microphoneAuthorized允许微信使用麦克风的开关
notificationAuthorized允许微信通知的开关 仅 iOS 有效
notificationAlertAuthorized允许微信通知带有提醒的开关 仅 iOS 有效
notificationBadgeAuthorized允许微信通知带有标记的开关 仅 iOS 有效
notificationSoundAuthorized允许微信通知带有声音的开关 仅 iOS 有效
bluetoothEnabled蓝牙的系统开关
locationEnabled地理位置的系统开关
wifiEnabledWi-Fi 的系统开关

getUpdateManager

接口描述:获取全局唯一的版本更新管理器

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getLaunchOptionsSync

接口描述:获取小程序启动时的参数

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onPageNotFound

接口描述:监听小程序要打开的页面不存在事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onError

接口描述:监听小程序错误事件。如脚本错误或 API 调用报错等。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onAudioInterruptionBegin

接口描述:监听音频因为受到系统占用而被中断开始事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onAudioInterruptionEnd

接口描述:监听音频中断结束事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onAppShow

接口描述:监听小程序切前台事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onAppHide

接口描述:监听小程序切后台事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offPageNotFound

接口描述:取消监听小程序要打开的页面不存在事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offError

接口描述:监听小程序切前台事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offAudioInterruptionBegin

接口描述:取消监听音频因为受到系统占用而被中断开始事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offAudioInterruptionEnd

接口描述:取消监听音频中断结束事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offAppShow

接口描述:取消监听小程序切前台事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offAppHide

接口描述:取消监听小程序切后台事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

setEnableDebug

接口描述:设置是否打开调试开关。此开关对正式版也能生效

微信文档

  • 支持性
微信支付宝
支持不支持

getLogManager

接口描述:获取日志管理器对象。

微信文档

  • 支持性
微信支付宝
支持不支持

createCameraContext

接口描述:创建 camera 上下文 CameraContext 对象

微信文档

  • 支持性
微信支付宝
支持支持

base64ToArrayBuffer

接口描述:将 Base64 字符串转成 ArrayBuffer 对象

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

arrayBufferToBase64

接口描述:将 ArrayBuffer 字符串转成 Base64 对象

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

updateWeChatApp

接口描述:更新客户端版本

微信文档

  • 支持性
微信支付宝
支持不支持

getEnterOptionsSync

接口描述:获取本次小程序启动时的参数

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onUnhandledRejection

接口描述:监听未处理的 Promise 拒绝事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onThemeChange

接口描述:监听系统主题改变事件

微信文档

  • 支持性
微信支付宝
支持不支持

offUnhandledRejection

接口描述:取消监听未处理的 Promise 拒绝事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offThemeChange

接口描述:取消监听系统主题改变事件

微信文档

  • 支持性
微信支付宝
支持不支持

getRealtimeLogManager

接口描述:获取实时日志管理器对象

微信文档

  • 支持性
微信支付宝
支持不支持

createCanvasContext

接口描述:创建 canvas 的绘图上下文 CanvasContext 对象

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

canvasToTempFilePath

接口描述:把当前画布指定区域的内容导出生成指定大小的图片

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

canvasPutImageData

接口描述:将像素数据绘制到画布

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

canvasGetImageData

接口描述:获取 canvas 区域隐含的像素数据。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

createOffscreenCanvas

接口描述:创建离屏 canvas 实例

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

stopBeaconDiscovery

接口描述:停止搜索附近的 iBeacon 设备

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

startBeaconDiscovery

接口描述:开始搜索附近的 iBeacon 设备

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数缺失

  • 入参差异:
参数差异説明
ignoreBluetoothAvailable是否校验蓝牙开关,仅在 iOS 下有效

onBeaconUpdate

接口描述:监听 iBeacon 设备更新事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

onBeaconServiceChange

接口描述:监听 iBeacon 服务状态变化事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数类型不同,wx: Function , alipay: Object

getBeacons

接口描述:获取所有已搜索到的 iBeacon 设备

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

stopWifi

接口描述:关闭 Wi-Fi 模块

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

startWifi

接口描述:初始化 Wi-Fi 模块

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

setWifiList

接口描述:设置 wifiList 中 AP 的相关信息。在 onGetWifiList 回调后调用,iOS特有接口

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onWifiConnected

接口描述:监听连接上 Wi-Fi 的事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onGetWifiList

接口描述:监听获取到 Wi-Fi 列表数据事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getWifiList

接口描述:监听连接上 Wi-Fi 的事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getConnectedWifi

接口描述:监听连接上 Wi-Fi 的事件。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

connectWifi

接口描述:连接 Wi-Fi。若已知 Wi-Fi 信息,可以直接利用该接口连接。仅 Android 与 iOS 11 以上版本支持。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

writeBLECharacteristicValue

接口描述:读取低功耗蓝牙设备的特征值的二进制数据值。注意:必须设备的特征值支持 read 才可以成功调用

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

readBLECharacteristicValue

接口描述:读取低功耗蓝牙设备的特征值的二进制数据值。注意:必须设备的特征值支持 read 才可以成功调用。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onBLEConnectionStateChange

接口描述:监听低功耗蓝牙连接状态的改变事件。包括开发者主动连接或断开连接,设备丢失,连接异常断开等等

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

onBLECharacteristicValueChange

接口描述:监听低功耗蓝牙设备的特征值变化事件。必须先启用 notifyBLECharacteristicValueChange 接口才能接收到设备推送的 notification。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

notifyBLECharacteristicValueChange

接口描述:监听低功耗蓝牙设备的特征值变化事件。必须先启用 notifyBLECharacteristicValueChange 接口才能接收到设备推送的 notification。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : wx中state为必填参数

getBLEDeviceServices

接口描述:获取蓝牙设备所有服务(service)

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

getBLEDeviceCharacteristics

接口描述:获取蓝牙设备某个服务中所有特征值(characteristic)。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

createBLEConnection

接口描述:连接低功耗蓝牙设备。

微信文档

  • 支持性
微信支付宝
支持不支持

closeBLEConnection

接口描述:断开与低功耗蓝牙设备的连接。

微信文档

  • 支持性
微信支付宝
支持不支持

addPhoneContact

接口描述:添加手机通讯录联系人。用户可以选择将该表单以「新增联系人」或「添加到已有联系人」的方式,写入手机系统通讯录。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数名不同

stopBluetoothDevicesDiscovery

接口描述:停止搜寻附近的蓝牙外围设备。若已经找到需要的蓝牙设备并不需要继续搜索时,建议调用该接口停止蓝牙搜索。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

startBluetoothDevicesDiscovery

接口描述:开始搜寻附近的蓝牙外围设备

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

openBluetoothAdapter

接口描述:初始化蓝牙模块

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

onBluetoothDeviceFound

接口描述:监听寻找到新设备的事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数类型不同, 返回值缺失

  • 入参差异:
参数差异説明
advertisData当前蓝牙设备的广播数据段中的 ManufacturerData 数据段。wx: ArrayBuffer, alipay: Hex String
  • 返回值差异:
参数差异描述
advertisServiceUUIDs当前蓝牙设备的广播数据段中的ServiceUUIDs 数据段
serviceData当前蓝牙设备的广播数据段中的 ServiceData 数据段

onBluetoothAdapterStateChange

接口描述:监听蓝牙适配器状态变化事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getConnectedBluetoothDevices

接口描述:根据 uuid 获取处于已连接状态的设备。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数名差异

  • 入参差异:
参数差异説明
services蓝牙设备主 service 的 uuid 列表, wx: services, alipay: deviceId

getBluetoothDevices

接口描述:获取在蓝牙模块生效期间所有已发现的蓝牙设备。包括已经和本机处于连接状态的设备。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 返回值属性类型差异/缺失

  • 返回值差异:
参数差异描述
advertisData设备的广播内容, wx: ArrayBuffer, alipay: Hex String
advertisServiceUUIDs当前蓝牙设备的广播数据段中的ServiceUUIDs 数据段
serviceData当前蓝牙设备的广播数据段中的 ServiceData 数据段

getBluetoothAdapterState

接口描述:获取本机蓝牙适配器状态。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

closeBluetoothAdapter

接口描述:关闭蓝牙模块。调用该方法将断开所有已建立的连接并释放系统资源。建议在使用蓝牙流程后,与 wx.openBluetoothAdapter 成对调用。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getBatteryInfoSync

接口描述:wx.getBatteryInfo 的同步版本

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getBatteryInfo

接口描述:获取设备电量。同步 API wx.getBatteryInfoSync 在 iOS 上不可用。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

stopHCE

接口描述:关闭 NFC 模块。仅在安卓系统下有效。

微信文档

  • 支持性
微信支付宝
支持不支持

startHCE

接口描述:初始化 NFC 模块。

微信文档

  • 支持性
微信支付宝
支持不支持

sendHCEMessage

接口描述:发送 NFC 消息。仅在安卓系统下有效。

微信文档

  • 支持性
微信支付宝
支持不支持

onHCEMessage

接口描述:监听接收 NFC 设备消息事件

微信文档

  • 支持性
微信支付宝
支持不支持

getHCEState

接口描述:判断当前设备是否支持 HCE 能力。

微信文档

  • 支持性
微信支付宝
支持不支持

onNetworkStatusChange

接口描述:监听网络状态变化事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

getNetworkType

接口描述:获取网络类型

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 返回值属性差异

  • 返回值差异:
参数差异描述
networkTypewx: wifi/2g/3g/4g/unknown/none, alipay: WIFI/2G/3G/4G/UNKNOWN/NOTREACHABLE

setScreenBrightness

接口描述:设置屏幕亮度

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

setKeepScreenOn

接口描述:设置是否保持常亮状态。仅在当前小程序生效,离开小程序后设置失效。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onUserCaptureScreen

接口描述:监听用户主动截屏事件。用户使用系统截屏按键截屏时触发

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getScreenBrightness

接口描述:获取屏幕亮度

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

makePhoneCall

接口描述:拨打电话

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后不支持回调

  • 入参差异:
参数差异説明
success接口调用成功的回调函数
fail接口调用失败的回调函数
complete接口调用结束的回调函数(调用成功、失败都会执行)

onAccelerometerChange

接口描述:监听加速度数据事件。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

startAccelerometer

接口描述:开始监听罗盘数据

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

stopAccelerometer

接口描述:停止监听加速度数据。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 名称不同wx: stopAccelerometer, alipay: offAccelerometerChange, 参数缺失

  • 入参差异:
参数差异説明
success接口调用成功的回调函数
fail接口调用失败的回调函数
complete接口调用结束的回调函数(调用成功、失败都会执行)

onCompassChange

接口描述:监听罗盘数据变化事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 返回值属性缺失

  • 返回值差异:
参数差异描述
accuracy精度

startCompass

接口描述:开始监听罗盘数据

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

stopCompass

接口描述:停止监听罗盘数据

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 命名不同wx: stopCompass, alipay: offCompassChange, 参数缺失

  • 入参差异:
参数差异説明
success接口调用成功的回调函数
fail接口调用失败的回调函数
complete接口调用结束的回调函数(调用成功、失败都会执行)

onDeviceMotionChange

接口描述:监听设备方向变化事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

startDeviceMotionListening

接口描述:开始监听设备方向的变化

微信文档

  • 支持性
微信支付宝
支持不支持

stopDeviceMotionListening

接口描述:停止监听设备方向的变化

微信文档

  • 支持性
微信支付宝
支持不支持

onGyroscopeChange

接口描述:监听陀螺仪数据变化事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

startGyroscope

接口描述:开始监听陀螺仪数据

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

stopGyroscope

接口描述:停止监听陀螺仪数据。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 命名不同wx: stopGyroscope, alipay: offGyroscopeChange, 参数缺失

  • 入参差异:
参数差异説明
success接口调用成功的回调函数
fail接口调用失败的回调函数
complete接口调用结束的回调函数(调用成功、失败都会执行)

onMemoryWarning

接口描述:监听内存不足告警事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

scanCode

接口描述:调起客户端扫码界面进行扫码

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数差异, 返回值差异/缺失

  • 入参差异:
参数差异説明
onlyFromCamera是否只能从相机扫码,不允许从相册选择图片, wx: onlyFromCamera, alipay: hideAlbum
scanType扫码类型, wx: scanType 支持数组类型;默认值是['barCode', 'qrCode'];取值范围:barCode、qrCode、datamatrix、pdf417, alipay: type 不支持数组类型;默认值是qr;取值范围:qr、bar
  • 返回值差异:
参数差异描述
scanType所扫码的类型
charSet所扫码的字符集
path当所扫的码为当前小程序二维码时,会返回此字段,内容为二维码携带的 path
rawData原始数据,base64编码

vibrateLong

接口描述:使手机发生较长时间的振动

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

vibrateShort

接口描述:使手机发生较长时间的振动

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 震动时间不同wx: 15ms, alipay: 40ms

onBLEPeripheralConnectionStateChanged

接口描述:监听当前外围设备被连接或断开连接事件

微信文档

  • 支持性
微信支付宝
支持不支持

offBLEPeripheralConnectionStateChanged

接口描述:取消监听当前外围设备被连接或断开连接事件

微信文档

  • 支持性
微信支付宝
支持不支持

createBLEPeripheralServer

接口描述:建立本地作为外围设备的服务端,可创建多个

微信文档

  • 支持性
微信支付宝
支持不支持

offHCEMessage

接口描述:接收 NFC 设备消息事件,取消事件监听

微信文档

  • 支持性
微信支付宝
支持不支持

getNFCAdapter

接口描述:获取 NFC 实例

微信文档

  • 支持性
微信支付宝
支持不支持

offWifiConnected

接口描述:取消监听连接上 Wi-Fi 的事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offGetWifiList

接口描述:取消监听获取到 Wi-Fi 列表数据事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

setBLEMTU

接口描述:设置蓝牙最大传输单元

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offBLEConnectionStateChange

接口描述:取消监听低功耗蓝牙连接状态的改变事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offBLECharacteristicValueChange

接口描述:取消监听低功耗蓝牙设备的特征值变化事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

makeBluetoothPair

接口描述:蓝牙配对接口,仅安卓使用

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getBLEDeviceRSSI

接口描述:获取蓝牙设备的信号强度

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

checkIsOpenAccessibility

接口描述:检测是否开启视觉无障碍功能

微信文档

  • 支持性
微信支付宝
支持不支持

offBluetoothAdapterStateChange

接口描述:取消监听蓝牙适配器状态变化事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

setClipboardData

接口描述:设置系统剪贴板的内容

微信文档

  • 支持性
微信支付宝
支持不支持

getClipboardData

接口描述:获取系统剪贴板的内容

微信文档

  • 支持性
微信支付宝
支持不支持

offNetworkStatusChange

接口描述:取消监听网络状态变化事件,参数为空,则取消所有的事件监听

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offUserCaptureScreen

接口描述:用户主动截屏事件。取消事件监听

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offDeviceMotionChange

接口描述:取消监听设备方向变化事件,参数为空,则取消所有的事件监听

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

offMemoryWarning

接口描述:取消监听内存不足告警事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getExtConfig

接口描述:获取第三方平台自定义的数据字段。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getExtConfigSync

接口描述:wx.getExtConfig 的同步版本。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

saveFile

接口描述:保存文件到本地

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

removeSavedFile

接口描述:删除本地缓存文件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

openDocument

接口描述:新开页面打开文档

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getSavedFileList

接口描述:获取保存的所有文件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

getSavedFileInfo

接口描述:获取保存的文件信息

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后支持

getFileSystemManager

接口描述:获取全局唯一的文件管理器

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getFileInfo

接口描述:获取文件信息

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

saveFileToDisk

接口描述:保存文件系统的文件到用户磁盘,仅在 PC 端支持

微信文档

  • 支持性
微信支付宝
支持不支持

openLocation

接口描述:打开位置

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getLocation

接口描述:获取位置

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数缺失, 参数type的取值/默认值差异, 返回值缺失/差异

  • 入参差异:
参数差异説明
altitude传入 true 会返回高度信息,由于获取高度需要较高精确度,会减慢接口返回速度
typewx: 默认值wgs84, alipay: 默认值0
  • 返回值差异:
参数差异描述
speed速度,单位 m/s
altitude高度,单位 m
verticalAccuracy垂直精度,单位 m(Android 无法获取,返回 0)
errorapp未授权定位:alipay返回错误码11, wx返回errMsg:'getLocation:fail 1', app授权,小程序弹框询问权限时拒绝:alipay返回错误码2001;wx返回errMsg: “getLocation:fail authorize no response”

chooseLocation

接口描述:打开地图选择位置

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

stopLocationUpdate

接口描述:关闭监听实时位置变化,前后台都停止消息接收

微信文档

  • 支持性
微信支付宝
支持不支持

startLocationUpdateBackground

接口描述:开启小程序进入前后台时均接收位置消息,需引导用户开启授权

微信文档

  • 支持性
微信支付宝
支持不支持

startLocationUpdate

接口描述:开启小程序进入前台时接收位置消息

微信文档

  • 支持性
微信支付宝
支持不支持

onLocationChange

接口描述:监听实时地理位置变化事件

微信文档

  • 支持性
微信支付宝
支持不支持

offLocationChange

接口描述:取消监听实时地理位置变化事件

微信文档

  • 支持性
微信支付宝
支持不支持

createMapContext

接口描述:创建 map 上下文 MapContext 对象

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 返回值对象方法缺失

  • 返回值差异:
参数差异描述
getRegion获取当前地图的视野范围
getScale获取当前地图的缩放级别
includePoints缩放视野展示所有经纬度

saveImageToPhotosAlbum

接口描述:保存图片到系统相册不支持网络图片路径

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 完全支持

previewImage

接口描述:在新页面中全屏预览图片

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getImageInfo

接口描述:获取图片信息

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

compressImage

接口描述:压缩图片接口,可选压缩质量

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后可完全支持

chooseMessageFile

接口描述:从客户端会话选择文件

微信文档

  • 支持性
微信支付宝
支持不支持

chooseImage

接口描述:从本地相册选择图片或使用相机拍照

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 返回值属性缺失

  • 返回值差异:
参数差异描述
tempFiles图片的本地临时文件列表

saveVideoToPhotosAlbum

接口描述:保存视频到系统相册

微信文档

  • 支持性
微信支付宝
支持支持

createVideoContext

接口描述:创建 video 上下文 VideoContext 对象

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 返回值方法缺失

  • 返回值差异:
参数差异描述
sendDanmu发送弹幕

chooseVideo

接口描述:拍摄视频或从手机相册中选视频

微信文档

  • 支持性
微信支付宝
支持支持

stopVoice

接口描述:结束播放语音

微信文档

  • 支持性
微信支付宝
支持支持

setInnerAudioOption

接口描述:设置 InnerAudioContext 的播放选项

微信文档

  • 支持性
微信支付宝
支持不支持

playVoice

接口描述:开始播放语音

微信文档

  • 支持性
微信支付宝
支持支持

pauseVoice

接口描述:暂停正在播放的语音

微信文档

  • 支持性
微信支付宝
支持支持

getAvailableAudioSources

接口描述:developers.weixin.qq.com/miniprogram…

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

createInnerAudioContext

接口描述:创建内部 audio 上下文 InnerAudioContext 对象

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

createAudioContext

接口描述:创建 audio 上下文 AudioContext 对象

微信文档

  • 支持性
微信支付宝
支持支持

stopBackgroundAudio

接口描述:停止播放音乐

微信文档

  • 支持性
微信支付宝
支持不支持

seekBackgroundAudio

接口描述:控制音乐播放进度

微信文档

  • 支持性
微信支付宝
支持不支持

playBackgroundAudio

接口描述:使用后台播放器播放音乐

微信文档

  • 支持性
微信支付宝
支持不支持

pauseBackgroundAudio

接口描述:暂停播放音乐

微信文档

  • 支持性
微信支付宝
支持不支持

onBackgroundAudioStop

接口描述:监听音乐停止事件

微信文档

  • 支持性
微信支付宝
支持不支持

onBackgroundAudioPlay

接口描述:监听音乐播放事件

微信文档

  • 支持性
微信支付宝
支持不支持

onBackgroundAudioPause

接口描述:监听音乐暂停事件

微信文档

  • 支持性
微信支付宝
支持不支持

getBackgroundAudioPlayerState

接口描述:获取后台音乐播放状态

微信文档

  • 支持性
微信支付宝
支持不支持

getBackgroundAudioManager

接口描述:获取全局唯一的背景音频管理器

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

createLivePusherContext

接口描述:创建 live-pusher 上下文 LivePusherContext 对象

微信文档

  • 支持性
微信支付宝
支持不支持

createLivePlayerContext

接口描述:创建 live-player 上下文 LivePlayerContext 对象

微信文档

  • 支持性
微信支付宝
支持不支持

stopRecord

接口描述:停止录音

微信文档

  • 支持性
微信支付宝
支持支持

startRecord

接口描述:开始录音

微信文档

  • 支持性
微信支付宝
支持支持

getRecorderManager

接口描述:获取全局唯一的录音管理器 RecorderManager

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 返回值方法缺失

  • 返回值差异:
参数差异描述
pause暂停录音
resume继续录音
onpause监听录音暂停事件
onresume监听录音继续事件
onFrameRecorded监听已录制完指定帧大小的文件事件。如果设置了 frameSize,则会回调此事件
onInterruptionEnd监听录音中断结束事件。在收到 interruptionBegin 事件之后,小程序内所有录音会暂停,收到此事件之后才可再次录音成功
onInterruptionBegin监听录音因为受到系统占用而被中断开始事件。以下场景会触发此事件:微信语音聊天、微信视频聊天。此事件触发后,录音会被暂停。pause 事件在此事件后触发

previewMedia

接口描述:预览图片和视频

微信文档

  • 支持性
微信支付宝
支持不支持

openVideoEditor

接口描述:打开视频编辑器

微信文档

  • 支持性
微信支付宝
支持不支持

getVideoInfo

接口描述:获取视频详细信息

微信文档

  • 支持性
微信支付宝
支持不支持

compressVideo

接口描述:压缩视频

微信文档

  • 支持性
微信支付宝
支持不支持

chooseMedia

接口描述:拍摄或从手机相册中选择图片或视频

微信文档

  • 支持性
微信支付宝
支持不支持

createMediaContainer

接口描述:创建音视频处理容器,最终可将容器中的轨道合成一个视频

微信文档

  • 支持性
微信支付宝
支持不支持

updateVoIPChatMuteConfig

接口描述:更新实时语音静音设置

微信文档

  • 支持性
微信支付宝
支持不支持

subscribeVoIPVideoMembers

接口描述:订阅视频画面成员

微信文档

  • 支持性
微信支付宝
支持不支持

setEnable1v1Chat

接口描述:开启双人通话

微信文档

  • 支持性
微信支付宝
支持不支持

onVoIPVideoMembersChanged

接口描述:监听实时语音通话成员视频状态变化事件

微信文档

  • 支持性
微信支付宝
支持不支持

onVoIPChatSpeakersChanged

接口描述:监听实时语音通话成员通话状态变化事件

微信文档

  • 支持性
微信支付宝
支持不支持

onVoIPChatMembersChanged

接口描述:监听实时语音通话成员在线状态变化事件

微信文档

  • 支持性
微信支付宝
支持不支持

onVoIPChatInterrupted

接口描述:监听被动断开实时语音通话事件

微信文档

  • 支持性
微信支付宝
支持不支持

offVoIPVideoMembersChanged

接口描述:取消监听实时语音通话成员视频状态变化事件

微信文档

  • 支持性
微信支付宝
支持不支持

offVoIPChatMembersChanged

接口描述:取消监听实时语音通话成员在线状态变化事件

微信文档

  • 支持性
微信支付宝
支持不支持

offVoIPChatInterrupted

接口描述:取消监听被动断开实时语音通话事件

微信文档

  • 支持性
微信支付宝
支持不支持

joinVoIPChat

接口描述:加入 (创建) 实时语音通话

微信文档

  • 支持性
微信支付宝
支持不支持

join1v1Chat

接口描述:加入(创建)双人通话

微信文档

  • 支持性
微信支付宝
支持不支持

exitVoIPChat

接口描述:退出(销毁)实时语音通话

微信文档

  • 支持性
微信支付宝
支持不支持

createMediaRecorder

接口描述:创建 WebGL 画面录制器

微信文档

  • 支持性
微信支付宝
支持不支持

createVideoDecoder

接口描述:创建视频解码器

微信文档

  • 支持性
微信支付宝
支持不支持

request

接口描述:发起 HTTPS 网络请求

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 入参参数名称差异/参数缺失/返回值名称差异

  • 入参差异:
参数差异説明
header设置请求的 header,header 中不能设置 Referer。content-type 默认为 application/json, wx: header, alipay: headers
responseType响应的数据类型, alipay缺失: responseType
method合法值OPTIONS,HEAD,PUT,DELETE,TRACE,CONNECT
  • 返回值差异:
参数差异描述
statusCodewx: statusCode, alipay: status
headerwx: header, alipay: headers

downloadFile

接口描述:下载文件资源到本地

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数缺失, 返回值属性值/方法缺失, 返回值名称差异

  • 入参差异:
参数差异説明
filePath指定文件下载后存储的路径
  • 返回值差异:
参数差异描述
tempFilePath临时文件路径, wx: tempFilePath, alipay: apFilePath
filePath用户文件路径。传入 filePath 时会返回,跟传入的 filePath 一致
statusCode开发者服务器返回的 HTTP 状态码
abort中断下载任务
offHeadersReceived监听下载进度变化事件
offProgressUpdate取消监听下载进度变化事件
onHeadersReceived监听 HTTP Response Header 事件。会比请求完成事件更早
onProgressUpdate取消监听 HTTP Response Header 事件

uploadFile

接口描述:上传本地资源到开发者服务器

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数名称差异, 返回值方法缺失

  • 入参差异:
参数差异説明
name文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容, wx: name, alipay: fileName
  • 返回值差异:
参数差异描述
abortmissing
offHeadersReceivedmissing
offProgressUpdatemissing
onHeadersReceivedmissing
onProgressUpdatemissing

connectSocket

接口描述:创建一个 WebSocket 的连接

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数缺失, 返回值缺失

  • 入参差异:
参数差异説明
protocols子协议数组
tcpNoDelay建立 TCP 连接的时候的 TCP_NODELAY 设置
  • 返回值差异:
参数差异描述
closemissing
cloonClosesemissing
onErrormissing
onMessagemissing
onOpenmissing
sendmissing

onSocketOpen

接口描述:监听WebSocket连接打开事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 返回值属性值缺失

  • 返回值差异:
参数差异描述
header连接成功的 HTTP 响应 Header

sendSocketMessage

接口描述:通过 WebSocket 连接发送数据

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onSocketMessage

接口描述:监听WebSocket接受到服务器的消息事件

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onSocketError

接口描述:监听WebSocket错误

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

onSocketClose

接口描述:监听WebSocket关闭

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

closeSocket

接口描述:关闭 WebSocket 连接

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数缺失

  • 入参差异:
参数差异説明
code一个数字值表示关闭连接的状态号,表示连接被关闭的原因。
reason一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本(不是字符)

stopLocalServiceDiscovery

接口描述:停止搜索 mDNS 服务

微信文档

  • 支持性
微信支付宝
支持不支持

startLocalServiceDiscovery

接口描述:开始搜索局域网下的 mDNS 服务

微信文档

  • 支持性
微信支付宝
支持不支持

onLocalServiceResolveFail

接口描述:监听 mDNS 服务解析失败的事件

微信文档

  • 支持性
微信支付宝
支持不支持

onLocalServiceLost

接口描述:监听 mDNS 服务离开的事件

微信文档

  • 支持性
微信支付宝
支持不支持

onLocalServiceFound

接口描述:监听 mDNS 服务发现的事件

微信文档

  • 支持性
微信支付宝
支持不支持

onLocalServiceDiscoveryStop

接口描述:监听 mDNS 服务停止搜索的事件

微信文档

  • 支持性
微信支付宝
支持不支持

offLocalServiceResolveFail

接口描述:取消监听 mDNS 服务解析失败的事件

微信文档

  • 支持性
微信支付宝
支持不支持

offLocalServiceLost

接口描述:取消监听 mDNS 服务离开的事件

微信文档

  • 支持性
微信支付宝
支持不支持

offLocalServiceFound

接口描述:取消监听 mDNS 服务发现的事件

微信文档

  • 支持性
微信支付宝
支持不支持

offLocalServiceDiscoveryStop

接口描述:取消监听 mDNS 服务停止搜索的事件

微信文档

  • 支持性
微信支付宝
支持不支持

createUDPSocket

接口描述:创建一个 UDP Socket 实例

微信文档

  • 支持性
微信支付宝
支持不支持

login

接口描述:调用接口获取登录凭证(code)

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

checkSession

接口描述:检查登录态是否过期

微信文档

  • 支持性
微信支付宝
支持不支持

navigateToMiniProgram

接口描述:打开另一个小程序

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

navigateBackMiniProgram

接口描述:返回到上一个小程序

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getAccountInfoSync

接口描述:获取当前帐号信息

微信文档

  • 支持性
微信支付宝
支持不支持

getUserInfo

接口描述:获取用户信息

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 命名不同, 参数缺失, 返回值属性缺失

  • 入参差异:
参数差异説明
getUserInfowx: getUserInfo, alipay: getAuthUserInfo
withCredentials是否带上登录态信息
lang显示用户信息的语言
  • 返回值差异:
参数差异描述
userInfo用户信息对象,不包含 openid 等敏感信息
rawData不包括敏感信息的原始数据字符串,用于计算签名
signature使用 sha1( rawData + sessionkey ) 得到字符串,用于校验用户信息
encryptedData包括敏感数据在内的完整用户信息的加密数据
iv加密算法的初始向量
cloudID敏感数据对应的云 ID,开通云开发的小程序才会返回,可通过云调用直接获取开放数据

UserInfo

接口描述:用户信息

微信文档

  • 支持性
微信支付宝
支持不支持

reportMonitor

接口描述:自定义业务数据监控上报接口

微信文档

  • 支持性
微信支付宝
支持不支持

reportAnalytics

接口描述:自定义分析数据上报接口

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

requestPayment

接口描述:发起支付

微信文档

  • 支持性
微信支付宝
支持不支持
  • 差异性

差异性描述 : 支付宝与微信支付功能差异较大,请参考支付宝支付文档做兼容处理

  • 入参差异:
参数差异説明
timeStamp时间戳,从 1970 年 1 月 1 日 00:00:00 至今的秒数,即当前的时间
nonceStr随机字符串,长度为32个字符以下
package统一下单接口返回的 prepay_id 参数值
signType签名算法,应与后台下单时的值一致
paySign签名
success接口调用成功的回调函数
fail接口调用失败的回调函数
complete接口调用结束的回调函数

authorize

接口描述:提前向用户发起授权请求

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 命名不同wx: authorize, alipay: getAuthCode, 参数差异

  • 入参差异:
参数差异説明
scope授权类型, wx: scope, alipay: scopes, 且取值不同

openSetting

接口描述:调起客户端小程序设置界面

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getSetting

接口描述:获取用户的当前设置

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

AuthSetting

接口描述:用户授权设置信息

微信文档

  • 支持性
微信支付宝
支持不支持

chooseAddress

接口描述:打开地图选择位置

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 支付宝端需要在项目作出相应配置,并需要服务端的支持

openCard

接口描述:查看微信卡包中的卡券

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 命名不同wx: openCard, alipay: openCardList, 参数缺失

  • 入参差异:
参数差异説明
cardList需要打开的卡券列表
success接口调用成功的回调函数
fail接口调用失败的回调函数
complete接口调用结束的回调函数(调用成功、失败都会执行)

addCard

接口描述:添加卡券

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 命名不同wx: addCard, alipay: addCardAuth, 参数缺失, 返回值差异

  • 入参差异:
参数差异説明
cardList需要添加的卡券列表

chooseInvoiceTitle

接口描述:选择用户的发票抬头

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

chooseInvoice

接口描述:选择用户已有的发票

微信文档

  • 支持性
微信支付宝
支持不支持

startSoterAuthentication

接口描述:开始 SOTER 生物认证

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 命名不同wx: startSoterAuthentication, alipay: ap.faceVerify, 参数缺失

  • 入参差异:
参数差异説明
requestAuthModes请求使用的可接受的生物认证方式
challenge挑战因子
authContent验证描述,即识别过程中显示在界面上的对话框提示内容
complete接口调用结束的回调函数(调用成功、失败都会执行)

checkIsSupportSoterAuthentication

接口描述:获取本机支持的 SOTER 生物认证方式

微信文档

  • 支持性
微信支付宝
支持不支持

checkIsSoterEnrolledInDevice

接口描述:获取设备内是否录入如指纹等生物信息的接口

微信文档

  • 支持性
微信支付宝
支持不支持

getWeRunData

接口描述:获取用户过去三十天微信运动步数

微信文档

  • 支持性
微信支付宝
支持不支持

reportPerformance

接口描述:小程序测速上报

微信文档

  • 支持性
微信支付宝
支持不支持

getPerformance

接口描述:获取当前小程序性能相关的信息

微信文档

  • 支持性
微信支付宝
支持不支持

requestSubscribeMessage

接口描述:调起客户端小程序订阅消息界面,返回用户订阅消息的操作结果

微信文档

  • 支持性
微信支付宝
支持不支持

showRedPackage

接口描述:拉取h5领取红包封面页

微信文档

  • 支持性
微信支付宝
支持不支持

getGroupEnterInfo

接口描述:获取群工具小程序启动信息

微信文档

  • 支持性
微信支付宝
支持不支持

switchTab

接口描述:跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

reLaunch

接口描述:关闭所有页面,打开到应用内的某个页面

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : alipay: url 为 tabbar 页面时不支持传参

redirectTo

接口描述:关闭当前页面,跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

navigateTo

接口描述:保留当前页面,跳转到应用内的某个页面。但是不能跳到 tabbar 页面。使用 wx.navigateBack 可以返回到原页面。小程序中页面栈最多十层。

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

navigateBack

接口描述:关闭当前页面,返回上一页面或多级页面

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

updateShareMenu

接口描述:更新转发属性

微信文档

  • 支持性
微信支付宝
支持不支持

showShareMenu

接口描述:显示当前页面的转发按钮

微信文档

  • 支持性
微信支付宝
支持不支持

hideShareMenu

接口描述:隐藏转发按钮

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getShareInfo

接口描述:获取转发详细信息

微信文档

  • 支持性
微信支付宝
支持不支持

authPrivateMessage

接口描述:验证私密消息

微信文档

  • 支持性
微信支付宝
支持不支持

setStorageSync

接口描述:将数据存储在本地缓存中指定的 key 中

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

setStorage

接口描述:将数据存储在本地缓存中指定的 key 中异步接口

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

removeStorageSync

接口描述:从本地缓存中同步移除指定 key

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

removeStorage

接口描述:从本地缓存中移除指定 key

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getStorageSync

接口描述:获取缓存数据

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后完全支持

getStorageInfoSync

接口描述:获取当前storage的相关信息

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getStorageInfo

接口描述:异步获取当前storage的相关信息

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

getStorage

接口描述:从本地缓存中异步获取指定 key 的内容

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 返回值的类型

  • 返回值差异:
参数差异描述
datakey对应的内容, wx: any, alipay: Object/String

clearStorageSync

接口描述:同步清理本地数据缓存

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

clearStorage

接口描述:清理本地数据缓存

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

setBackgroundFetchToken

接口描述:设置自定义登录态

微信文档

  • 支持性
微信支付宝
支持不支持

onBackgroundFetchData

接口描述:监听收到 backgroundFetch 数据时的回调

微信文档

  • 支持性
微信支付宝
支持不支持

getBackgroundFetchToken

接口描述:获取设置过的自定义登录态

微信文档

  • 支持性
微信支付宝
支持不支持

getBackgroundFetchData

接口描述:拉取 backgroundFetch 客户端缓存数据

微信文档

  • 支持性
微信支付宝
支持不支持

createSelectorQuery

接口描述:返回一个 SelectorQuery 对象实例

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 返回值方法缺失

  • 返回值差异:
参数差异描述
in将选择器的选取范围更改为自定义组件 component 内。(初始时,选择器仅选取页面范围的节点,不会选取任何自定义组件中的节点)

createIntersectionObserver

接口描述:创建并返回一个 IntersectionObserver 对象实例

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

IntersectionObserver

接口描述:IntersectionObserver 对象,用于推断某些节点是否可以被用户看见、有多大比例可以被用户看见

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

NodesRef

接口描述:用于获取 WXML 节点信息的对象

微信文档

  • 支持性
微信支付宝
支持不支持

SelectorQuery

接口描述:查询节点信息的对象

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

showToast

接口描述:显示消息提示框

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 入参参数差异/缺失

  • 入参差异:
参数差异説明
title提示的内容, wx: title, alipay: content
icon图标, wx: icon, alipay: type
image自定义图标的本地路径,image 的优先级高于 icon
mask是否显示透明蒙层,防止触摸穿透
icon的合法值显示加载图标,此时 title 文本最多显示 7 个汉字长度

showModal

接口描述:显示模态对话框

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 入参参数名称差异/参数缺失/返回值名称差异

  • 入参差异:
参数差异説明
confirmText确认按钮的文字,最多 4 个字符, wx: confirmText, alipay: confirmButtonText
cancelText取消按钮的文字,最多 4 个字符, wx: cancelText, alipay: cancelButtonText
showCancel是否显示取消按钮
cancelColor取消按钮的文字颜色,必须是 16 进制格式的颜色字符串
confirmColor确认按钮的文字颜色,必须是 16 进制格式的颜色字符串
  • 返回值差异:
参数差异描述
confirmwx: 为true时,表示用户点击了确定按钮, alipay: 点击confirm返回true,点击cancel返回false
cancelwx: 为 true 时,表示用户点击了取消(用于 Android 系统区分点击蒙层关闭还是点击取消按钮关闭)

showLoading

接口描述:显示 loading 提示框

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 入参参数名称差异/参数缺失

  • 入参差异:
参数差异説明
title提示的内容, wx: title, alipay: content
mask是否显示透明蒙层,防止触摸穿透

showActionSheet

接口描述:显示操作菜单

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 入参参数名称差异/参数缺失

  • 入参差异:
参数差异説明
itemList按钮的文字数组, wx: itemList(数组长度最大为6), alipay: items
itemColor按钮的文字颜色

hideToast

接口描述:隐藏消息提示框

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

hideLoading

接口描述:隐藏 loading 提示框

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

showNavigationBarLoading

接口描述:在当前页面显示导航条加载动画

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

setNavigationBarTitle

接口描述:动态设置当前页面的标题

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

setNavigationBarColor

接口描述:设置页面导航条颜色

微信文档

  • 支持性
微信支付宝
支持不支持

hideNavigationBarLoading

接口描述:在当前页面隐藏导航条加载动画

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

hideHomeButton

接口描述:隐藏返回首页按钮

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 封装后不支持回调

  • 入参差异:
参数差异説明
success接口调用成功的回调函数
fail接口调用失败的回调函数
complete接口调用结束的回调函数(调用成功、失败都会执行)

setBackgroundTextStyle

接口描述:动态设置下拉背景字体、loading 图的样式

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

setBackgroundColor

接口描述:动态设置窗口的背景色

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

showTabBarRedDot

接口描述:显示tabBar某一项的右上角的红点

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

showTabBar

接口描述:显示 tabBar

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

setTabBarStyle

接口描述:动态设置 tabBar 的整体样式

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

setTabBarItem

接口描述:动态设置 tabBar 某一项的内容

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

setTabBarBadge

接口描述:为 tabBar 某一项的右上角添加文本

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

removeTabBarBadge

接口描述:移除 tabBar 某一项右上角的文本

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

hideTabBarRedDot

接口描述:隐藏 tabBar 某一项的右上角的红点

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

hideTabBar

接口描述:隐藏 tabBar

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

loadFontFace

接口描述:动态加载网络字体

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

stopPullDownRefresh

接口描述:停止当前页面下拉刷新

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

startPullDownRefresh

接口描述:开始下拉刷新。调用后触发下拉刷新动画,效果与用户手动下拉刷新一致

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

pageScrollTo

接口描述:将页面滚动到目标位置

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数缺失

  • 入参差异:
参数差异説明
duration滚动动画的时长,单位 ms

createAnimation

接口描述:创建一个动画实例 animation

支付宝文档

微信文档

  • 支持性
微信支付宝
支持支持

setTopBarText

接口描述:动态设置置顶栏文字内容

微信文档

  • 支持性
微信支付宝
支持不支持

nextTick

接口描述:延迟一部分操作到下一个时间片再执行

微信文档

  • 支持性
微信支付宝
支持不支持

getMenuButtonBoundingClientRect

接口描述:获取菜单按钮(右上角胶囊按钮)的布局位置信息

微信文档

  • 支持性
微信支付宝
支持不支持

onWindowResize

接口描述:监听窗口尺寸变化事件

微信文档

  • 支持性
微信支付宝
支持不支持

offWindowResize

接口描述:取消监听窗口尺寸变化事件

微信文档

  • 支持性
微信支付宝
支持不支持

enableAlertBeforeUnload

接口描述:开启小程序页面返回询问对话框

微信文档

  • 支持性
微信支付宝
支持不支持

disableAlertBeforeUnload

接口描述:关闭小程序页面返回询问对话框

微信文档

  • 支持性
微信支付宝
支持不支持

setWindowSize

接口描述:设置窗口大小,该接口仅适用于 PC 平台

微信文档

  • 支持性
微信支付宝
支持不支持

onKeyboardHeightChange

接口描述:监听键盘高度变化

微信文档

  • 支持性
微信支付宝
支持不支持

offKeyboardHeightChange

接口描述:取消监听键盘高度变化事件

微信文档

  • 支持性
微信支付宝
支持不支持

hideKeyboard

接口描述:在input、textarea等focus拉起键盘之后,手动调用此接口收起键盘

微信文档

  • 支持性
微信支付宝
支持支持
  • 差异性

差异性描述 : 参数缺失

  • 入参差异:
参数差异説明
success接口调用成功的回调函数
fail接口调用失败的回调函数
complete接口调用结束的回调函数

getSelectedTextRange

接口描述:在input、textarea等focus之后,获取输入框的光标位置

微信文档

  • 支持性
微信支付宝
支持不支持