小程序api

网络

　　wx.request() 请求。参数中url-地址，data请求参数，header请求头，method请求类型，dataType请求回数据格式，success成功回掉，fail接口调用成功失败的函数，complete接口调用完成的函数。data返回的数据，statusCode服务器返回的状态码，header响应头。 abort中端请求任务

　　wx.uploadfile上传本地资源到服务器。url地址，filePath上传资源路径，name文件对应的key服务端根据这个key接收，header请求头，formdata请求的额外参数，success成功回调，fail成功失败都执行的回调，complete接口完成回调。data返回的数据，statusCode返回状态码。 一般配合wx.chooseImage()使用。uploadTask对象可以检测上传进度，onProgressUpfate监听上传进度，abort中端上传。onProgessUpdate对象，progress上传百分比，totalBytesSent已经上传的长度Bytes，totalBytesExpexcedToSend预计上传的总长度

　　wx。downLoadFile()下载文件到本地资源。url地址，header请求头，success成功回调，fail请求成功失败的回调，complete请求完成回调。 tempFilePath临时文件路径，statusCode返回状态码。downLoadTask下载对象，onProgressUpdate下载进度，abort中端下载。onProgressUpdate对象，progress下载进度百分比，totalBytesWritten已经下载的长度，totalBytesExpectedWrite总长度

　　websocket长连接。wx.connectSocket()创建socket连接，url地址必须是wss协议域名必须在后台配置，header请求头，method请求类型，protocols子协议数组，success成功回调，fail成功和失败回调，complete完成回调。wx.onSocketOpen()打开连接，wx.onSocketError()连接错误，wx.sendSocketMessage()发送数据data数据success成功回调fail成功失败回调complete完成回调，wx.closeSocket()关闭连接，wx.onSocketClose()监听关闭连接。SocketTask对象send()发送数据close()关闭onOpen()监听打开onClose()监听关闭onError()监听错误

媒体

　　wx.chooseImage()本地相册或者拍照count照片的张数最多9张，sizeType是否压缩，sourceType是使用相册还是相机，success成功回调，fail成功失败回调，complete完成回调。tampFilePaths图片的本地路径列表，tempFile文件对象集合

　　wx.previewImage()预览图片current显示当前图片的连接不填则是第一张，urls地址图片的集合，success成功回调，fail成功失败回调，complete完成回调

　　wx.getImageInfo()获取图片信息src地址success...参数width图片宽度px，height高度，path本地路径，orientation图片的方向，type图片的格式

　　wx.saveImageToPhotosAlbum()保存图片到相册。filePath图片文件路径，succ.. 返回errMsg调用结果

　　wx.getRecorderManager()获得全局录音对象。录音之前需调用wx.authorize()先获得权限，recorderManager对象start开始录音，pause暂停录音，resume继续录音，stop停止录音，onStart开始录音事件，onPauset停录音事件，onStop暂停录音事件，onFrameRecorded录音玩的文件，onError录音错误事件

　　wx.getBackgroundAudioManager()全局背景音乐对象。属性duration音频的长度，currentTime当前音频的播放位置，paused当前是否停止或者暂停状态，src数据源，startTime音频开始播放的位置，buffered音频缓冲的时间点，title音频的标题，epname分享出去的名字，singer歌手的名字，coverImgUrl封面图url，webUrl页面链接。方法play播放，pause暂停，stop停止，seek跳到制定位置，onCanplay音频进入可播放状态，onPlay播放事件，onPause暂停事件，onstop停止事件，onEnded自动播放完毕事件，onTimeUpdate播放进度事件，onPrev上一曲，onNext下一曲，onError错误，onWaiting加载中事件

　　wx.chooseVideo()拍摄视频或者从相册中选视频。参数sourceType是从相册还是拍摄，compressed是否压缩视频文件，maxDuration拍摄的最长时间，succ...返回tempFilePath选定视频的临时路径，duration视频的时间长度，size视频数据量大小，height视频的长，width视频的宽

　　wx.saveVideoPhotosAlbum()保存视频到相册。需要用户授权scope.writePhotosAlbum。参数filePath视频路径，succ...返回errMsg调用结果

　　wx.createVideoContext()创建videoContext对象。配合video组件使用。方法play播放，pause暂停，seek跳到制定位置，sendDanmu发送弹幕，playBackRate设置倍速，requestFullScreen进入全屏，exitFullScreen退出全屏。

　　wx.createCameraContext() 相机对象。配合camera组件使用。taskPhoto拍照可以制定相片质量成功返回图片，startRecord开始录像，stopRecord结束录像成功则返回封面与视频

　　wx.createLivePlayerContext()对应<live-player>对象。方法play开始，stop停止，mute静音，requestFullScreen全屏，exitFullScreen退出全屏

　　wx.createLivePusherContext()对应<live-pusher>对象。方法start播放推流，stop暂停，pause暂停推流，resume恢复推流，switchCamera切换前后摄像头，snapshot快照

文件

　　wx.saveFile()保存文件到本地。参数tempFilePath保存文件的临时路径，succ... 返回saveFilePath文件保存的路径

　　wx.getFileInfo()获取文件信息。参数filePath本地文件路径，digestAlgorithm计算文件摘要的算法，succ... 返回size文件大小，digest按照digestAlgorithm计算得出的文件摘要，errMsg调用结果

　　wx.getFileSaveList()获取本地以保存的文件列表。参数succ...  返回errMsg接口调用的结果，fileList文件列表

　　wx.getFileSaveInfo()获得本地文件信息。参数filePath文件路径，succe... 返回errMsg接口调用结果，size文件大小，createTime文件保存的时间戳

　　wx.removeSaveFile()删除本地储存文件。参数filepath文件路径，succ...

　　wx.openDocument()新页面打开文档。参数filePath路径，fileType文件类型，succe...

缓存　

　　wx.setStorage()异步设置缓存。参数key键,data值,succ...

　　wx.setStorageSync()同步设置缓存。参数key键，data值

　　wx.getStorage()异步获取缓存。参数key键，succ...

　　wx.getStorageSync()同步获取缓存，参数key键

　　wx.getStorageInfo()异步获得缓存信息。参数succ...

　　wx.getStorageInfoSync()同步获得缓存信息。

　　wx.removeStorage()异步删除缓存。参数key键，succ...

　　wx.removeStorageSync()同步删除缓存。参数key键

　　wx.clearStorage()异步清除缓存。

　　wx.clearStorageSync()同步清除缓存。

位置

　　wx.getLocation()获取当前位置的地理信息，速度。参数type默认为wgs84返回gps坐标，altitude传入true会返回高度信息，succe.. success参数latitude维度，longitude精度，speed速度，accuracy位置的精度，altitude高度，verticalAccuracy垂直精度，horizpntalAccuracy水平精度

　　wx.chooseLocation()打开当前的位置地图。需要用户授权scope.userLocation。参数succ...

　　wx.openLocation()使用微信内置地图查看位置。参数latitude纬度，longitude经度，scale缩放比例，name位置名，address地址详细说明，succ...

　　wx.createMapContext()创建<map>组件对象。方法getCenterLocation获得当前地图中心的经纬度，moveToLocation将当前地图中心移动到当前定位点，translateMarker评议marker带动画，includePoints缩放视野展示所有经纬度，getRegion获得当前视野的范围，getScale获得挡圈地图的缩放级别

设备

　　系统信息

　　　　wx.getSystemInfo()获取系统信息。succ...

　　　　wx.getSystemInfoSync()同步获取系统信息。

　　　　wx.canIUse()判断小程序是否支持api。参数api字符串

　　网络状态

　　　　wx.getNetworkType()获取当前网络类型。参数succ...

　　　　wx.onNetworkStatusChange()监听网络状态变化。callback

　　加速器

　　　　wx.onAccelerometerChange()显示加速度数据。callback 返回的数据为x，y，z轴的加速度

　　　　wx.startAccelerometer()开始监听加速度数据

　　　　wx.stopAccelerometer()停止监听加速度数据

　　罗盘

　　　　wx.onCompassChange()监听罗盘数据。callback返回的为direction对面方向的度数

　　　　wx.startCompass()开始监听罗盘

　　　　wx.stopCompass()暂停监听罗盘

　　打电话

　　　　wx.mackPhoneCall()打电话。参数phoneNumber电话号码,succ...

　　扫码

　　　　wx.scanCode()扫码。参数onlyFromcamrea是否只能相机扫码，scanType扫码类型

　　剪贴板

　　　　wx.setClipboardData()设置系统剪贴板。参数data设置的内容，succ...

　　　　wx.getClipboardData()获得系统剪贴板。参数succ...

　　蓝牙　　　　

　　　　wx.openBluetoothAdapter()初始化小程序模块。但是需要先打开本地蓝牙设备。参数succ...

　　　　wx.closeBluetoothAdapter()关闭蓝牙模块。参数succ...

　　　　wx.getBluetoothAdapterState()获取本地蓝牙适配器状态。参数succ...

　　　　wx.onBluetoothAdapterStateChange()监听蓝牙适配器的变化。参数succ...

　　　　wx.startBluetoothDevicesDiscovery()开始搜寻附近蓝牙设备。参数services蓝牙主设备的uuid列表，allowDuplicatesKey是否允许重复上报同一设备，interval上报设备的间隔，succ...

　　　　wx.stopBluetoothDevicesDiscovery()停止搜寻附近的蓝牙设备。参数succ...

　　　　wx.getBluetoothDevices()获取蓝牙设备在生效期间已经发现的蓝牙设备。参数succ...

　　　　wx.getConnectedBluetoothDevices()根据uuid获取已连接状态的设备。参数services蓝牙设备的uuid，succ...

　　　　wx.onBluetoothDevicesFound()监听寻找新设备的事件。回调devices薪搜索到的设备列表

　　　　wx.createBLEConnection()连接低功耗蓝牙设备。参数devicesId蓝牙设备的id，succ...

　　　　wx.closeBLEConnection()断开低功耗蓝牙设备。参数devicesId蓝牙设备的id，succ...

　　　　wx.getBLEDeviceServices()获取蓝牙设备的service服务。参数deviceId蓝牙设备id，succ...

　　　　wx.getBLEDevicecharacteristics()获取蓝牙设备某个服务中的所有characteristics特性。参数deviceId蓝牙设备id，succ...

　　　　wx.readBLECharacteristics()读取低功耗蓝牙设备特性的二进制数据值。参数devideId蓝牙设备的id，succ...

　　　　wx.writeBLECharacteristics()想低功耗蓝牙设备写入二进制数据值。参数deviceId蓝牙设备的id，serviceId蓝牙特性值对应的服务的uuid，characteristicId蓝牙特征值的uuid，value蓝牙特性的二进制值，succ...

　　　　wx.notifyBLECharacteristicsValueChange()启用低功耗蓝牙设备时特征值变化的notify功能。参数deviceId蓝牙设备id，serviceId蓝牙特性对应服务的uuid，characteristicId蓝牙特征性的uuid，state是否启用notify，succ...

　　　　wx.onBLEConnectionStateChange()监听低功耗蓝牙连接状态的改变事件。回调deviceId蓝牙设备id，connected连接目前的状态

　　　　wx.onBLECharacteristicValueChange()监听低功耗蓝牙设备的特性值的变化。回调deviceId蓝牙设备的id，

serviceId特征值所属的uuid，characteristicIdtezheng值uuid，value特征值最新的值

　　iBeacon　　跟蓝牙设备有点相似，在一定范围连接设备后，可是被受到推送消息

　　　　wx.startBeaconDiscovery()连接附近的iBeacon设备。参数uuids连接iBeacon设备的uuids,succ....

　　　　wx.stopBeaconDiscovery()断开iBeacon设备。参数succ...

　　　　wx.getBeacons()获取一搜索到的iBeacon设备。参数succ...

　　　　wx.onBeaconUpdate()监听iBeacon设备的更新事件。回调当前所搜寻到的iBeacon的列表

　　　　wx.onBeaconServiceChange()监听iBeacon服务的状态变化。回调available服务目前是否可用，discovering是否处于被搜索状态

　　屏幕亮度

　　　　wx.setScreenBrightness()设置屏幕亮度。参数value屏幕亮度值，succ...

　　　　wx.getScreenBrightness()获得屏幕亮度。参数succ...

　　　　wx.setkeeoScreenOn设置是否保持常亮状态。参数keepScreenOn是否常亮，succ...

　　截屏

　　　　wx.onUserCaptureScreen()监听用户主动截屏事件。回调

　　震动

　　　　wx.vibrateLong()使手机发生400ms的震动。参数succ...

　　　　wx.vibrateShort()使手机产生15ms的震动。参数succ...

　　手机联系人

　　　　wx.addPhoneContact()新增手机联系人。参数一大堆，不想写，都是基本信息。

　　nfc

　　　　wx.getHCEState()判断当前设备是否支持HCE能力。参数succ...

　　　　wx.startHCE()初始化NFC模块，参数aid_list需要注册到系统的AID列表，succ...

　　　　wx.stopHCE()关闭NFC模块。参数succ...

　　　　wx.onHCEMessage()监听NFC设备消息的回调。参数messageType消息类型，data客户端接收的NFC设备指令，reason

　　　　wx.sendHCEMessage()发送NFC消息。参数data二进制数据，succ...

　　wifi　　

　　　　wx.startWifi()初始化wifi模块。参数succ...

　　　　wx.stopWifi()关闭wifi模块。参数succ...

　　　　wx.connectWifi()连接wifi。参数SSID wifi设备id，BSSID wifi设备bssid，passwrod wifi 密码，succ...

　　　　wx.getWifiList()请求获取wifi列表。参数succ...

　　　　wx.onGetWifiList()监听获取wifi列表数据的事件。回调wifiList wifi列表的数据

　　　　wx.setWifiList()IOS专用，在onGetWifiList()回调后，利用接口设置wifilist的ap相关信息。参数wifilist预设的wifi信息列表，succ...

　　　　wx.onWifiConnected()监听连接上wifi的事件。回调wifi wifi信息

　　　　wx.getConnectedWifi()获取已连接wifi的信息

界面

　　交互反馈

　　　　wx.showToast()显示消息提示框。参数title提示内容，icon图标，image自定义本地图片优先级高于icon，duration提示延长的时间，mask是否能点击其他区域，succ...

　　　　wx.hideToast()隐藏提示消息。

　　　　wx.showLoading()显示loading提示框。参数title提示内容，mask是否能点击其他区域，succ...

　　　　wx.hideLoading()隐藏loading提示框

　　　　wx.showModal()显示模态弹窗。参数title提示标语，content提示内容，showCancel是否显示取消按钮，cancelText取消按钮的文字，cancelColor取消按钮的颜色，confirmText确定按钮的文字，confirmColor确定按钮的颜色，succ...

　　　　wx.showActionSheet()显示操作菜单。itemList按钮文字数组，itemColor按钮颜色，succ...

　　设置导航条

　　　　wx.setNavigationBarTitle()动态设置页面标题。参数title页面标题，succ..

　　　　wx.showNavigationBarLoading()导航条显示加载动画

　　　　wx.hideNavigationBarLoading()隐藏导航条加载动画

　　　　wx.setNavigationBarColor()动态改变导航条。参数frontColor标题颜色仅支持#ffffff和#000000，backgroundColor导航条背景色，animation动画效果duration动画变化的时间timingFunc动画变化的方式，succ...

　　设置tabBar

　　　　wx.setTabBarBadge()为tabBar某一项右上角添加文本。参数index tabBar的哪一项，text显示的内容，succ..

　　　　wx.removeTabBarBadge()移除tabBar上的文本。参数index tabBar的哪一项。succ...

　　　　wx.showTabBarRedDot()显示tabBar某一项右上角的红点。参数index tabBar的某一项，succ...

　　　　wx.hideTabBarRedDot()隐藏tabBar某一项右上角的红点。参数index tabBar的某一项，succ...

　　　　wx.setTabBarStyle()动态设置tabBar的整体样式。参数color tab上的文字默认颜色，selectedColor tab上文字选中的颜色，backgroundColor tab背景色，borderStyle tab上边框的颜色，succ...

　　　　wx.setTabBarItem()动态设置tabBar的某一项。index tabBar的哪一项，text tab上的文字，iconPath图片路径，selectedIconPath 选中时的图片路径，succ...

　　　　wx.showTabBar()显示tabBar.。参数animation是否显示动画效果，succ...

　　　　wx.hideTabBar()隐藏tabBar。参数animation是否显示动画效果，succ...

　　设置置顶信息

　　　　wx.setTopBarText()动态设置置顶栏文字内容。参数text置顶栏文字内容，succ...

　　导航

　　　　wx.navigateTo()保留当前页，跳到应用内某个页面。参数url跳转到地址，succ...

　　　　wx.redirectTo()关闭当前页面，跳转到应用内某个页面。参数url跳转的地址，succ...

　　　　wx.switchTab()跳转到tabBar页面，并关闭并关闭其他非tabBar页面。参数ur跳转的地址，succ...

　　　　wx.navigateBack()关闭当前页面，返回上一级或多级页面。参数dalta返回的页面数

　　　　wx.relaunch()关闭所有页面，打开应用内　　某个页面。参数url跳转的地址，succ...

　　动画

　　　　wx.createAnimation()创建一个动画示例的animation。找一节单独研究

　　位置

　　　　wx.pageScrollTo()将页面滚动到目标位置。参数scrollTop滚动到页面的目标位置，duration滚动的动画时长

　　绘图

　　　　找一节单独研究

　　下拉刷新 需要在.json文件配置enablePullDownRefresh： true

　　　　Page.onPullDownRefresh()开始下来刷新出发的事件。

　　　　wx.startPullDownRefresh()开始下拉刷新。参数succ...

　　　　wx.stopPullDownRefresh()停止下拉刷新。

　　WXML节点信息

　　　　wx.createSelectQuery()返回一个selectQuery对象的实例。selectQuery对象的方法in在自定义组件内改变this对象的指向，select类似jq选择器但是只能选择一个，selectAll选择所有节点，selectViewport()选择显示区域，可用于获得显示尺寸滚动位置信息返回一个NodeRef对象实例，exec执行所有请求请求结果在回调返回第一个参数中返回

　　　　NodeRef对象实例的方法boundingClientRect()返回节点信息位置用的left，top，right，bottom，width，height字段描述，scrollOffset()节点必须是scroll-view的viewport返回节点的scroll-left，scroll-top字段描述，fields获取节点相关的信息id,data,rect,size,scrollOffset,properties字段信息。

　　WXML节点布局相交状态

　　　　wx.createIntersectionObserver()创建并返回一个IntersectionObserver对象。可选的options thresholds一个数值数组包含所有阈值，initialRatio初始化相交比例

　　　　intersectionObserver对象的方法relativeTo使用选择器指定一个节点作为参照区域之一，relativeToViewport执行页面选择区域作为区域参照之一，observe指定目标节点并开始监听相交状态变化情况回调参数包含intersectionRatio相交比例intersectionRect相交区域的边界boundingClientRect目标节点布局的边界relativeRect参照区域的边界，time相交检测时间的时间戳disconnect停止监听

第三方平台

　　wx.getExtConfig()获得第三方平台自定义字段。参数succ...

　　wx.getExtConfigSync()同步获得第三方平台的自定义字段

开放接口

　　登录

　　　　wx.login()获取登录的临时凭证。参数timeOut()超时时间，succ... 返回errMsg调用结果，code登录凭证有效五分钟

　　　　wx.checkSession()校验当前的session_key是否有效。参数succ...

　　授权

　　　　wx.authorize()接口功能授权。参数scope需要授权的scope（列表https://mp.weixin.qq.com/debug/wxadoc/dev/api/authorize-index.html）,succ...

　　用户信息

　　　　wx.getUserInfo()获取用户信息。参数withCredentials是否带上登录信息状态，lang指定返回信息的语言，timeOut超时时间，succ...

　　　　page.getPhoneNumber()需要将<button/>组件open-type的值设置为getPhoneNumber，当用户同意之后可通过bindgetPhoneNumber事件回调函数获得服务器加密信息，要是想获得还需解密。

　　微信支付

　　　　wx.requestPayment()发起微信支付。参数timeStamp当前时间时间戳，nonceStr随机字符串，package统一下单的返回的prepay_id的值提交格式为"prepay_id=**",signType签名算法仅支持md5，paySign签名，succ...

　　转发

　　　　page.onShareAppMessage()设置页面转发信息。options参数from转发事件来源，target事件来源。返回字段title分享标题，path转发路径，imageUrl自定义图片，succ...

　　　　wx.showShareMenu()显示页面分享按钮。参数withShareTicket是否使用shareTicket的转发，succ...

　　　　wx.hideSahreMenu()隐藏转发按钮。参数succ...

　　　　wx.updateShareMenu()更新转发属性。参数withShareTicket是否使用shareTicket的转发，succ...

　　　　wx.getShareInfo()获得转发详情。参数shareTicket，timeOut超时时间，succ...

　　收获地址

　　　　wx.chooseAddress()掉起用户编辑收获地址原生界面。需要授权scope.address。参数succ...

　　卡卷

　　　　wx.addCard()批量添加卡券。参数cardList需要添加的卡券列表，succ...

　　　　wx.openCard()查看微信卡包中的卡券。参数cardList需要打开的卡券列表，succ...

　　设置

　　　　wx.openSetting()打开小程序设置界面,回操作的结果。参数succ...　　　　

　　　　wx.getSetting()获取用户的当前权限设置。参数succ...

　　微信运动

　　　　wx.getWeRunData()获得用户过去30天的运动步数。需要授权scope.werun。参数timeOut超时时间succ... 所得的数据加密，需解密观看

　　打开小程序

　　　　wx.navigateToMiniProgram()打开同一公众号下的小程序。参数appId打开小程序的id，path打开页面的路径不填则为首页，ectraData传递的数据目标小程序可以在app.onLaunch()或者app.onShow()中获取，envVersion打开小程序的版本号，succ...

　　　　wx.navigateBackMiniProgram()返回上一个小程序。参数extraData返回上个小程序传递的数据，succ...

　　打开App　　

　　　　launchApp()打开app。需要用户主动触发，需要open-type的值为launchappde button组件点击来触发。

　　获得发票抬头

　　　　wx.chooseInvoiceTitle()获得用户的发票。需要授权scope.invoiceTitle。参数succ...

　　生物认证

　　　　wx.checkIsSupportAuthentication()获得本机支持的生物认证。参数succ...

　　　　wx.startSoterAuthentication()开始soter生物认证。requestAuthModes生物认证的方式，challenge挑战因子，authContent验证描述，succ...

　　　　wx.CheckIsSoterEnrolledInDevice()获取设备是否录入指纹等生物信息。参数checkAuthMode认证方式，succ...