小程序学习笔记五：API

 

   API

   小程序提供了丰富的微信原生API，可以方便的调起微信提供的能力，如获取用户信息，本地存储，支付功能等。

   api调用格式：

   1：wx.on 开头的 API 是监听某个事件发生的API接口，接受一个 CALLBACK 函数作为参数。当该事件触发时，会调用 CALLBACK 函数：

wx.onXX(function(res) {
  //回调方法体;
})

    2：如未特殊约定，其他 API 接口都接受一个OBJECT（在 { } 中定义）作为参数，OBJECT中可以指定success, fail, complete来接收接口调用结果：

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

 

    API分类

    目前，提供的API主要有：网络API、媒体API、文件API、缓存API、位置API、设备API、界面API、WXML节点API、第三方平台API、微信开放API、小程序数据分析API、调试API  十二大类。

    一：网路API

    1：发起网络请求：wx.request({object})，可以在 {object} 中，配置header、url、传递的数据、回调函数（成功、失败、结束）等。

    2：文件上传下载：wx.uploadFile(OBJECT)、wx.downloadFile(OBJECT)

    3：WebSocket连接：可以建立一个websocket连接，通过连接发送消息、接收消息，关闭连接。以及建立、接收、关闭事件的callback。

 

    二：媒体API

    1：图片

         wx.chooseImage(OBJECT)：从本地相册选择图片或使用相机拍照。

         wx.previewImage(OBJECT)：预览图片。

         wx.getImageInfo(OBJECT)：获取图片信息。

         wx.saveImageToPhotosAlbum(OBJECT)：保存图片到系统相册。

    2：录音

         wx.getRecorderManager()：获取全局唯一的录音管理器 recorderManager，然后调用管理器进行 开始录音、结束录音、暂停录音等。

   3：音频播放控制

        wx.createInnerAudioContext()：创建并返回内部 audio 上下文 innerAudioContext 对象，通过innerAudioContext 对象调用方法进行音频的播放控制。

    4：背景音乐播放控制

        wx.getBackgroundAudioManager()：获取全局唯一的背景音频管理器 backgroundAudioManager，并且调用方法进行播放控制。

    5：视频选择与录像

       wx.chooseVideo(OBJECT)：拍摄视频或从手机相册中选视频，返回视频的临时文件路径。。

       wx.saveVideoToPhotosAlbum(OBJECT)：保存视频到系统相册。

    6：视频播放控制

      wx.createVideoContext(videoId, this)：创建并返回 video 上下文 videoContext 对象，通过对象控制播放。

    7：相机组件控制

      wx.createCameraContext(this)：创建并返回 camera 上下文 cameraContext 对象，cameraContext 与页面的 camera 组件绑定，一个页面只能有一个camera，通过它可以操作对应的 <camera/> 组件。可以拍照、录像。

    8：实时音视频组件控制（直播与看直播）

      wx.createLivePlayerContext(domId, this)：操作对应的 <live-player/> 组件。 创建并返回 live-player 上下文 LivePlayerContext 对象，播放与暂停观看、全屏与退出全屏。

      wx.createLivePusherContext()：创建并返回 live-pusher 上下文 LivePusherContext 对象，LivePusherContext 与页面的 <live-pusher /> 组件绑定，一个页面只能有一个 live-pusher，通过它可以操作对应的 <live-pusher/> 组件。推流，进行直播。

 

    三：文件API

        1：wx.saveFile(OBJECT)：保存文件到本地。

        2：wx.getFileInfo(OBJECT)：获取文件信息。

        3：wx.getSavedFileList(OBJECT)：获取本地已保存的文件列表。

        4：wx.getSavedFileInfo(OBJECT)：获取本地文件的文件信息。

        5：wx.removeSavedFile(OBJECT)：删除本地存储的文件。

        6：wx.openDocument(OBJECT)：新开页面打开文档，支持格式：doc, xls, ppt, pdf, docx, xlsx, pptx。

 

    四：数据缓存API

        1：

转载于:https://www.cnblogs.com/ygj0930/p/8359789.html