微信小程序常用API（总结分享）

本篇文章给大家带来了关于微信小程序的相关知识，其中主要总结了一些常用的api，下面一起来看一下，希望对大家有帮助。

一、 系统常用api

1. wx.openAppAuthorizeSetting(Object object) 跳转系统微信授权管理页

参数
1）success  接口调用成功的回调函数
2）fail  接口调用失败的回调函数
3）complete  接口调用结束的回调函数（调用成功、失败都会执行）

2. wx.getWindowInfo() 获取窗口信息

参数
1）pixelRatio	设备像素比
2）screenWidth	屏幕宽度，单位px
3）screenHeight	屏幕高度，单位px
4）windowWidth	可使用窗口宽度，单位px
5）windowHeight 可使用窗口高度，单位px
6）statusBarHeight	状态栏的高度，单位px
7）safeArea	在竖屏正方向下的安全区域
	left	安全区域左上角横坐标
	right	安全区域右下角横坐标
	top	安全区域左上角纵坐标
	bottom	安全区域右下角纵坐标
	width	安全区域的宽度，单位逻辑像素
	height	安全区域的高度，单位逻辑像素
8）screenTop	窗口上边缘的 y 值.

3. wx.getSystemInfoAsync(Object object) 异步获取系统信息。需要一定的微信客户端版本支持，在不支持的客户端上，会使用同步实现来返回。

参数
1）success  接口调用成功的回调函数
2）fail  接口调用失败的回调函数
3）complete  接口调用结束的回调函数（调用成功、	失败都会执行）

4. wx.getAppAuthorizeSetting() 获取微信 APP 授权设置

albumAuthorized	允许微信使用相册的开关（仅 iOS 有效）
bluetoothAuthorized	允许微信使用蓝牙的开关（仅 iOS 有效）
cameraAuthorized 允许微信使用摄像头的开关
locationAuthorized	允许微信使用定位的开关
locationReducedAccuracy	定位准确度。true 表示模糊定位，false 表示精确定位（仅 iOS 有效）
microphoneAuthorized 允许微信使用麦克风的开关
notificationAuthorized 允许微信通知的开关
notificationAlertAuthorized	允许微信通知带有提醒的开关（仅 iOS 有效）
notificationBadgeAuthorized	允许微信通知带有标记的开关（仅 iOS 有效）
notificationSoundAuthorized	允许微信通知带有声音的开关（仅 iOS 有效）
phoneCalendarAuthorized	允许微信读写日历的开关

二、小程序常用api

小程序常用生命周期

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

• wx.getEnterOptionsSync 获取本次小程序启动时的参数。如果当前是冷启动，则返回值与 App.onLaunch 的回调参数一致；如果当前是热启动，则返回值与 App.onShow 一致。

• wx.onUnhandledRejection(function listener) 监听未处理的 Promise 拒绝事件。该事件与 App.onUnhandledRejection 的回调时机与参数一致。

• wx.onThemeChange(function listener) 监听系统主题改变事件。该事件与 App.onThemeChange 的回调时机一致。

• wx.onPageNotFound(function listener) 监听小程序要打开的页面不存在事件。该事件与 App.onPageNotFound 的回调时机一致。

• wx.onLazyLoadError(function listener) 监听小程序异步组件加载失败事件。

• wx.onError(function listener) 监听小程序错误事件。如脚本错误或 API 调用报错等。该事件与 App.onError 的回调时机与参数一致。

• wx.onAudioInterruptionEnd(function listener) 监听音频中断结束事件。在收到 onAudioInterruptionBegin 事件之后，小程序内所有音频会暂停，收到此事件之后才可再次播放成功

• wx.onAppShow(function listener) 监听小程序切前台事件。该事件与 App.onShow 的回调参数一致。

• wx.onAppHide(function listener) 监听小程序切后台事件。该事件与 App.onHide 的回调时机一致。

三、路由跳转api

• wx.switchTab(Object object) 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面

• wx.reLaunch(Object object) 关闭所有页面，打开到应用内的某个页面

• wx.redirectTo(Object object) 关闭当前页面，跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面。

• wx.navigateTo(Object object) 保留当前页面，跳转到应用内的某个页面。但是不能跳到 tabbar 页面。使用 wx.navigateBack 可以返回到原页面。小程序中页面栈最多十层。

• wx.navigateBack(Object object) 关闭当前页面，返回上一页面或多级页面。可通过 getCurrentPages 获取当前的页面栈，决定需要返回几层。

• wx.exitMiniProgram(Object object) 退出当前小程序。必须有点击行为才能调用成功。

四、转发api

• wx.updateShareMenu(Object object) 更新转发属性

• wx.showShareMenu(Object object) 显示当前页面的转发按钮

• wx.showShareImageMenu(Object object) 打开分享图片弹窗，可以将图片发送给朋友、收藏或下载

• wx.shareVideoMessage(Object object) 转发视频到聊天

• wx.shareFileMessage(Object object) 转发文件到聊天

五、页面交互

• wx.showToast(Object object) 显示消息提示框

• wx.showModal(Object object) 显示模态对话框

• wx.showLoading(Object object) 显示 loading 提示框。需主动调用 wx.hideLoading 才能关闭提示框

• wx.showActionSheet(Object object) 显示操作菜单

• wx.hideToast(Object object) 隐藏消息提示框

• wx.hideLoading(Object object) 隐藏 loading 提示框

• wx.enableAlertBeforeUnload(Object object) 开启小程序页面返回询问对话框。

• wx.disableAlertBeforeUnload(Object object) 关闭小程序页面返回询问对话框。