微信小程序四 API

官方文档：https://developers.weixin.qq.com/miniprogram/dev/api/

基础

• wx.canIUse:判断小程序的API，回调，参数，组件等是否在当前版本可用。
• wx.base64ToArrayBuffer:将 Base64 字符串转成 ArrayBuffer 对象
• wx.arrayBufferToBase64:将 ArrayBuffer 对象转成 Base64 字符串

系统

• wx.getSystemInfoSync:获取系统信息
• wx.getSystemInfo(Object object):获取系统信息

更新

• wx.getUpdateManager:获取全局唯一的版本更新管理器，用于管理小程序更新。

生命周期

• wx.getLaunchOptionsSync:获取小程序启动时的参数。与 App.onLaunch 的回调参数一致。

应用级事件

• wx.onPageNotFound:监听小程序要打开的页面不存在事件。该事件与 App.onPageNotFound 的回调时机一致。
• wx.onError:监听小程序错误事件。如脚本错误或 API 调用报错等。该事件与 App.onError 的回调时机与参数一致。
• wx.onAudioInterruptionEnd:监听音频中断结束事件。在收到 onAudioInterruptionBegin 事件之后，小程序内所有音频会暂停，收到此事件之后才可再次播放成功
• wx.onAudioInterruptionBegin:监听音频因为受到系统占用而被中断开始事件。以下场景会触发此事件：闹钟、电话、FaceTime 通话、微信语音聊天、微信视频聊天。此事件触发后，小程序内所有音频会暂停。
• wx.onAppShow:监听小程序切前台事件。该事件与 App.onShow 的回调参数一致。
• wx.onAppHide:听小程序切后台事件。该事件与 App.onHide 的回调时机一致。
• wx.offPageNotFound:取消监听小程序要打开的页面不存在事件
• wx.offError:取消监听小程序错误事件。
• wx.offAudioInterruptionEnd:取消监听音频中断结束事件
• wx.offAudioInterruptionBegin:取消监听音频因为受到系统占用而被中断开始事件
• wx.offAppShow:取消监听小程序切前台事件
• wx.offAppHide:取消监听小程序切后台事件

调试

• wx.setEnableDebug:设置是否打开调试开关。此开关对正式版也能生效。
• wx.getRealtimeLogManager:获取实时日志管理器对象。
• wx.getLogManager:获取日志管理器对象。

路由

• wx.switchTab:跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
• wx.reLaunch:关闭所有页面，打开到应用内的某个页面
• wx.redirectTo:关闭当前页面，跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面。
• wx.navigateTo:保留当前页面，跳转到应用内的某个页面。但是不能跳到 tabbar 页面。使用 wx.navigateBack 可以返回到原页面。小程序中页面栈最多十层。
• wx.navigateBack:关闭当前页面，返回上一页面或多级页面。可通过 getCurrentPages 获取当前的页面栈，决定需要返回几层。
• EventChannel:页面间事件通信通道

界面交互

• wx.showToast:显示消息提示框
• wx.showModal:显示模态对话框
• wx.showLoading:显示 loading 提示框。需主动调用 wx.hideLoading 才能关闭提示框
• wx.showActionSheet:显示操作菜单
• wx.hideToast:隐藏消息提示框
• wx.hideLoading:隐藏 loading 提示框

界面导航栏

• wx.showNavigationBarLoading:在当前页面显示导航条加载动画
• wx.setNavigationBarTitle:动态设置当前页面的标题
• wx.setNavigationBarColor:设置页面导航条颜色
• wx.hideNavigationBarLoading:在当前页面隐藏导航条加载动画
• wx.hideHomeButton:隐藏返回首页按钮。

界面背景

• wx.setBackgroundTextStyle:动态设置下拉背景字体、loading 图的样式
• wx.setBackgroundColor:动态设置窗口的背景色

界面Tab Bar

• wx.showTabBarRedDot:显示 tabBar 某一项的右上角的红点
• wx.showTabBar:显示 tabBar
• wx.setTabBarStyle:动态设置 tabBar 的整体样式
• wx.setTabBarItem:动态设置 tabBar 某一项的内容，2.7.0 起图片支持临时文件和网络文件。
• wx.setTabBarBadge:为 tabBar 某一项的右上角添加文本
• wx.removeTabBarBadge:移除 tabBar 某一项右上角的文本
• wx.hideTabBarRedDot:隐藏 tabBar 某一项的右上角的红点
• wx.hideTabBar:隐藏 tabBar

界面字体

• wx.loadFontFace:动态加载网络字体。

界面下拉刷新

• wx.stopPullDownRefresh:停止当前页面下拉刷新。
• wx.startPullDownRefresh:开始下拉刷新。调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。

界面滚动

• wx.pageScrollTo:将页面滚动到目标位置，支持选择器和滚动距离两种方式定位

界面动画

• wx.createAnimation:创建一个动画实例 animation。调用实例的方法来描述动画。最后通过动画实例的 export 方法导出动画数据传递给组件的 animation 属性。
• Animation:动画对象

界面置顶

• wx.setTopBarText:动态设置置顶栏文字内容。只有当前小程序被置顶时能生效，如果当前小程序没有被置顶，也能调用成功，但是不会立即生效，只有在用户将这个小程序置顶后才换上设置的文字内容.

界面自定义组件

• wx.nextTick:延迟一部分操作到下一个时间片再执行。（类似于 setTimeout）

界面菜单

• wx.getMenuButtonBoundingClientRect:获取菜单按钮（右上角胶囊按钮）的布局位置信息。坐标信息以屏幕左上角为原点。

界面窗口

• wx.onWindowResize:监听窗口尺寸变化事件
• wx.offWindowResize:取消监听窗口尺寸变化事件

界面键盘

• wx.onKeyboardHeightChange:监听键盘高度变化
• wx.hideKeyboard:在input、textarea等focus拉起键盘之后，手动调用此接口收起键盘
• wx.getSelectedTextRange:在input、textarea等focus之后，获取输入框的光标位置。注意：只有在focus的时候调用此接口才有效。