request
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✔︎ | ✔︎ | ✔︎ | ✔︎ |
参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
url | string | 是 | 开发者服务器接口地址 |
params | object | 否 | 请求参数 |
headers | Object | 否 | 设置请求的 headers,content-type 默认为 application/json |
method | string | 否 | 默认为 GET |
paramsType | number | 否 | 请求参数的类型 |
method的合法值
值 | 说明 |
---|---|
GET | 使用GET方式 |
POST | 使用POST方式 |
paramsType的合法值
值 | 说明 |
---|---|
0 | 键值对 |
1 | json格式,只支持POST请求,会在header中自动添加content-type:application/json |
成功回调返回
字段 | 类型 | 说明 |
---|---|---|
status | number | 响应码 |
headers | object | 响应头 |
data | string | 响应数据 |
错误码说明
错误码 | 说明 |
---|---|
400 | 参数不合法 |
401 | 用户无访问权限 |
500 | 请求错误 |
501 | 服务器错误 |
1001 | 无网络 |
1002 | 解析错误 |
1003 | 用户取消 |
-1 | 位置错误 |
-2 | 页面超时 |
示例
mtl.request({
url: "https://some-domain.com/api/user",
method: "GET",
headers: { "X-Requested-With": "XMLHttpRequest" },
params: {
ID: 12345
},
paramsType: 0,
success: function(res) {
var data = res.data; // 返回数据
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
uploadFile
文件上传,将本地文件上传到指定服务器。客户端发起一个 HTTPS POST 请求,其中 content-type
为 multipart/form-data
。
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✘ | ✔︎ | ✔︎ | ✔︎ |
参数
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
url | string | 是 | 指定服务器地址 |
filePath | string | 是 | 文件路径 |
header | Object | 否 | HTTP 请求 Header |
formData | Object | 否 | HTTP 请求中其他额外的 form data |
返回参数说明
参数 | 类型 | 说明 |
---|---|---|
data | string | 服务器返回的数据 |
statusCode | number | 服务器返回的 HTTP 状态码 |
示例
mtl.uploadFile({
url: "",
filePath: "",
success: function(res) {
// 成功回调
},
fail: function(err) {
var message = err.message; // 错误信息
}
});
downloadFile
从网络下载到手机本地并返回本地url
支持平台
微信 | 友空间 | 安卓 | iOS |
---|---|---|---|
✔︎ | ✔︎ | ✔︎ | ✔︎ |
参数
字段 | 类型 | 必填 | |
---|---|---|---|
url | string | 是 | 需要下载资源的url |
fileType | string | 是 | 文件格式jpg,txt,pdf等 |
fileName | string | 否 | 文件名 如abc.jpg等 |
autoPreview | int | 否 | 是否自动打开预览界面,0不打开,1打开,默认0 |
header | object | 否 | http请求头部参数 |
formBody | object | 否 | http请求额外body参数-表单形式。 参数非空为post请求,否则为get请求。 |
jsonBody | string | 否 | http请求额外参数-json形式 |
返回参数说明
参数 | 类型 | 说明 |
---|---|---|
filePath | string | 存储到手机本地的url |
示例
mtl.downloadFile({
url: "",
fileType: "",
fileName: "",
autoPreview: 0,
header: {},
formBody: {},
jsonBody: "",
success: function(res) {
// 成功回调
},
fail: function(err) {
var message = err.message; // 错误信息
}
});