API 概览

本文汇总了 mPaaS 小程序涉及的所有 API，具体接口信息请参阅相应的 API 文档。

界面

导航栏

名称	功能说明
my.getTitleColor	获取导航栏背景色。
my.hideBackHome	隐藏标题栏上的“返回首页”图标。
my.hideNavigationBarLoading	在当前页面隐藏导航条的加载动画。
my.showNavigationBarLoading	在当前页面显示导航条的加载动画。
my.setNavigationBar	设置导航栏样式：导航栏标题、导航栏背景色、导航栏底部边框颜色、导航栏左上角 logo 图片。

tabBar

名称	功能说明
my.hideTabBar	隐藏标签页（TabBar）。
my.hideTabBarRedDot	隐藏标签页某一项右上角的红点。
my.removeTabBarBadge	移除标签页 某一项右上角的文本。
my.setTabBarBadge	为标签页某一项的右上角添加文本。可用于设置消息条数的红点提醒。
my.setTabBarItem	动态设置标签页某一项的内容。
my.setTabBarStyle	动态设置标签页的整体样式，如文字颜色、标签背景色、标签边框颜色等。
my.showTabBar	显示标签页。
my.showTabBarRedDot	显示标签页某一项的右上角的红点。
onTabItemTap	点击标签（tab）时触发，可用于监听标签页点击事件。
tabBar 常见问题	对标签的常见问题解答。

路由

名称	功能说明
my.switchTab	跳转到指定标签页（TabBar）页面，并关闭其他所有非标签页页面。
my.reLaunch	关闭当前所有页面，跳转到应用内的某个指定页面。
my.redirectTo	关闭当前页面，跳转到应用内的某个指定页面。
my.navigateTo	从当前页面，跳转到应用内的某个指定页面。
my.navigateBack	关闭当前页面，返回上一级或多级页面。
路由 FAQ	对路由的常见问题解答。

交互反馈

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

下拉刷新

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

联系人

名称	功能说明
my.choosePhoneContact	选择本地系统通信录中某个联系人的电话。

选择城市

名称	功能说明
my.chooseCity	该接口用于打开城市选择列表。
my.onLocatedComplete	自定义 onLocatedComplete 函数，可以监听该页面地理位置定位完的回调，仅针对 my.chooseCity 中属性 setLocatedCity 为 true 的情况。
my.setLocatedCity	该接口用于修改 my.chooseCity 中的默认定位城市的名称。

选择日期

名称	功能说明
my.datePicker	打开日期选择列表。

动画

名称	功能说明
my.createAnimation	创建动画实例。

画布

名称	功能说明
my.createCanvasContext	创建画布（canvas）绘图上下文。

键盘

名称	功能说明
my.hideKeyboard	隐藏键盘。

滚动

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

节点查询

名称	功能说明
my.createSelectorQuery	获取一个节点查询对象 SelectorQuery。

选项选择器

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

级联选择

名称	功能说明
my.multiLevelSelect	多级关联数据选择的业务场景，例如省市区的信息选择。

设置背景窗口

名称	功能说明
my.setBackgroundColor	动态设置窗口的背景色。
my.setBackgroundTextStyle	动态设置下拉背景的字体、加载图形的样式。

设置页面是否支持下拉

名称	功能说明
my.setCanPullDown	设置页面是否支持下拉（小程序内页面默认支持下拉）。

设置 optionMenu

名称	功能说明
my.setOptionMenu	配置 optionMenu 导航栏的额外图标，点击后触发 onOptionMenuClick。

多媒体

图片

名称	功能说明
my.chooseImage	拍照或从手机相册中选择图片。
my.previewImage	预览图片。
my.saveImage	将在线图片保存至手机相册。
my.compressImage	压缩图片。
my.getImageInfo	获取图片信息。

缓存

名称	功能说明
my.setStorage	将数据存储在本地缓存中指定的 key 中，会覆盖原来该 key 对应的数据。
my.setStorageSync	同步将数据存储在本地缓存中指定的 key 中。
my.getStorage	异步获取缓存数据。
my.getStorageSync	同步获取缓存数据。
my.removeStorage	删除缓存数据的异步接口。
my.removeStorageSync	删除缓存数据的同步接口。
my.clearStorage	清除本地数据缓存的异步接口。
my.clearStorageSync	清除本地数据缓存的同步接口。
my.getStorageInfo	异步获取当前 storage 的相关信息。
my.getStorageInfoSync	同步获取当前 storage 的相关信息。

文件

名称	功能说明
my.saveFile	保存文件到本地（本地文件大小总容量限制：10 MB）。
my.getFileInfo	获取文件信息。
my.getSavedFileInfo	获取保存的文件信息。
my.getSavedFileList	获取保存的所有文件。
my.removeSavedFile	删除某个保存的文件。

位置

名称	功能说明
my.chooseLocation	使用内置地图选择地理位置。
my.getLocation	获取用户当前的地理位置信息。
my.openLocation	使用 mPaaS 小程序内置地图查看位置。

网络

名称	功能说明
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 关闭。

设备

canIUse

名称	功能说明
my.canIUse	判断当前小程序的 API、入参或返回值、组件、属性等在当前版本是否支持。

获取基础库版本号

名称	功能说明
my.SDKVersion	获取基础库版本号。 仅供参考，代码逻辑请不要依赖此值。

系统信息

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

网络状态

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

剪贴板

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

摇一摇

名称	功能说明
my.watchShake	调用摇一摇功能。每次调用 API，在摇一摇手机后触发回调，若需再次监听，则需再次调用此 API。

振动

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

加速度计

名称	功能说明
my.onAccelerometerChange	监听加速度数据。
my.offAccelerometerChange	停止监听加速度数据。

陀螺仪

名称	功能说明
my.onGyroscopeChange	监听陀螺仪数据变化事件。
my.offGyroscopeChange	停止监听陀螺仪数据。

罗盘

名称	功能说明
my.onCompassChange	监听罗盘数据。
my.offCompassChange	停止监听罗盘数据。

拨打电话

名称	功能说明
my.makePhoneCall	拨打电话。

用户截屏事件

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

屏幕亮度

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

添加手机联系人

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

扫码

名称	功能说明
my.scan	调用扫一扫功能。

蓝牙

名称	功能说明
my.openBluetoothAdapter	初始化小程序蓝牙模块。
my.closeBluetoothAdapter	关闭本机蓝牙模块。
my.getBluetoothAdapterState	获取本机蓝牙模块状态。
my.startBluetoothDevicesDiscovery	开始搜寻附近的蓝牙外围设备。
my.stopBluetoothDevicesDiscovery	停止搜寻附近的蓝牙外围设备。
my.getBluetoothDevices	获取所有已发现的蓝牙设备，包括已经和本机处于连接状态的蓝牙设备。
my.getConnectedBluetoothDevices	获取处于已连接状态的设备。
my.connectBLEDevice	连接低功耗蓝牙设备。
my.disconnectBLEDevice	断开与低功耗蓝牙设备的连接。
my.writeBLECharacteristicValue	向低功耗蓝牙设备特征值中写入数据。
my.readBLECharacteristicValue	读取低功耗蓝牙设备特征值中的数据。
my.notifyBLECharacteristicValueChange	启用低功耗蓝牙设备特征值变化时的通知（notify）功能。
my.getBLEDeviceServices	获取蓝牙设备所有服务（service）。
my.getBLEDeviceCharacteristics	获取蓝牙设备所有特征值（characteristic）。
my.onBluetoothDeviceFound	搜索到新的蓝牙设备时触发此事件。
my.offBluetoothDeviceFound	移除寻找到新的蓝牙设备事件的监听。
my.onBLECharacteristicValueChange	监听低功耗蓝牙设备的特征值变化的事件。
my.offBLECharacteristicValueChange	移除低功耗蓝牙设备的特征值变化事件的监听。
my.onBLEConnectionStateChanged	监听低功耗蓝牙连接的错误事件，包括设备丢失、连接异常断开等。
my.offBLEConnectionStateChanged	移除低功耗蓝牙连接状态变化事件的监听。
my.onBluetoothAdapterStateChange	监听本机蓝牙状态变化的事件。
my.offBluetoothAdapterStateChange	移除本机蓝牙状态变化的事件的监听。
错误码	蓝牙 API 错误码对照表。

数据安全

名称	功能说明
my.rsa	非对称加密。

分享

名称	功能说明
onShareAppMessage	在页面（Page）中定义 onShareAppMessage 函数，设置该页面的分享信息。
my.hideShareMenu	隐藏分享按钮。

小程序当前运行版本类型

名称	功能说明
my.getRunScene	获取当前小程序的运行版本。

自定义分析

名称	功能说明
my.reportAnalytics	自定义分析数据的上报接口。

小程序跳转

名称	功能说明
my.navigateToMiniProgram	跳转到其他小程序。
my.navigateBackMiniProgram	跳转回上一个小程序，只有当另一个小程序跳转到当前小程序时才会能调用成功。

webview 组件控制

名称	功能说明
my.createWebViewContext	创建并返回 web-view 上下文 webViewContext 对象。
webViewContext	webViewContext 通过 webviewId 跟一个 web-view 组件绑定，通过它可以实现一些功能。