API(总结共享)常用于微信小程序-小程序开发

首页 2024-06-26 15:29:10

这篇文章给大家带来了微信小程序的相关知识,主要总结了一些常用的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 它可以返回到原始页面。页面堆栈最多10层。

  • 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) 关闭小程序页面,返回查询对话框。

【相关学习推荐:小程序学习教程】

以上是微信小程序常用API(总结分享)的详细内容,请关注其他相关文章!