- 开发无止境 -
Data: 2017-10-01 08:23:06Form: JournalClick: 13
API
API
API
,可以方便的调起微信提供的能力,如获取用户信息,本地存储,支付功能等API
按照功能主要分为几大类:网络、媒体、文件、数据缓存、位置、设备、界面、界面节点信息还有一些特殊的开放接口API
导读API
现有256个一级分类 | 二级分类 | API | 描述 |
基础 | wx.canIUse | 判断小程序的API,回调,参数,组件等是否在当前版本可用 | |
wx.base64ToArrayBuffer | 将 Base64 字符串转成 ArrayBuffer 对象 | ||
wx.arrayBufferToBase64 | 将 ArrayBuffer 对象转成 Base64 字符串 | ||
系统 | wx.getSystemInfo | 获取系统信息 | |
wx.getSystemInfoSync | wx.getSystemInfo 的同步版本 | ||
更新 | wx.getUpdateManager | 获取全局唯一的版本更新管理器,用于管理小程序更新 | |
小程序-生命周期 | wx.getLaunchOptionsSync | 获取小程序启动时的参数 | |
小程序-应用级事件 | wx.onPageNotFound | 监听小程序要打开的页面不存在事件 | |
wx.onError | 监听小程序错误事件。如脚本错误或 API 调用报错等 | ||
wx.onAudioInterruptionEnd | 监听音频中断结束事件 | ||
wx.onAudioInterruptionBegin | 监听音频因为受到系统占用而被中断开始事件 | ||
wx.onAppShow | 监听小程序切前台事件 | ||
wx.onAppHide | 监听小程序切后台事件 | ||
wx.offPageNotFound | 取消监听小程序要打开的页面不存在事件 | ||
wx.offError | 取消监听小程序错误事件 | ||
wx.offAudioInterruptionEnd | 取消监听音频中断结束事件 | ||
wx.offAudioInterruptionBegin | 取消监听音频因为受到系统占用而被中断开始事件 | ||
wx.offAppShow | 取消监听小程序切前台事件 | ||
wx.offAppHide | 取消监听小程序切后台事件 | ||
调试 | wx.setEnableDebug | 设置是否打开调试开关。此开关对正式版也能生效 | |
wx.getLogManager | 获取日志管理器对象 | ||
console | 向调试面板中打印日志 | ||
LogManager | 日志管理器实例 | ||
定时器 | setInterval | 设定一个定时器 | |
clearInterval | 取消由 setInterval 设置的定时器 | ||
setTimeout | 设定一个定时器 | ||
clearTimeout | 取消由 setTimeout 设置的定时器 | ||
路由 | wx.switchTab | 跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面 | |
wx.reLaunch | 关闭所有页面,打开到应用内的某个页面 | ||
wx.redirectTo | 关闭当前页面,跳转到应用内的某个页面。但是不允许跳转到 tabbar 页面 | ||
wx.navigateTo | 保留当前页面,跳转到应用内的某个页面。但是不能跳到 tabbar 页面 | ||
wx.navigateBack | 关闭当前页面,返回上一页面或多级页面 | ||
界面 | 交互 | wx.showToast | 显示消息提示框 |
wx.hideToast | 隐藏消息提示框 | ||
wx.showModal | 显示模态对话框 | ||
wx.showLoading | 显示 loading 提示框 | ||
wx.hideLoading | 隐藏 loading 提示框 | ||
wx.hideLoading | 隐藏 loading 提示框 | ||
导航栏 | wx.showNavigationBarLoading | 在当前页面显示导航条加载动画 | |
wx.setNavigationBarTitle | 动态设置当前页面的标题 | ||
wx.setNavigationBarColor | 设置页面导航条颜色 | ||
wx.hideNavigationBarLoading | 在当前页面隐藏导航条加载动画 | ||
wx.hideHomeButton | 隐藏返回首页按钮 | ||
背景 | wx.setBackgroundTextStyle | 动态设置下拉背景字体、loading 图的样式 | |
wx.setBackgroundColor | 动态设置窗口的背景色 | ||
Tab Bar | wx.showTabBarRedDot | 显示 tabBar 某一项的右上角的红点 | |
wx.hideTabBarRedDot | 隐藏 tabBar 某一项的右上角的红点 | ||
wx.showTabBar | 显示 tabBar | ||
wx.hideTabBar | 隐藏 tabBar | ||
wx.setTabBarStyle | 动态设置 tabBar 的整体样式 | ||
wx.setTabBarItem | 动态设置 tabBar 某一项的内容 | ||
wx.setTabBarBadge | 为 tabBar 某一项的右上角添加文本 | ||
wx.removeTabBarBadge | 移除 tabBar 某一项右上角的文本 | ||
字体 | wx.loadFontFace | 动态加载网络字体。文件地址需为下载类型。iOS 仅支持 https 格式文件地址 | |
下拉刷新 | wx.stopPullDownRefresh | 停止当前页面下拉刷新 | |
wx.startPullDownRefresh | 开始下拉刷新。调用后触发下拉刷新动画,效果与用户手动下拉刷新一致 | ||
滚动 | wx.pageScrollTo | 将页面滚动到目标位置,支持选择器和滚动距离两种方式定位 | |
动画 | wx.createAnimation | 创建一个动画实例 animation。调用实例的方法来描述动画 | |
置顶 | wx.setTopBarText | 动态设置置顶栏文字内容 | |
自定义组件 | wx.nextTick | 延迟一部分操作到下一个时间片再执行 | |
菜单 | wx.getMenuButtonBoundingClientRect | 获取菜单按钮(右上角胶囊按钮)的布局位置信息。坐标信息以屏幕左上角为原点 | |
窗口 | wx.onWindowResize | 监听窗口尺寸变化事件 | |
wx.offWindowResize | 取消监听窗口尺寸变化事件 | ||
键盘 | wx.onWindowResize | 监听键盘高度变化 | |
wx.getSelectedTextRange | 在input、textarea等focus之后,获取输入框的光标位置 | ||
网络 | 发送请求 | wx.request | 发起 HTTPS 网络请求 |
下载 | wx.downloadFile | 下载文件资源到本地 | |
上传 | wx.uploadFile | 将本地资源上传到服务器 | |
WebSocket | wx.sendSocketMessage | 通过 WebSocket 连接发送数据 | |
wx.onSocketOpen | 监听 WebSocket 连接打开事件 | ||
wx.onSocketMessage | 监听 WebSocket 接受到服务器的消息事件 | ||
wx.onSocketError | 监听 WebSocket 错误事件 | ||
wx.onSocketClose | 监听 WebSocket 连接关闭事件 | ||
wx.connectSocket | 创建一个 WebSocket 连接 | ||
wx.closeSocket | 关闭 WebSocket 连接 | ||
mDNS | wx.stopLocalServiceDiscovery | 停止搜索 mDNS 服务 | |
wx.startLocalServiceDiscovery | 开始搜索局域网下的 mDNS 服务 | ||
wx.onLocalServiceResolveFail | 监听 mDNS 服务解析失败的事件 | ||
wx.onLocalServiceLost | 监听 mDNS 服务离开的事件 | ||
wx.onLocalServiceFound | 监听 mDNS 服务发现的事件 | ||
wx.onLocalServiceDiscoveryStop | 监听 mDNS 服务停止搜索的事件 | ||
wx.offLocalServiceResolveFail | 取消监听 mDNS 服务解析失败的事件 | ||
wx.offLocalServiceLost | 取消监听 mDNS 服务离开的事件 | ||
wx.offLocalServiceFound | 取消监听 mDNS 服务发现的事件 | ||
wx.offLocalServiceDiscoveryStop | 取消监听 mDNS 服务停止搜索的事件 | ||
UDP 通讯 | wx.createUDPSocket | 创建一个 UDP Socket 实例 | |
数据缓存 | wx.setStorage | 将数据存储在本地缓存中指定的 key 中 | |
wx.setStorageSync | wx.setStorage 的同步版本 | ||
wx.removeStorage | 从本地缓存中移除指定 key | ||
wx.removeStorageSync | wx.removeStorage 的同步版本 | ||
wx.getStorage | 从本地缓存中异步获取指定 key 的内容 | ||
wx.getStorageSync | wx.getStorage 的同步版本 | ||
wx.getStorageInfo | 异步获取当前storage的相关信息 | ||
wx.getStorageInfoSync | wx.getStorageInfo 的同步版本 | ||
wx.clearStorage | 清理本地数据缓存 | ||
wx.clearStorageSync | wx.clearStorage 的同步版本 | ||
媒体 | 地图 | wx.createMapContext | 创建 map 上下文 MapContext 对象 |
图片 | wx.saveImageToPhotosAlbum | 保存图片到系统相册 | |
wx.previewImage | 在新页面中全屏预览图片 | ||
wx.getImageInfo | 获取图片信息 | ||
wx.compressImage | 压缩图片接口,可选压缩质量 | ||
wx.chooseMessageFile | 从客户端会话选择文件 | ||
wx.chooseImage | 从本地相册选择图片或使用相机拍照 | ||
视频 | wx.saveVideoToPhotosAlbum | 保存视频到系统相册 | |
wx.createVideoContext | 创建 video 上下文 VideoContext 对象 | ||
wx.chooseVideo | 拍摄视频或从手机相册中选视频 | ||
wx.chooseMedia | 拍摄或从手机相册中选择图片或视频 | ||
音频 | wx.stopVoice | 结束播放语音 | |
wx.setInnerAudioOption | 设置 InnerAudioContext 的播放选项 | ||
wx.playVoice | 开始播放语音 | ||
wx.pauseVoice | 暂停正在播放的语音 | ||
wx.getAvailableAudioSources | 获取当前支持的音频输入源 | ||
wx.createInnerAudioContext | 创建内部 audio 上下文 InnerAudioContext 对象 | ||
wx.createAudioContext | 创建 audio 上下文 AudioContext 对象 | ||
背景音频 | wx.stopBackgroundAudio | 停止播放音乐 | |
wx.seekBackgroundAudio | 控制音乐播放进度 | ||
wx.playBackgroundAudio | 使用后台播放器播放音乐 | ||
wx.pauseBackgroundAudio | 暂停播放音乐 | ||
wx.onBackgroundAudioStop | 监听音乐停止事件 | ||
wx.onBackgroundAudioPlay | 监听音乐播放事件 | ||
wx.onBackgroundAudioPause | 监听音乐暂停事件 | ||
wx.getBackgroundAudioPlayerState | 获取后台音乐播放状态 | ||
wx.getBackgroundAudioManager | 获取全局唯一的背景音频管理器 | ||
实时音视频 | wx.createLivePusherContext | 创建 live-pusher 上下文 LivePusherContext 对象 | |
wx.createLivePlayerContext | 创建 live-player 上下文 LivePlayerContext 对象 | ||
录音 | wx.stopRecord | 停止录音 | |
wx.startRecord | 开始录音 | ||
wx.getRecorderManager | 获取全局唯一的录音管理器 RecorderManager | ||
相机 | wx.createCameraContext | 创建 camera 上下文 CameraContext 对象 | |
音视频合成 | wx.createMediaContainer | 创建音视频处理容器,最终可将容器中的轨道合成一个视频 | |
位置 | wx.stopLocationUpdate | 关闭监听实时位置变化,前后台都停止消息接收 | |
wx.startLocationUpdateBackground | 开启小程序进入前后台时均接收位置消息,需引导用户开启授权 | ||
wx.startLocationUpdate | 开启小程序进入前台时接收位置消息 | ||
wx.openLocation | 使用微信内置地图查看位置 | ||
wx.onLocationChange | 监听实时地理位置变化事件 | ||
wx.offLocationChange | 取消监听实时地理位置变化事件 | ||
wx.getLocation | 获取当前的地理位置、速度。当用户离开小程序后,此接口无法调用 | ||
wx.chooseLocation | 打开地图选择位置 | ||
转发 | wx.updateShareMenu | 更新转发属性 | |
wx.showShareMenu | 显示当前页面的转发按钮 | ||
wx.hideShareMenu | 隐藏转发按钮 | ||
wx.getShareInfo | 获取转发详细信息 | ||
画布 | wx.createOffscreenCanvas | 创建离屏 canvas 实例 | |
wx.createCanvasContext | 创建 canvas 的绘图上下文 CanvasContext 对象 | ||
wx.canvasToTempFilePath | 把当前画布指定区域的内容导出生成指定大小的图片 | ||
wx.canvasPutImageData | 将像素数据绘制到画布 | ||
wx.canvasGetImageData | 获取 canvas 区域隐含的像素数据 | ||
文件 | wx.saveFile | 保存文件到本地 | |
wx.removeSavedFile | 删除本地缓存文件 | ||
wx.openDocument | 新开页面打开文档 | ||
wx.getSavedFileList | 获取该小程序下已保存的本地缓存文件列表 | ||
wx.getSavedFileInfo | 获取本地文件的文件信息 | ||
wx.getFileSystemManager | 获取全局唯一的文件管理器 | ||
wx.getFileInfo | 获取文件信息 | ||
开发接口 | 登陆 | wx.login | 调用接口获取登录凭证(code) |
wx.checkSession | 检查登录态是否过期 | ||
小程序跳转 | wx.navigateToMiniProgram | 打开另一个小程序 | |
wx.navigateBackMiniProgram | 返回到上一个小程序 | ||
账户信息 | wx.getAccountInfoSync | 返回到上一个小程序 | |
用户信息 | wx.getUserInfo | 获取用户信息 | |
数据上报 | wx.reportMonitor | 自定义业务数据监控上报接口 | |
数据分析 | wx.reportAnalytics | 自定义分析数据上报接口 | |
支付 | wx.requestPayment | 发起微信支付 | |
授权 | wx.authorize | 提前向用户发起授权请求 | |
设置 | wx.openSetting | 调起客户端小程序设置界面,返回用户设置的操作结果 | |
wx.getSetting | 获取用户的当前设置 | ||
收货地址 | wx.chooseAddress | 获取用户收货地址 | |
卡券 | wx.openCard | 查看微信卡包中的卡券 | |
wx.addCard | 批量添加卡券 | ||
发票 | wx.chooseInvoiceTitle | 选择用户的发票抬头 | |
wx.chooseInvoice | 选择用户已有的发票 | ||
生物认证 | wx.startSoterAuthentication | 开始 SOTER 生物认证 | |
wx.checkIsSupportSoterAuthentication | 获取本机支持的 SOTER 生物认证方式 | ||
wx.checkIsSoterEnrolledInDevice | 获取设备内是否录入如指纹等生物信息的接口 | ||
微信运动 | wx.getWeRunData | 获取用户过去三十天微信运动步数 | |
性能 | wx.reportPerformance | 自定义性能监控上报。使用前,需要在小程序管理后台配置 | |
订阅消息 | wx.requestSubscribeMessage | 起客户端小程序订阅消息界面,返回用户订阅消息的操作结果 | |
微信红包 | wx.showRedPackage | 拉取h5领取红包封面页 | |
设备 | iBeacon | wx.stopBeaconDiscovery | 停止搜索附近的 iBeacon 设备 |
wx.startBeaconDiscovery | 开始搜索附近的 iBeacon 设备 | ||
wx.onBeaconUpdate | 监听 iBeacon 设备更新事件,仅能注册一个监听 | ||
wx.onBeaconServiceChange | 监听 iBeacon 服务状态变化事件,仅能注册一个监听 | ||
wx.offBeaconUpdate | 取消监听 iBeacon 设备更新事件 | ||
wx.offBeaconServiceChange | 取消监听 iBeacon 服务状态变化事件 | ||
wx.getBeacons | 获取所有已搜索到的 iBeacon 设备 | ||
Wi-Fi | wx.stopWifi | 关闭 Wi-Fi 模块 | |
wx.startWifi | 初始化 Wi-Fi 模块 | ||
wx.setWifiList | 设置 wifiList 中 AP 的相关信息 | ||
wx.onWifiConnected | 监听连接上 Wi-Fi 的事件 | ||
wx.onGetWifiList | 监听获取到 Wi-Fi 列表数据事件 | ||
wx.offWifiConnected | 取消监听连接上 Wi-Fi 的事件 | ||
wx.offGetWifiList | 取消监听获取到 Wi-Fi 列表数据事件 | ||
wx.getWifiList | 请求获取 Wi-Fi 列表 | ||
wx.getConnectedWifi | 获取已连接中的 Wi-Fi 信息 | ||
wx.connectWifi | 连接 Wi-Fi | ||
联系人 | wx.addPhoneContact | 添加手机通讯录联系人 | |
低功耗蓝牙 | wx.writeBLECharacteristicValue | 向低功耗蓝牙设备特征值中写入二进制数据 | |
wx.readBLECharacteristicValue | 读取低功耗蓝牙设备的特征值的二进制数据值 | ||
wx.onBLEConnectionStateChange | 监听低功耗蓝牙连接状态的改变事件 | ||
wx.onBLECharacteristicValueChange | 监听低功耗蓝牙设备的特征值变化事件 | ||
wx.offBLEConnectionStateChange | 取消监听低功耗蓝牙连接状态的改变事件 | ||
wx.offBLECharacteristicValueChange | 取消监听低功耗蓝牙设备的特征值变化事件 | ||
wx.notifyBLECharacteristicValueChange | 启用低功耗蓝牙设备特征值变化时的 notify 功能,订阅特征值 | ||
wx.getBLEDeviceServices | 获取蓝牙设备所有服务(service) | ||
wx.getBLEDeviceCharacteristics | 获取蓝牙设备某个服务中所有特征值(characteristic) | ||
wx.createBLEConnection | 连接低功耗蓝牙设备 | ||
wx.closeBLEConnection | 断开与低功耗蓝牙设备的连接 | ||
蓝牙 | wx.stopBluetoothDevicesDiscovery | 停止搜寻附近的蓝牙外围设备 | |
wx.startBluetoothDevicesDiscovery | 开始搜寻附近的蓝牙外围设备 | ||
wx.openBluetoothAdapter | 初始化蓝牙模块 | ||
wx.onBluetoothDeviceFound | 监听寻找到新设备的事件 | ||
wx.onBluetoothAdapterStateChange | 监听蓝牙适配器状态变化事件 | ||
wx.offBluetoothDeviceFound | 取消监听寻找到新设备的事件 | ||
wx.offBluetoothAdapterStateChange | 取消监听蓝牙适配器状态变化事件 | ||
wx.getConnectedBluetoothDevices | 根据 uuid 获取处于已连接状态的设备 | ||
wx.getBluetoothDevices | 获取在蓝牙模块生效期间所有已发现的蓝牙设备 | ||
wx.getBluetoothAdapterState | 获取本机蓝牙适配器状态 | ||
wx.closeBluetoothAdapter | 关闭蓝牙模块 | ||
电量 | wx.getBatteryInfoSync | 获取设备电量,同步版本 | |
wx.getBatteryInfo | 获取设备电量 | ||
剪贴板 | wx.setClipboardData | 设置系统剪贴板的内容 | |
wx.getClipboardData | 获取系统剪贴板的内容 | ||
NFC | wx.stopHCE | 关闭 NFC 模块。仅在安卓系统下有效 | |
wx.startHCE | 获取系统剪贴板的内容 | ||
wx.sendHCEMessage | 发送 NFC 消息。仅在安卓系统下有效 | ||
wx.onHCEMessage | 监听接收 NFC 设备消息事件,仅能注册一个监听 | ||
wx.offHCEMessage | 接收 NFC 设备消息事件,取消事件监听 | ||
wx.getHCEState | 判断当前设备是否支持 HCE 能力 | ||
网络 | wx.onNetworkStatusChange | 监听网络状态变化事件 | |
wx.offNetworkStatusChange | 取消监听网络状态变化事件,参数为空,则取消所有的事件监听 | ||
wx.getNetworkType | 获取网络类型 | ||
屏幕 | wx.setScreenBrightness | 设置屏幕亮度 | |
wx.setKeepScreenOn | 设置是否保持常亮状态。仅在当前小程序生效,离开小程序后设置失效 | ||
wx.onUserCaptureScreen | 监听用户主动截屏事件 | ||
wx.offUserCaptureScreen | 用户主动截屏事件。取消事件监听。 | ||
wx.getScreenBrightness | 获取屏幕亮度 | ||
电话 | wx.makePhoneCall | 拨打电话 | |
加速针 | wx.stopAccelerometer | 停止监听加速度数据 | |
wx.startAccelerometer | 开始监听加速度数据 | ||
wx.onAccelerometerChange | 监听加速度数据事件 | ||
wx.offAccelerometerChange | 取消监听加速度数据事件,参数为空,则取消所有的事件监听 | ||
罗盘 | wx.stopCompass | 停止监听罗盘数据 | |
wx.startCompass | 开始监听罗盘数据 | ||
wx.onCompassChange | 监听罗盘数据变化事件 | ||
wx.offCompassChange | 取消监听罗盘数据变化事件,参数为空,则取消所有的事件监听 | ||
设备方向 | wx.stopDeviceMotionListening | 停止监听设备方向的变化 | |
wx.startDeviceMotionListening | 开始监听设备方向的变化 | ||
wx.onDeviceMotionChange | 监听设备方向变化事件 | ||
wx.offDeviceMotionChange | 取消监听设备方向变化事件,参数为空,则取消所有的事件监听 | ||
陀螺仪 | wx.stopGyroscope | 停止监听陀螺仪数据 | |
wx.startGyroscope | 开始监听陀螺仪数据 | ||
wx.onGyroscopeChange | 监听陀螺仪数据变化事件 | ||
wx.offGyroscopeChange | 取消监听陀螺仪数据变化事件 | ||
性能 | wx.onMemoryWarning | 监听内存不足告警事件 | |
wx.offMemoryWarning | 取消监听内存不足告警事件 | ||
扫码 | wx.scanCode | 调起客户端扫码界面进行扫码 | |
振动 | wx.vibrateShort | 使手机发生较短时间的振动(15 ms) | |
wx.vibrateLong | 使手机发生较长时间的振动(400 ms) | ||
Worker | wx.createWorker | 创建一个 Worker 线程 | |
第三方平台 | wx.getExtConfigSync | 获取第三方平台自定义的数据字段,同步版本 | |
wx.getExtConfig | 获取第三方平台自定义的数据字段 | ||
WXML | wx.createSelectorQuery | 返回一个 SelectorQuery 对象实例 | |
wx.createIntersectionObserver | 创建并返回一个 IntersectionObserver 对象实例 | ||
广告 | wx.createRewardedVideoAd | 创建激励视频广告组件 | |
wx.createInterstitialAd | 创建插屏广告组件 |
API
API
on
开头的 API
用来监听某个事件是否触发API
接受一个回调函数作为参数,当事件触发时会调用这个回调函数,并将相关数据以参数形式传入wx.onAppShow 监听小程序切前台事件 wx.onAppHide 监听小程序切后台事件
Page({
onLoad:function(options){
wx.onAppShow(function(){
console.log('切换前台');
})
wx.onAppHide(function(){
console.log('切换后台');
})
}
})
API
Sync
结尾的 API
都是同步 API
wx.getSystemInfoSync 获取系统信息
Page({
onLoad: function (options) {
console.log(wx.getSystemInfoSync());
var sync = wx.getSystemInfoSync();
console.log(sync.model);
}
})
API
编号 | 参数名 | 类型 | 必填 | 说明 |
---|---|---|---|---|
1 | success | function | 否 | 接口调用成功的回调函数 |
2 | fail | function | 否 | 接口调用失败的回调函数 |
3 | complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
4 | 其他 | Any | - | 接口定义的其他参数 |
wx.getSystemInfo 获取系统信息
编号 | 属性 | 类型 | 说明 |
---|---|---|---|
1 | errMsg | string | 错误信息,如果调用成功返回 ${apiName}:ok |
2 | errCode | number | 错误码,仅部分 API 支持,具体含义请参考对应 API 文档,成功时为 0。 |
3 | 其他 | Any | 接口返回的其他数据 |
Page({
onLoad: function (options) {
wx.getSystemInfo({
success(res) {
console.log(res);
console.log(res.model);
console.log('成功执行');
},
fail(res){
console.log('失败执行');
},
complete(res){
console.log('不管成功失败都执行');
}
})
}
})