wx.request(OBJECT)
wx.request发起的是https请求。
一个微信小程序,同时只能有5个网络请求连接。
OBJECT参数说明:
参数名 | 类型 | 必填 | 说明 |
url | String | 是 | 开发者服务器接口地址 |
data | Object、String | 否 | 请求的参数 |
header | Object | 否 | 设置请求的header , header中不能设置Referer |
method | String | 否 | 默认为GET,有效值:OPTIONS,GET,HEAD,POST,PUT,DELETE,TRACE,CONNECT |
success | Function | 否 | 收到开发者服务成功返回的回调函数,res = {data:"开发者服务器返回的内容"} |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码:
- wx.request({
- url: 'https://www.ceshi.com/test.php',
- data: {
- x: '' ,
- y: ''
- },
- header:{
- "Content-Type":"application/json"
- },
- success: function(res) {
- var data = res.data;
- }
- });
wx.uploadFile(OBJECT)
将本地资源上传到开发者服务器。如页面通过 wx.chooseImage 等接口获取到一个本地资源的临时文件路径后,可通过此接口将本地资源上传到指定服务器。客户端发起一个HTTPS POST请求,其中 Content-Type 为 multipart/form-data 。
OBJECT参数说明:
参数 | 类型 | 必填 | 说明 |
url | String | 是 | 开发者服务器url |
filePath | String | 是 | 要上传文件资源的路径 |
name | String | 是 | 文件对应的key , 开发者在服务器端通过这个key可以获取到文件二进制内容 |
header | Object | 否 | HTTP 请求 Header |
formData | Object | 否 | HTTP 请求中其他额外的form data |
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码:
- wx.chooseImage({
- success:function(res){
- var tempFilePaths = res.tempFilePaths;
- wx.uploadFile({
- url: 'http://example.com/upload',
- filePath: tempFilePaths[0],
- name:"file",
- formData:{
- "user":"test"
- }
- })
- }
- })
wx.downloadFile(OBJECT)
下载文件资源到本地。客户端直接发起一个HTTP GET请求,把下载到的资源根据 type 进行处理,并返回文件的本地临时路径。
OBJECT参数说明:
参数 | 类型 | 必填 | 必填 |
url | String | 是 | 下载资源的 url |
type | String | 否 | 下载资源的类型,用于客户端识别处理,有效值:image/audio/video |
header | Object | 否 | HTTP 请求 Header |
success | Function | 否 | 下载成功后以 tempFilePath 的形式传给页面,res={tempFilePath:"文件的临时路径"} |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码:
创建一个 WebSocket 连接;一个微信小程序同时只能有一个WebSocket连接,如果当前已存在一个WebSocket连接,会自动关闭该连接,并重新创建一个WebSocket连接。
OBJECT参数说明:
参数 | 类型 | 必填 | 说明 |
url | String | 是 | 开发者服务器接口地址,必须是HTTPS协议,且域名必须是后台配置的合法域名 |
data | Object | 否 | 请求的数据 |
header | Object | 否 | HTTP Header |
method | String | 否 | 默认是GET,有效值为: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT |
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码:
监听WebSocket连接打开事件
示例代码:
wx.connectSocket({ url:"test.php" }); wx.onSocketOpen(function(res){ console.log("WebSocket连接已打开!") })
wx.onSocketError(CALLBACK)
监听WebSocket错误
示例代码:
wx.connectSocket({ url:"test.php" }); wx.onSocketOpen(function(res){ console.log("WebSocket连接已打开!") }) wx.onSocketError(function(res){ console.log("WebSocket连接打开失败,请检查!") })
wx.sendSocketMessage(OBJECT)
通过WebSocket连接发送数据,需要先wx.connectSocket,并在wx.onSocketOpen回调之后才能发送。
OBJECT参数说明:
参数 | 类型 | 必填 | 说明 |
data | String | 是 | 需要发送的内容 |
示例代码:
var socketOpen = false; var socketMsgQueue = [] wx.connectSocket({ url:"test.php" }); wx.onSocketOpen(function(res){ socketOpen = true; for(var i = 0 ; i < socketMsgQueue.length; i++){ sendSocketMessage(socketMsgQueue[i]) } socketMsgQueue = []; }) function sendSocketMessage(msg){ if(socketOpen){ wx.sendSocketMessage({ data:msg }); }else{ socketMsgQueue.push(msg) } }
wx.onSocketMessage(CALLBACK)
监听WebSocket接受到服务器的消息事件
CALLBACK返回参数:
参数 | 类型 | 说明 |
data | String | 服务器返回的消息 |
示例代码:
wx.connectSocket({ url:"test.php" }); wx.onSocketMessage(function(res){ console.log("收到服务器内容:" + res.data) })
wx.closeSocket()
关闭WebSocket连接
wx.onSocketClose(CALLBACK)
监听WebSocket关闭