跳到主要内容
版本:1.0.0

API 支持情况

本文简要归纳了 MorJS 对支付宝小程序 API 的支持情况。

域内独有 API

名称功能说明MorJS 是否支持
my.sendMtop发送一个 mtop 请求
my.on绑定事件
my.call调用 JS API

基础

名称功能说明MorJS 是否支持
my.canIUse判断当前小程序的 API、入参或返回值、组件、属性等在当前版本是否支持。
my.env小程序环境变量对象 API。
my.base64ToArrayBuffer将 Base64 字符串转成 ArrayBuffer 对象。
my.arrayBufferToBase64将 ArrayBuffer 对象转成 Base64 字符串。
my.getAppIdSync同步获取小程序 APPID。
my.getLaunchOptionsSync获取小程序启动时的参数。
my.getRunScene获取当前小程序的运行版本。
my.SDKVersion获取基础库版本号。
my.getEnterOptionsSync获取本次小程序启动时的参数。

应用级事件

名称功能说明MorJS 是否支持
my.onAppHide监听小程序切后台事件。
my.offAppHide取消监听小程序切后台事件。
my.onAppShow监听小程序切前台事件。
my.offAppShow取消监听小程序切前台事件。
my.onComponentError监听小程序自定义组件内部 JS 代码的 error 事件
my.offComponentError取消监听小程序自定义组件内部 JS 代码的 error 事件。
my.onError监听小程序错误事件。
my.offError取消监听小程序错误事件。
my.onPageNotFound监听小程序要打开的页面不存在事件。
my.offPageNotFound取消监听小程序要打开的页面不存在事件。
my.onUnhandledRejection监听未处理的 Promise 拒绝事件(即  unhandledrejection  事件)。
my.offUnhandledRejection取消监听 unhandledrejection 事件。

界面

导航栏

名称功能说明MorJS 是否支持
my.getTitleColor获取导航栏背景色。
my.hideBackHome隐藏 TitleBar 上的返回首页图标,和通用菜单中的返回首页功能。
my.hideNavigationBarLoading在当前页面隐藏导航条加载动画。
my.setNavigationBar设置导航栏文字及样式。
my.showNavigationBarLoading在当前页面显示导航条加载动画。

TabBar

名称功能说明MorJS 是否支持
my.hideTabBar隐藏 TabBar。
my.hideTabBarRedDot隐藏 TabBar 某一项的右上角的红点。
my.removeTabBarBadge移除 TabBar 某一项右上角的文本。
my.setTabBarBadge为 TabBar 某一项的右上角添加文本。
my.setTabBarItem动态设置 TabBar 某一项的内容。
my.setTabBarStyle动态设置 TabBar 的整体样式。
my.showTabBar显示 TabBar。
my.showTabBarRedDot显示 TabBar 某一项的右上角的红点。
onTabItemTap点击 Tab 时触发。

路由

名称功能说明MorJS 是否支持
my.switchTab跳转到指定 TabBar 页面,并关闭其他所有非 TabBar 页面。
my.reLaunch关闭当前所有页面,跳转到应用内的某个指定页面。
my.redirectTo关闭当前页面,跳转到应用内的某个指定页面。
my.navigateTo从当前页面,跳转到应用内的某个指定页面,可以使用  my.navigateBack  返回到原来页面。
my.navigateBack关闭当前页面,返回上一级或多级页面。

交互反馈

名称功能说明MorJS 是否支持
my.alert警告框。
my.confirm确认框。
my.prompt弹出一个对话框,让用户在对话框内输入文本。
my.showToast显示一个弱提示,可选择多少秒之后消失。
my.hideLoading隐藏加载提示。
my.hideToast隐藏弱提示。
my.showLoading显示加载提示。
my.showActionSheet显示操作菜单。

下拉刷新

名称功能说明MorJS 是否支持
onPullDownRefresh监听该页面用户的下拉刷新事件。
my.stopPullDownRefresh停止当前页面的下拉刷新。
my.startPullDownRefresh开始下拉刷新。

联系人

名称功能说明MorJS 是否支持
my.choosePhoneContact选择本地系统通信录中某个联系人的电话。
my.chooseAlipayContact唤起支付宝通讯录,选择一个或者多个支付宝联系人。
my.chooseContact唤起选择联系人组件。

选择城市

名称功能说明MorJS 是否支持
my.chooseCity打开城市选择列表。
my.offLocatedComplete取消监听地理位置定位完成事件。
my.onLocatedComplete监听地理位置定位完成事件。
my.setLocatedCity修改 my.chooseCity 中的默认定位城市的名称。
my.regionPicker多级省市区选择器,自带省市区数据源。

选择地区

名称功能说明MorJS 是否支持
my.chooseDistrict使用支付宝统一样式选择地区。

选择日期

名称功能说明MorJS 是否支持
my.datePicker打开日期选择列表。

动画

名称功能说明MorJS 是否支持
my.createAnimation创建动画实例。

画布

名称功能说明MorJS 是否支持
my.createOffscreenCanvas创建离屏 canvas 实例。
my.createCanvasContext创建 canvas 绘图上下文。
RenderingContextCanvas 绘图上下文
CanvasCanvas 实例。
Image图片对象,当调用  Canvas.createImage  方法时返回此对象。

地图

名称功能说明MorJS 是否支持
my.createMapContext创建并返回一个 map 上下文对象 mapContext
my.getMapInfo获取地图基础信息。

计算路径

名称功能说明MorJS 是否支持
my.calculateRoute计算路径 API。根据起点和终点的地理位置,智能规划最佳出行路线,并计算不同出行方式下的行动距离和所需时间,默认规划步行路线,支持规划步行、公交、骑行和驾车四种路线。

键盘

名称功能说明MorJS 是否支持
my.hideKeyboard隐藏键盘。

滚动

名称功能说明MorJS 是否支持
my.pageScrollTo滚动到页面的目标位置。

节点查询

名称功能说明MorJS 是否支持
my.createIntersectionObserver创建并返回一个 IntersectionObserver 对象实例。
my.createSelectorQuery获取一个节点查询对象 SelectorQuery。

选项选择器

名称功能说明MorJS 是否支持
my.optionsSelect类似于 safari 原生 select 的组件,但是功能更加强大,一般用来替代 select,或者 2 级数据的选择。注意不支持 2 级数据之间的联动。

级联选择

名称功能说明MorJS 是否支持
my.multiLevelSelect级联选择功能,主要使用在于多级关联数据选择。

设置窗口背景

名称功能说明MorJS 是否支持
my.setBackgroundColor动态设置窗口的背景色。
my.setBackgroundTextStyle动态设置下拉背景字体、loading 图的样式。

设置页面是否支持下拉

名称功能说明MorJS 是否支持
my.setCanPullDown设置页面是否支持下拉。

字体

名称功能说明MorJS 是否支持
my.loadFontFace动态加载网络字体。

多媒体

图片

名称功能说明MorJS 是否支持
my.chooseImage拍照或从手机相册中选择图片。
my.compressImage压缩图片。
my.getImageInfo获取图片信息。
my.generateImageFromCode生成二维码,由客户端生成,速度快且不耗流量。
my.previewImage预览图片。
my.saveImage保存在线图片到手机相册。
my.saveImageToPhotosAlbum保存图片到系统相册。

视频

名称功能说明MorJS 是否支持
my.createVideoContext小程序里内嵌入视频组件,即可上传并播放视频。 my.createVideoContext 用于创建并返回一个 videoId 上下文对象 videoContext。
my.chooseVideo拍摄视频或从手机相册中选视频。
my.saveVideoToPhotosAlbum保存视频到相册。

音频播放

名称功能说明MorJS 是否支持
my.createInnerAudioContext在小程序内创建并返回内部音频(与背景音频相对应) innerAudioContext 对象。又称“前景音频”。
my.getAvailableAudioSources获取当前支持的音频输入源。
my.getBackgroundAudioManager获取后台音频播放器,与前景音频相对应,可以在用户离开当前小程序后继续播放音频。
my.offAudioInterruptionBegin取消监听音频因为系统占用而被中断的开始事件。
my.offAudioInterruptionEnd取消监听音频被中断的结束事件。
my.onAudioInterruptionBegin监听音频因为系统占用而被中断的开始事件。
my.onAudioInterruptionEnd监听音频被中断的结束事件。

lottie 动画

名称功能说明MorJS 是否支持
my.createLottieContextLottie 是一个用于 Web 和 iOS 的移动库,可使用 Bodymovin 解析以 JSON 格式导出的 Adobe After Effects 动画,并将其本地呈现在移动设备上。
my.createLottieContext 用于创建并返回一个 lottieId 上下文对象 lottieContext。

缓存

名称功能说明MorJS 是否支持
my.setStorage将数据存储在本地缓存中指定的 key 中的异步接口。
my.setStorageSync同步将数据存储在本地缓存中指定的 key 中的同步接口。
my.getStorage获取缓存数据的异步接口。
my.getStorageSync获取缓存数据的同步接口。
my.removeStorage删除缓存数据的异步接口。
my.removeStorageSync删除缓存数据的同步接口。
my.clearStorage清除本地数据缓存的异步接口。
my.clearStorageSync清除本地数据缓存的同步接口。
my.getStorageInfo获取当前 storage 的相关信息的异步接口。
my.getStorageInfoSync获取当前 storage 相关信息的同步接口。

文件

名称功能说明MorJS 是否支持
my.getFileSystemManager获取全局唯一的文件管理器。
my.getFileInfo获取文件信息。
my.getSavedFileInfo获取保存的文件信息。
my.getSavedFileList获取保存的所有文件信息。
my.openDocument在新页面打开文件预览,暂时只支持预览 PDF 格式文件。
my.removeSavedFile删除某个保存的文件。
my.saveFile保存文件到本地。

位置

名称功能说明MorJS 是否支持
my.getLocation获取用户当前的地理位置信息。
my.openLocation使用支付宝内置地图查看位置。
my.chooseLocation使用支付宝内置地图选择地理位置。

网络

名称功能说明MorJS 是否支持
my.request小程序网络请求。
my.uploadFile上传本地资源到开发者服务器。
my.downloadFile下载文件资源到本地。
my.connectSocket创建一个  WebSocket  的连接。
my.onSocketOpen监听 WebSocket  连接打开事件。
my.offSocketOpen取消监听  WebSocket 连接打开事件。
my.onSocketError监听 WebSocket  错误。
my.offSocketError取消监听 WebSocket  错误。
my.sendSocketMessage通过 WebSocket 连接发送数据。
my.onSocketMessage监听  WebSocket 接受到服务器的消息事件。
my.offSocketMessage取消监听 WebSocket  接受到服务器的消息事件。
my.closeSocket关闭 WebSocket 连接。
my.onSocketClose监听 WebSocket 关闭。
my.offSocketClose取消监听 WebSocket 关闭。

设备

系统信息

名称功能说明MorJS 是否支持
my.getSystemInfo获取手机系统信息。
my.getSystemInfoSync获取手机系统信息的同步接口。

网络状态

名称功能说明MorJS 是否支持
my.getNetworkType获取当前网络状态。
my.onNetworkStatusChange开始网络状态变化的监听。
my.offNetworkStatusChange取消网络状态变化的监听。

剪切板

名称功能说明MorJS 是否支持
my.getClipboard获取剪贴板数据。
my.setClipboard设置剪贴板数据。

摇一摇

名称功能说明MorJS 是否支持
my.watchShake摇一摇功能。

振动

名称功能说明MorJS 是否支持
my.vibrate调用振动功能。
my.vibrateLong较长时间的振动 (400ms)。
my.vibrateShort较短时间的振动 (40ms)。

加速度计

名称功能说明MorJS 是否支持
my.startAccelerometer开始监听加速度数据。
my.stopAccelerometer停止监听加速度数据。
my.onAccelerometerChange监听加速度数据。
my.offAccelerometerChange停止监听加速度数据。

陀螺仪

名称功能说明MorJS 是否支持
my.startGyroscope开始监听陀螺仪数据。
my.stopGyroscope停止监听陀螺仪数据。
my.onGyroscopeChange监听陀螺仪数据变化事件。
my.offGyroscopeChange停止监听陀螺仪数据。

罗盘

名称功能说明MorJS 是否支持
my.startCompass开始监听罗盘数据。
my.stopCompass停止监听罗盘数据。
my.onCompassChange监听罗盘数据。
my.offCompassChange停止监听罗盘数据。

设备方向

名称功能说明MorJS 是否支持
my.onDeviceMotionChange监听设备方向变化。
my.offDeviceMotionChange停止监听设备方向变化。

拨打电话

名称功能说明MorJS 是否支持
my.makePhoneCall拨打电话。

获取服务器时间

名称功能说明MorJS 是否支持
my.getServerTime获取当前服务器时间的毫秒数。

用户截屏事件

名称功能说明MorJS 是否支持
my.onUserCaptureScreen监听用户发起的主动截屏事件。
my.offUserCaptureScreen取消监听截屏事件。

屏幕亮度

名称功能说明MorJS 是否支持
my.setKeepScreenOn设置是否保持屏幕长亮状态。
my.getScreenBrightness获取屏幕亮度。
my.setScreenBrightness设置屏幕亮度。

设置

名称功能说明MorJS 是否支持
my.openSetting打开小程序设置界面,返回用户权限设置的结果。
my.getSetting获取用户的当前设置。

添加手机联系人

名称功能说明MorJS 是否支持
my.addPhoneContact用户可以选择将该表单以“创建新联系人”或“添加到现有联系人”的方式,写入到手机系统的通讯录。

无障碍

名称功能说明MorJS 是否支持
my.isScreenReaderEnabled获取设备是否开启无障碍模式。

权限引导

名称功能说明MorJS 是否支持
my.showAuthGuide通过权限引导模块以图文等形式向用户弹出 Dialog,引导用户打开相应的权限。

扫码

名称功能说明MorJS 是否支持
my.scan调用扫一扫功能。

内存不足告警

名称功能说明MorJS 是否支持
my.onMemoryWarning开始监听内存不足的告警事件。
my.offMemoryWarning停止监听内存不足的告警事件。

获取设备电量

名称功能说明MorJS 是否支持
my.getBatteryInfo获取电量的异步接口。
my.getBatteryInfoSync获取电量的同步接口。

低功耗蓝牙

名称功能说明MorJS 是否支持
my.connectBLEDevice连接低功耗蓝牙设备。
my.setBLEMTU设置低功耗蓝牙设备最大传输单元(MTU)。需在 my.connectBLEDevice 调用成功后调用,mtu 设置范围(22, 512)。
my.getBLEMTU获取低功耗蓝牙设备的最大传输单元(MTU)。
my.disconnectBLEDevice断开与低功耗蓝牙设备的连接。
my.writeBLECharacteristicValue向低功耗蓝牙设备特征值中写入数据。
my.readBLECharacteristicValue读取低功耗蓝牙设备特征值中的数据。
my.notifyBLECharacteristicValueChange启用低功耗蓝牙设备特征值变化时的 notify 功能。
my.getBLEDeviceServices获取蓝牙设备所有 service(服务)。
my.getBLEDeviceRSSI获取蓝牙低功耗设备的信号强度(Received Signal Strength Indication, RSSI)。
my.getBLEDeviceCharacteristics获取蓝牙设备所有 characteristic(特征值)。
my.onBLECharacteristicValueChange监听低功耗蓝牙设备的特征值变化的事件。
my.offBLECharacteristicValueChange监听低功耗蓝牙设备的特征值变化的事件。
my.onBLEConnectionStateChanged监听低功耗蓝牙连接的错误事件,包括设备丢失,连接异常断开等。
my.offBLEConnectionStateChanged取消低功耗蓝牙连接状态变化事件的监听。

传统蓝牙

名称功能说明MorJS 是否支持
my.openBluetoothAdapter初始化小程序蓝牙模块。
my.closeBluetoothAdapter关闭本机蓝牙模块。
my.getBluetoothAdapterState获取本机蓝牙模块状态。
my.startBluetoothDevicesDiscovery获取本机蓝牙模块状态。
my.stopBluetoothDevicesDiscovery停止搜寻附近的蓝牙外围设备。
my.getBluetoothDevices获取所有已发现的蓝牙设备,包括已经和本机处于连接状态的设备。
my.getConnectedBluetoothDevices获取处于已连接状态的设备。
my.onBluetoothDeviceFound搜索到新的蓝牙设备时触发此事件。
my.offBluetoothDeviceFound移除寻找到新的蓝牙设备事件的监听。
my.onBluetoothAdapterStateChange监听本机蓝牙状态变化的事件。
my.offBluetoothAdapterStateChange移除本机蓝牙状态变化的事件的监听。
my.makeBluetoothPair蓝牙配对接口。连接蓝牙之前,部分设备需要先配对。
my.cancelBluetoothPair取消蓝牙设备配对。
my.getBluetoothPairs获取已经配对的蓝牙设备。

iBeacon

名称功能说明MorJS 是否支持
my.startBeaconDiscovery开始搜索附近的 iBeacon 设备。
my.stopBeaconDiscovery停止搜索附近的 iBeacon 设备。
my.getBeacons获取已经搜索到的 iBeacon 设备。
my.onBeaconUpdate监听 iBeacon 设备的更新事件。
my.onBeaconServiceChange监听 iBeacon 服务的状态变化。
my.offBeaconServiceChange取消监听 iBeacon 服务的状态变化。
my.offBeaconUpdate取消监听 iBeacon 设备的更新事件。

WiFi

名称功能说明MorJS 是否支持
my.startWifi初始化 Wi-Fi 模块。
my.stopWifi关闭 Wi-Fi 模块。
my.connectWifi连接 Wi-Fi。若已知 Wi-Fi 信息,可以直接利用该接口连接。
my.getWifiList请求获取 Wi-Fi 列表,在 onGetWifiList 注册的回调中返回 wifiList 数据。iOS 将跳转到系统的 Wi-Fi 界面,Android 不会跳转。
my.setWifiList在  my.onGetWifiList  回调触发后,利用接口设置 wifiList 中 AP 的相关信息。
my.onWifiConnected监听连接上 Wi-Fi 的事件。
my.offWifiConnected取消监听连接上 Wi-Fi 的事件。
my.onGetWifiList监听在获取到 Wi-Fi 列表数据时的事件,在回调中将返回 wifiList。
my.offGetWifiList取消监听在获取到 Wi-Fi 列表数据时的事件。
my.getConnectedWifi获取已连接中的 Wi-Fi 信息。
my.registerSSID信任该 SSID,对于需要 Portal 认证的 WIFI,不会弹出 portal 认证页面。
my.unregisterSSID不再信任该 SSID,对于需要 Portal 认证的 WIFI,继续弹出 portal 认证页面。

worker

名称功能说明MorJS 是否支持
my.createWorker创建一个  Worker 线程。

数据安全

名称功能说明MorJS 是否支持
my.rsa非对称加密。

分享

名称功能说明MorJS 是否支持
onShareAppMessage在 Page 中定义 onShareAppMessage 函数,设置该页面的分享信息。
my.hideShareMenu隐藏分享按钮。
my.showSharePanel唤起分享面板。

自定义通用菜单

名称功能说明MorJS 是否支持
my.hideAddToDesktopMenu隐藏当前页面通用菜单中的  添加到桌面  功能。
my.hideAllAddToDesktopMenu隐藏所有页面的通用菜单中的  添加到桌面  功能。

更新管理

名称功能说明MorJS 是否支持
my.getUpdateManager创建一个 UpdateManager 对象,获取全局唯一的版本更新管理器,用于管理小程序更新。
UpdateManagerUpdateManager 对象,用来管理更新,可通过  my.getUpdateManager  接口获取实例。

web-view 组件控制

名称功能说明MorJS 是否支持
my.createWebViewContext通过创建webviewContext提供从小程序向web-view发送消息的能力。创建并返回  web-view  上下文  webViewContext  对象。

跳转支付宝应用或页面

名称功能说明MorJS 是否支持
my.ap.navigateToAlipayPage小程序中跳转到支付宝官方业务或运营活动页面。

升级支付宝最新版本

名称功能说明MorJS 是否支持
my.ap.updateAlipayClient打开支付宝客户端升级界面。

开放能力 API

基础能力

能力名称API 名称功能说明MorJS 是否支持
小程序相互跳转my.navigateBackMiniProgram跳转回上一个小程序的 API,只有当另一个小程序跳转到当前小程序时才能调用成功。
my.navigateToMiniProgram跳转到其他小程序。
用户授权my.getAuthCode获取用户授权码。

支付能力

能力名称API 名称功能说明MorJS 是否支持
小程序支付my.tradePay小程序唤起支付。

资金能力

能力名称API 名称功能说明MorJS 是否支持
资金授权my.tradePay小程序支付接口。
周期扣款my.paySignCenter在支付宝小程序内启动一个代扣 HTML5 服务。

会员能力

能力名称API 名称功能说明MorJS 是否支持
获取会员基础信息my.getAuthCode用户授权获取授权 code。注意在此注册流程中,scopes 参数请传递 “auth_base”。
my.getOpenUserInfo获取会员基础信息。
获取会员手机号my.getPhoneNumber获取会员手机号码。
获取会员收货地址my.getAddress获取会员收货地址。
商户会员卡my.addCardAuth小程序内唤起开卡页面。
my.openCardList打开支付宝卡包中的“卡”列表。
my.openMerchantCardList打开当前用户领取某个商户的“卡”列表。
my.openCardDetail打开当前用户领取某张卡的详情页。

营销能力

能力名称API 名称功能说明MorJS 是否支持
支付宝卡包my.openVoucherList打开支付宝卡包中的“劵”列表。
my.openMerchantVoucherList打开当前用户领取某个商户的“劵”列表。
my.openVoucherDetail打开当前用户领取某张劵的详情页(非口碑劵)。
my.openKBVoucherDetail打开当前用户领取某张劵的详情页(口碑劵)。
my.openTicketList打开支付宝卡包中的“票”列表。
my.openMerchantTicketList打开当前用户领取某个商户的“票”列表。
my.openTicketDetail打开当前用户领取某张票的详情页。
运动数据my.getRunData获取步数。
小程序自定义分享onShareAppMessage设置页面的分享信息。

安全能力

能力名称API 名称功能说明MorJS 是否支持
先享后付保障my.ap.nsf先享后付保障。
营销反作弊my.ap.preventCheat营销反作弊。
文本风险识别my.textRiskIdentification文本风险识别(用户端)。
图片内容安全my.ap.imgRisk图片提交接口。
my.ap.imgRiskCallback风险结果查询接口。

模板配置

名称功能说明MorJS 是否支持
my.getExtConfig获取  模板小程序  自定义数据字段的异步接口。
my.getExtConfigSync获取  模板小程序  自定义数据字段的同步接口。