小程序-API

##小程序API

###网络

每个微信小程序需要事先设置一个通讯域名(服务器域名),小程序可以跟指定的域名与进行网络通信。

  1. 发起HTTPS请求:wx.request
  2. 上传:wx.uploadFile
  3. 下载:wx.downloadFile
  4. WebSocket通信:
  • wx.connectSocket(OBJECT):创建一个连接
  • wx.onSocketOpen(CALLBACK):监听连接打开事件
  • wx.onSocketError(CALLBACK):监听连接打开失败事件
  • wx.sendSocketMessage(OBJECT):通过一个打开的连接发送消息
  • wx.onSocketMessage(CALLBACK):监听服务端连接返回的响应消息
  • wx.closeSocket():关闭连接
  • wx.onSocketClose(CALLBACK):监听连接关闭事件

###媒体

图片

  1. wx.chooseImage(OBJECT):从本地相册选择图片或使用相机拍照。
  2. wx.previewImage(OBJECT):预览图片
  3. wx.getImageInfo(OBJECT):获取图片信息

录音

  1. wx.startRecord:开始录音
  2. wx.stopRecord:停止录音

音频播放控制

  1. wx.playVoice(OBJECT):开始播放语音
  2. wx.pauseVoice:暂停正在播放的语音
  3. wx.stopVoice:停止正在播放的语音

音乐播放控制

  1. wx.getBackgroundAudioPlayerState(OBJECT):获取后台正在播放的音乐播放状态
  2. wx.playBackgroundAudio(OBJECT):使用后台播放器播放音乐
  3. wx.pauseBackgroundAudio:暂停播放后台音乐
  4. wx.seekBackgroundAudio(OBJECT):控制后台音乐播放进度
  5. wx.stopBackgroundAudio():停止播放后台音乐
  6. wx.onBackgroundAudioPlay(CALLBACK):监听后台音乐播放
  7. wx.onBackgroundAudioPause(CALLBACK):监听后台音乐暂停
  8. wx.onBackgroundAudioStop(CALLBACK):监听后台音乐停止

音频组件控制

  1. wx.createAudioContext(audioId):创建并返回audioId的上下文audioContext对象

视频

  1. wx.chooseVideo(OBJECT):拍摄视频或者从本地选择视频
    视频组件控制
  2. wx.createVideoContext(videoId):创建并返回videoId的上下文videoContext对象

文件

  1. wx.saveFile(OBJECT):保存文件到本地
  2. wx.getSavedFileList(OBJECT):获取本地已保存的文件列表
  3. wx.getSavedFileInfo(OBJECT):获取本地文件的信息
  4. wx.removeSavedFile(OBJECT):删除本地已保存的文件
  5. x.openDocument(OBJECT):打开本地一个文档,支持格式:doc, xls, ppt, pdf, docx, xlsx, pptx

数据缓存

  1. wx.setStorage(OBJECT):将数据存储在本地缓存中,并指定一个key,异步接口
  2. wx.setStorageSync(KEY,DATA):讲data存储在本地缓存中的Key中,同步接口
  3. wx.getStorage(OBJECT):从本地缓存的一个key中异步获取数据
  4. wx.getStorageSync(KEY):从本地缓存的一个key中同步获取数据
  5. wx.getStorageInfo(OBJECT):异步获取当前storage的信息
  6. wx.getStorageInfoSync():同步获取当前storage的信息
  7. wx.removeStorage(OBJECT):从本地缓存中异步删除指定key
  8. wx.removeStorageSync(KEY):从本地缓存中同步删除指定key
  9. wx.clearStorage():清理本地缓存数据
  10. wx.clearStorageSync():同步清理本地缓存数据

位置

获取位置

  1. wx.getLocation(OBJECT):获取当前的地理位置、速度。
  2. wx.chooseLocation(OBJECT):打开地图选择位置

    查看位置

  3. wx.openLocation(OBJECT):使用微信内置地图查看当前位置

    地图组件控制

  4. wx.createMapContext(MapId):创建并返会map的上下文mapContext对象

    设备

    系统信息

  5. wx.getSystemInfo(OBJECT):获取系统信息
  6. wx.getSystemInfoSync():同步获取系统信息

网络状态

  1. wx.getNetworkType(OBJECT):获取网络类型

重力感应

  1. wx.onAccelerometerChange(OBJECT):监听重力感应数据,频率:5次/秒

罗盘

  1. wx.onCompassChange(OBJECT):监听罗盘感应数据,频率:5次/秒

拨打电话

  1. wx.makePhoneCall(OBJECT):拨打电话

扫码

  1. wx.scanCode(OBJECT):调用客户端扫码界面,并返回扫码结果

界面

交互反馈

  1. wx.showToast(OBJECT):显示消息提示框
  2. wx.hideToast():隐藏消息提示框
  3. wx.showModal(OBJECT):显示模态弹窗
  4. wx.showActionSheet(OBJECT):显示操作菜单

设置导航条

  1. wx.setNavigationBarTile(OBJECT):动态设置当前页面的标题
  2. wx.showNavigationBarLoading():在当前页面显示导航条加载动画
  3. wx.hideNavigationBarLoading():隐藏导航条加载动画

导航

  1. wx.navigateTo(OBJECT):保留当前页面,跳转到应用内的某个页面,使用wx.navigateBack可以返回到原页面
  2. wx.redirectTo(OBJECT):关闭当前页面,跳转到应用内的指定页面
  3. wx.switchtab(OBJECT):跳转到tabBar,并关闭所有非tabBar页面
  4. wx.navigateBack(OBJECT):关闭当前页面,返回上一页面或多级页面。可通过 getCurrentPages()获取当前的页面栈,决定需要返回几层。
    动画
  5. wx.createAnimation(OBJECT):创建一个动画实例animation。调用实例的方法来描述动画。

绘图

所有在中的画图必须用 JavaScript 完成.

下拉刷新

  1. onPullDownRefresh:在 Page 中定义 onPullDownRefresh 处理函数,监听该页面用户下拉刷新事件。
  2. wx.stopPullDownRefresh():停止当前页面刷新
    开放接口

登陆

  1. wx.login(OBJECT):调用接口获取登录凭证(code)进而换取用户登录态信息,包括用户的唯一标识(openid) 及本次登录的 会话密钥(session_key)。用户数据的加解密通讯需要依赖会话密钥完成。
  2. wx.checkSession(OBJECT):检查登陆用户session是否失效
    签名加密:用户数据的签名验证和加解密
    用户信息
  3. wx.getUserInfo(OBJECT):获取微信用户信息,必须先使用wx.login登陆
    微信支付
  4. wx.requestPayment(OBJECT):发起微信支付

模板消息

同订阅号、服务号及企业号,微信平台提供一套消息样式模板

客服消息

同订阅号、服务号及企业号的客服消息接口

分享

  1. onShareAppMessage:在Page中设置此函数,用于内容分享
    获取二维码
  2. 获取小程序二维码:通过后台程序接口可以获取小程序任意页面的二维码,通过扫描二维码可以直接访问小程序的任意页面,接口调用URL:
    https://api.weixin.qq.com/cgi-bin/wxaapp/createwxaqrcode?access_token=ACCESS_TOKE

到这里,已经简单介绍了小程序如何注册,已经开发需要使用的组件和API,后期会结合很多实例讲解具体用法。

坚持原创技术分享,您的支持将鼓励我继续创作!