| 分类 |
API 名称 |
功能说明 |
| 基础 |
getSystemInfoSync |
getSystemInfo 的同步版本 |
| 系统 |
getSystemInfoSync |
getSystemInfo 的同步版本 |
| getSystemInfo |
获取系统信息 |
| 更新 |
getUpdateManager |
获取全局唯一的版本更新管理器，用于管理小程序更新 |
| 生命周期 |
getLaunchOptionsSync |
获取小程序启动时的参数 |
| 应用级事件 |
onPageNotFound |
监听小程序要打开的页面不存在事件 的同步版本 |
| onError |
监听小程序错误事件 |
| onAppShow |
监听小程序切前台事件 |
| onAppHide |
监听小程序切后台事件 |
| offPageNotFound |
移除小程序要打开的页面不存在事件的监听函数 |
| offError |
移除小程序错误事件的监听函数 |
| offAppShow |
移除小程序切前台事件的监听函数 |
| offAppHide |
移除小程序切后台事件的监听函数 |
| 路由 |
switchTab |
跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面 |
| reLaunch |
关闭所有页面，打开到应用内的某个页面 |
| redirectTo |
关闭当前页面，跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面。 |
| navigateTo |
保留当前页面，跳转到应用内的某个页面 |
| navigateBack |
关闭当前页面，返回上一页面或多级页面 |
| 跳转 |
navigateToMiniProgram |
打开另一个小程序 |
| navigateBackMiniProgram |
返回到上一个小程序 |
| exitMiniProgram |
退出当前小程序 |
| 交互 |
showToast |
显示消息提示框 |
| showModal |
显示模态对话框 |
| showLoading |
显示 loading 提示框 |
| showActionSheet |
显示操作菜单 |
| hideToast |
隐藏消息提示框 |
| hideLoading |
隐藏 loading 提示框 |
| 导航栏 |
showNavigationBarLoading |
在当前页面显示导航条加载动画 |
| setNavigationBarTitle |
动态设置当前页面的标题 |
| setNavigationBarColor |
设置页面导航条颜色 |
| hideNavigationBarLoading |
在当前页面隐藏导航条加载动画 |
| hideHomeButton |
隐藏返回首页按钮 |
| Tab Bar |
showTabBarRedDot |
显示 tabBar 某一项的右上角的红点 |
| showTabBar |
显示 tabBar |
| setTabBarStyle |
动态设置 tabBar 的整体样式 |
| setTabBarItem |
动态设置 tabBar 某一项的内容 |
| setTabBarBadge |
为 tabBar 某一项的右上角添加文本 |
| removeTabBarBadge |
tabBar 某一项右上角的文本 |
| hideTabBarRedDot |
隐藏 tabBar 某一项的右上角的红点 |
| hideTabBar |
隐藏 tabBar |
| 下拉刷新 |
stopPullDownRefresh |
停止当前页面下拉刷新。 |
| 菜单 |
getMenuButtonBoundingClientRect |
获取菜单按钮（右上角胶囊按钮）的布局位置信息 |
| 发起请求 |
request |
发起 HTTPS 网络请求 |
| 下载 |
downloadFile |
下载文件资源到本地 |
| 上传 |
uploadFile |
将本地资源上传到服务器 |
| 数据缓存 |
setStorageSync |
将数据存储在本地缓存中指定的 key 中 |
| setStorage |
将数据存储在本地缓存中指定的 key 中 |
| removeStorageSync |
removeStorage 的同步版本 |
| removeStorage |
从本地缓存中移除指定 key |
| getStorageSync |
从本地缓存中同步获取指定 key 的内容 |
| getStorageInfoSync |
getStorageInfo 的同步版本 |
| getStorageInfo |
异步获取当前storage的相关信息 |
| getStorage |
从本地缓存中异步获取指定 key 的内容。 |
| clearStorageSync |
clearStorage 的同步版本 |
| clearStorage |
清理本地数据缓存 |
| 图片 |
saveImageToPhotosAlbum |
保存图片到系统相册 |
| previewImage |
在新页面中全屏预览图片 key 中 |
| getImageInfo |
获取图片信息 |
| chooseImage |
从本地相册选择图片或使用相机拍照 |
| chooseVideo |
拍摄视频或从手机相册中选视频 |
| 音频 |
stopVoice |
结束播放语音 |
| playVoice |
开始播放语音 |
| pauseVoice |
暂停正在播放的语音 |
| 背景音频 |
stopBackgroundAudio |
停止播放音乐 |
| seekBackgroundAudio |
控制音乐播放进度 |
| playBackgroundAudio |
使用后台播放器播放音乐 |
| pauseBackgroundAudio |
暂停播放音乐 |
| onBackgroundAudioStop |
监听音乐停止事件 |
| onBackgroundAudioPlay |
监听音乐播放事件 |
| onBackgroundAudioPause |
监听音乐暂停事件 |
| getBackgroundAudioPlayerState |
获取后台音乐播放状态 |
| getBackgroundAudioManager |
获取全局唯一的背景音频管理器 |
| 录音 |
startRecord |
开始录音 |
| stopRecord |
停止录音 |
| 相机 |
createCameraContext |
创建 camera 上下文 CameraContext 对象 |
| CameraContext.stopRecord |
结束录像 |
| CameraContext.takePhoto |
拍摄照片 |
| 位置 |
stopLocationUpdate |
关闭监听实时位置变化，前后台都停止消息接收 |
| startLocationUpdateBackground |
开启小程序在前后台时均可接收位置消息 |
| startLocationUpdate |
开启小程序进入前台时接收位置消息 |
| onLocationChange |
监听实时地理位置变化事件 |
| offLocationChange |
移除实时地理位置变化事件的监听函数 |
| getLocation |
获取当前的地理位置、速度 |
| 文件 |
saveFile |
保存文件 |
| openDocument |
打开文件 |
| getSavedFileList |
获取该小程序下已保存的本地缓存文件列表 |
| getSavedFileInfo |
获取该小程序下的 本地临时文件 或 本地缓存文件 信息 |
| getFileSystemManager |
文件管理器 |
| getFileInfo |
获取该小程序下的 本地临时文件 或 本地缓存文件 信息 |
| FileSystemManager.removeSavedFile |
删除该小程序下已保存的本地缓存文件 |
| 登录 |
login |
调用接口获取登录凭证（code） |
| checkSession |
检查登录态是否过期 |
| 授权 |
authorize |
提前向用户发起授权请求 |
| 设置 |
openSetting |
调起客户端小程序设置界面，返回用户设置的操作结果 |
| getSetting |
获取用户的当前设置 |
| 剪贴板 |
setClipboardData |
设置系统剪贴板的内容 |
| getClipboardData |
获取系统剪贴板的内容 |
| 网络 |
onNetworkStatusChange |
监听网络状态变化事件 |
| offNetworkStatusChange |
移除网络状态变化事件的监听函数 |
| getNetworkType |
获取网络类型 |
| 屏幕 |
setScreenBrightness |
设置屏幕亮度 |
| setKeepScreenOn |
设置是否保持常亮状态 |
| onUserCaptureScreen |
监听用户主动截屏事件 |
| getScreenBrightness |
获取屏幕亮度 |
| 键盘 |
hideKeyboard |
在input、textarea等focus拉起键盘之后，手动调用此接口收起键盘 |
| 电话 |
makePhoneCall |
拨打电话 |
| 扫码 |
scanCode |
调起客户端扫码界面进行扫码 |
| 振动 |
vibrateShort |
使手机发生较短时间的振动 |
| vibrateLong |
使手机发生较长时间的振动 |