微信小程序API 文档快速参考索引

内容那么多，这个页面到底做了什么？

• 第一：解决微信文档APi文档使用不便；
• 第二：解决了内容搜索与索引；—— 最好是写成全文索引文档，但是比较需要时间，而且更新是一件麻烦的事；所以以下是直接 连接官网查看的；
• 第三：解决了完整性；—— 当你看文档时，无法掌握整体；这里可能更容易记忆目录整体；
• 第四：不一定每个人阅读后，都有作用！—— 可能本文档与你无缘；

 

 

 目录2017-12-1911:37:56

•  网络
•  媒体
•  文件
•  数据缓存
•  位置
•  设备
•  界面
•  WXML节点信息
•  第三方平台
•  开放接口
•  数据
•  调试接口

 

-------------------------------------------------------------------------------------------------------------------------------------------

-------------------------------------------------------------------------------------------------------------------------------------------

• 网络
  • 发起请求
    • wx.request ——  wx.request(OBJECT)   发起网络请求。使用前请先阅读说明。
  • 上传、下载
    • wx.uploadFile ——  wx.uploadFile(OBJECT)  将本地资源上传到开发者服务器，客户端发起一个 HTTPS POST 请求，其中 content-type 为 multipart/form-data 。使用前请先阅读说明。
    • wx.downloadFile —— wx.downloadFile(OBJECT) 下载文件资源到本地，客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。使用前请先阅读说明。
  • WebSocket
    • wx.connectSocket ——  wx.connectSocket(OBJECT)  创建一个 WebSocket 连接。使用前请先阅读说明。
    • wx.onSocketOpen —— wx.onSocketOpen(CALLBACK) 监听WebSocket连接打开事件。
    • wx.onSocketError ——  wx.onSocketError(CALLBACK)  监听WebSocket错误。
    • wx.sendSocketMessage —— wx.sendSocketMessage(OBJECT)  通过 WebSocket 连接发送数据，需要先 wx.connectSocket，并在 wx.onSocketOpen 回调之后才能发送。
    • wx.onSocketMessage —— wx.onSocketMessage(CALLBACK) 监听WebSocket接受到服务器的消息事件。
    • wx.closeSocket ——  wx.closeSocket(OBJECT) 关闭 WebSocket 连接。
    • wx.onSocketClose —— wx.onSocketClose(CALLBACK) 监听WebSocket关闭。
    • SocketTask —— SocketTask 
      SocketTask.send(OBJECT) 通过 WebSocket 连接发送数据。
      SocketTask.close(OBJECT) 关闭 WebSocket 连接。
      SocketTask.onOpen(CALLBACK)  监听 WebSocket 连接打开事件。
      SocketTask.onOpen(CALLBACK) 监听 WebSocket 连接关闭事件。
      SocketTask.onError(CALLBACK) 监听 WebSocket 错误。
      SocketTask.onMessage(CALLBACK) 监听WebSocket接受到服务器的消息事件。
      
      
•  媒体
  • 图片
    • wx.chooseImage  ——  wx.chooseImage(OBJECT)  从本地相册选择图片或使用相机拍照。
    • wx.previewImage —— wx.previewImage(OBJECT) 预览图片。
    • wx.getImageInfo —— wx.getImageInfo(OBJECT)  获取图片信息
    • wx.saveImageToPhotosAlbum —— wx.saveImageToPhotosAlbum(OBJECT) 保存图片到系统相册。需要用户授权 scope.writePhotosAlbum    （基础库 1.2.0 开始支持，低版本需做兼容处理 ）
  • 录音
    • wx.startRecord —— wx.startRecord(OBJECT)  注意：1.6.0 版本开始，本接口不再维护。建议使用能力更强的 wx.getRecorderManager 接口
    • wx.stopRecord —— wx.stopRecord() 主动调用停止录音。
  • 录音管理
    • wx.getRecorderManager —— wx.getRecorderManager() 获取全局唯一的录音管理器 recorderManager。
  • 音频播放控制
    • wx.playVoice —— wx.playVoice(OBJECT) 开始播放语音，同时只允许一个语音文件正在播放，如果前一个语音文件还没播放完，将中断前一个语音播放。
    • wx.pauseVoice
    • wx.stopVoice
  • 音乐播放控制
    • wx.getBackgroundAudioPlayerState
    • wx.playBackgroundAudio
    • wx.pauseBackgroundAudio
    • wx.seekBackgroundAudio
    • wx.stopBackgroundAudio
    • wx.onBackgroundAudioPlay
    • wx.onBackgroundAudioPause
    • wx.onBackgroundAudioStop
  • 背景音频播放管理
    • wx.getBackgroundAudioManager
  • 音频组件控制
    • wx.createAudioContext
    • wx.createInnerAudioContext
  • 视频
    • wx.chooseVideo
    • wx.saveVideoToPhotosAlbum
  • 视频组件控制
    • wx.createVideoContext
  • 相机组件控制
    • wx.createCameraContext
•  文件
  • wx.saveFile —— wx.saveFile(OBJECT) 保存文件到本地。注意：saveFile 会把临时文件移动，因此调用成功后传入的 tempFilePath 将不可用
  • wx.getFileInfo—— wx.getFileInfo(OBJECT) 获取文件信息
  • wx.getSavedFileList —— wx.getSavedFileList(OBJECT) 获取本地已保存的文件列表
  • wx.getSavedFileInfo —— wx.getSavedFileInfo(OBJECT) 获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件，若需要获取临时文件信息，请使用 wx.getFileInfo 接口。
  • wx.removeSavedFile —— wx.removeSavedFile(OBJECT) 删除本地存储的文件
  • wx.openDocument —— wx.openDocument(OBJECT)  新开页面打开文档，支持格式：doc, xls, ppt, pdf, docx, xlsx, pptx
•  数据缓存
  • wx.setStorage —— wx.setStorage(OBJECT) 将数据存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个异步接口。
  • wx.setStorageSync —— wx.setStorageSync(KEY,DATA)  将 data 存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个同步接口。
  • wx.getStorage —— wx.getStorage(OBJECT) 从本地缓存中异步获取指定 key 对应的内容。
  • wx.getStorageSync ——  wx.getStorageSync(KEY)  从本地缓存中同步获取指定 key 对应的内容。
  • wx.getStorageInfo —— wx.getStorageInfo(OBJECT)  异步获取当前storage的相关信息
  • wx.getStorageInfoSync ——  wx.getStorageInfoSync 同步获取当前storage的相关信息
  • wx.removeStorage  ——  wx.removeStorage(OBJECT)  从本地缓存中异步移除指定 key 。
  • wx.removeStorageSync  ——  wx.removeStorageSync(KEY)  从本地缓存中同步移除指定 key 。
  • wx.clearStorage  ——  wx.clearStorage()  清理本地数据缓存。
  • wx.clearStorageSync  ——  wx.clearStorageSync()  同步清理本地数据缓存
•  位置
  • 获取位置
    • wx.getLocation
    • wx.chooseLocation
  • 查看位置
    • wx.openLocation
  • 地图组件控制
    • wx.createMapContext
•  设备
  • 系统信息
    • wx.getSystemInfo
    • wx.getSystemInfoSync
    • wx.canIUse
  • 网络状态
    • wx.getNetworkType
    • wx.onNetworkStatusChange
  • 加速度计
    • wx.onAccelerometerChange
    • wx.startAccelerometer
    • wx.stopAccelerometer
  • 罗盘
    • wx.onCompassChange
    • wx.startCompass
    • wx.stopCompass
  • 拨打电话
    • wx.makePhoneCall
  • 扫码
    • wx.scanCode
  • 剪贴板
    • wx.setClipboardData
    • wx.getClipboardData
  • 蓝牙
    • wx.openBluetoothAdapter
    • wx.closeBluetoothAdapter
    • wx.getBluetoothAdapterState
    • wx.onBluetoothAdapterStateChange
    • wx.startBluetoothDevicesDiscovery
    • wx.stopBluetoothDevicesDiscovery
    • wx.getBluetoothDevices
    • wx.getConnectedBluetoothDevices
    • wx.onBluetoothDeviceFound
    • wx.createBLEConnection
    • wx.closeBLEConnection
    • wx.getBLEDeviceServices
    • wx.getBLEDeviceCharacteristics
    • wx.readBLECharacteristicValue
    • wx.writeBLECharacteristicValue
    • wx.notifyBLECharacteristicValueChange
    • wx.onBLEConnectionStateChange
    • wx.onBLECharacteristicValueChange
    • 错误码
  • iBeacon
    • wx.startBeaconDiscovery
    • wx.stopBeaconDiscovery
    • wx.getBeacons
    • wx.onBeaconUpdate
    • wx.onBeaconServiceChange
  • 屏幕亮度
    • wx.setScreenBrightness
    • wx.getScreenBrightness
    • wx.setKeepScreenOn
  • 用户截屏事件
    • wx.onUserCaptureScreen
  • 振动
    • wx.vibrateLong
    • wx.vibrateShort
  • 手机联系人
    • wx.addPhoneContact
•  界面
  • 交互反馈 
    • wx.showToast —— 显示消息提示框
    • wx.showLoading  ——  显示 loading 提示框, 需主动调用 wx.hideLoading 才能关闭提示框
    • wx.hideToast  ——  隐藏消息提示框
    • wx.hideLoading  ——  ​隐藏 loading 提示框
    • wx.showModal  ——  ​​显示模态弹窗
    • wx.showActionSheet  —— 显示操作菜单
  • 设置导航条
    • wx.setNavigationBarTitle —— 动态设置当前页面的标题。
    • wx.showNavigationBarLoading  —— 在当前页面显示导航条加载动画。
    • wx.hideNavigationBarLoading —— 隐藏导航条加载动画。
    • wx.setNavigationBarColor ——  设置颜色
  • 设置置顶信息
    • wx.setTopBarText —— 动态设置置顶栏文字内容，只有当前小程序被置顶时能生效，如果当前小程序没有被置顶，也能调用成功，但是不会立即生效，只有在用户将这个小程序置顶后才换上设置的文字内容。
  • 导航
    • wx.navigateTo ——  保留当前页面，跳转到应用内的某个页面，使用wx.navigateBack可以返回到原页面。
    • wx.redirectTo —— 关闭当前页面，跳转到应用内的某个页面。
    • wx.switchTab —— 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
    • wx.navigateBack —— 关闭当前页面，返回上一页面或多级页面。可通过 getCurrentPages()) 获取当前的页面栈，决定需要返回几层。
    • wx.reLaunch —— 关闭所有页面，打开到应用内的某个页面。
  • 动画
    • wx.createAnimation ——  

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

      注意: export 方法每次调用后会清掉之前的动画操作

  • 位置
    • wx.pageScrollTo ——  将页面滚动到目标位置。
    • wx.createSelectorQuery ——  返回一个SelectorQuery对象实例。可以在这个实例上使用select等方法选择节点，并使用boundingClientRect等方法选择需要查询的信息。
  • 绘图
    • intro
    • coordinates
    • gradient
    • reference
    • color
    • wx.createCanvasContext
    • wx.createContext
    • wx.drawCanvas
    • wx.canvasToTempFilePath
    • setFillStyle
    • setStrokeStyle
    • setShadow
    • createLinearGradient
    • createCircularGradient
    • addColorStop
    • setLineWidth
    • setLineCap
    • setLineJoin
    • setLineDash
    • setMiterLimit
    • rect
    • fillRect
    • strokeRect
    • clearRect
    • fill
    • stroke
    • beginPath
    • closePath
    • moveTo
    • lineTo
    • arc
    • bezierCurveTo
    • quadraticCurveTo
    • scale
    • rotate
    • translate
    • clip
    • setFontSize
    • fillText
    • setTextAlign
    • setTextBaseline
    • drawImage
    • setGlobalAlpha
    • save
    • restore
    • draw
    • getActions
    • clearActions
  • 下拉刷新
    • Page.onPullDownRefresh ——  在 Page 中定义 onPullDownRefresh 处理函数，监听该页面用户下拉刷新事件。
    • wx.startPullDownRefresh ——  开始下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致
    • wx.stopPullDownRefresh ——  停止当前页面下拉刷新。
•  WXML节点信息
  • wx.createSelectorQuery ——  返回一个SelectorQuery对象实例。可以在这个实例上使用select等方法选择节点，并使用boundingClientRect等方法选择需要查询的信息。
  • selectorQuery.in ——  将选择器的选取范围更改为自定义组件component内。（初始时，选择器仅选取页面范围的节点，不会选取任何自定义组件中的节点。）
  • selectorQuery.select ——  在当前页面下选择第一个匹配选择器selector的节点，返回一个NodesRef对象实例，可以用于获取节点信息。
  • selectorQuery.selectAll ——  在当前页面下选择匹配选择器selector的节点，返回一个NodesRef对象实例。 与selectorQuery.selectNode(selector)不同的是，它选择所有匹配选择器的节点。
  • selectorQuery.selectViewport ——  选择显示区域，可用于获取显示区域的尺寸、滚动位置等信息，返回一个NodesRef对象实例。
  • nodesRef.boundingClientRect —— 添加节点的布局位置的查询请求，相对于显示区域，以像素为单位。其功能类似于DOM的getBoundingClientRect。返回值是nodesRef对应的selectorQuery。
  • nodesRef.scrollOffset —— 添加节点的滚动位置查询请求，以像素为单位。节点必须是scroll-view或者viewport。返回值是nodesRef对应的selectorQuery。
  • nodesRef.fields —— 获取节点的相关信息，需要获取的字段在fields中指定。返回值是nodesRef对应的selectorQuery。可指定获取的字段包括：
  • selectorQuery.exec —— 执行所有的请求，请求结果按请求次序构成数组，在callback的第一个参数中返回。
•  第三方平台
  • wx.getExtConfig
  • wx.getExtConfigSync
•  开放接口
  • 登录
    • wx.login —— 

      调用接口获取登录凭证（code）进而换取用户登录态信息，包括用户的唯一标识（openid） 及本次登录的 会话密钥（session_key）等。用户数据的加解密通讯需要依赖会话密钥完成。

      注：调用 login 会引起登录态的刷新，之前的 sessionKey 可能会失效。

    • wx.checkSession ——  通过上述接口获得的用户登录态拥有一定的时效性。用户越久未使用小程序，用户登录态越有可能失效。反之如果用户一直在使用小程序，则用户登录态一直保持有效。具体时效逻辑由微信维护，对开发者透明。开发者只需要调用wx.checkSession接口检测当前用户登录态是否有效。登录态过期后开发者可以再调用wx.login获取新的用户登录态。
    • 签名加密 ——  用户数据的签名验证和加解密
  • 授权
    • wx.authorize ——  提前向用户发起授权请求。调用后会立刻弹窗询问用户是否同意授权小程序使用某项功能或获取用户的某些数据，但不会实际调用对应接口。如果用户之前已经同意授权，则不会出现弹窗，直接返回成功。
  • 用户信息
    • wx.getUserInfo ——  获取用户信息，withCredentials 为 true 时需要先调用 wx.login 接口。
    • getPhoneNumber ——  

      获取微信用户绑定的手机号，需先调用login接口。

      因为需要用户主动触发才能发起获取手机号接口，所以该功能不由 API 来调用，需用 <button> 组件的点击来触发。

      注意：目前该接口针对非个人开发者，且完成了认证的小程序开放。需谨慎使用，若用户举报较多或被发现在不必要场景下使用，微信有权永久回收该小程序的该接口权限。

    • UnionID机制说明 ——  移动应用、网站应用、和公众帐号（包括小程序）ID机制说明
  • 微信支付
    • wx.requestPayment
  • 模板消息
    • 使用说明
    • 模版消息管理
    • 发送模板消息
  • 客服消息
    • 接收消息和事件
      • 文本消息
      • 图片消息
      • 小程序卡片消息
      • 进入会话事件
    • 发送客服消息
    • 转发消息
    • 临时素材接口
      • 获取临时素材
      • 新增临时素材
    • 客服输入状态
    • 接入指引
  • 转发
    • Page.onShareAppMessage
    • wx.showShareMenu
    • wx.hideShareMenu
    • wx.updateShareMenu
    • wx.getShareInfo
    • 获取更多转发信息
    • 页面内发起转发
  • 获取二维码
  • 收货地址
    • wx.chooseAddress
  • 卡券
    • wx.addCard
    • wx.openCard
    • 会员卡组件
  • 设置
    • wx.openSetting
    • wx.getSetting
  • 微信运动
    • wx.getWeRunData
  • 打开小程序
    • wx.navigateToMiniProgram
    • wx.navigateBackMiniProgram
  • 获取发票抬头
    • wx.chooseInvoiceTitle
  • 生物认证
    • wx.checkIsSupportSoterAuthentication
    • wx.startSoterAuthentication
    • wx.checkIsSoterEnrolledInDevice
  • 附近
    • 添加地点
    • 删除地点
    • 展示/取消展示附近小程序
•  数据
  • 常规分析
    • 概况
      • 概况趋势
    • 访问分析
      • 访问趋势
      • 访问分布
      • 访问留存
      • 访问页面
    • 用户画像
  • 自定义分析
    • 自定义数据上报
•  调试接口
  • 打开/关闭调试