小工具知识网

当前位置: 首页 > 行业知识 > 【小程序】应用程序编程接口能力汇总——网络API(一)

行业知识

【小程序】应用程序编程接口能力汇总——网络API(一)

2026-11-17 17:56:17 来源:互联网转载

ty.request

获取���络请求任务对象 RequestTask

()

参数

Object object

()

发起 HTTPS 网络请求的回调函数

回调参数 Object res

属性类型默认值必填说明
urlstring是开发者服务器接口地址
datastring否请求的参数
headerany否设置请求的 header,header 中不能设置 Referer。
timeoutnumber否超时时间,单位为毫秒
methodHTTPMethod否HTTP 请求方法
completefunction否接口调用结束的回调函数(调用成功、失败都会执行)
successfunction否接口调用成功的回调函数
failfunction否

object.success 回调参数

参数

Object res

属性类型说明
datastring开发者服务器返回的数据
statusCodenumber开发者服务器返回的 HTTP 状态码
headerany开发者服务器返回的 HTTP Response Header
cookiesarray开发者服务器返回的 cookies,格式为字符串数组
profileProfile网络请求过程中一些调试信息
taskIdstring网络请求 id,用户取消、监听等操作

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

返回值

RequestTask

获取网络请求任务对象 RequestTask

 

RequestTask

RequestTask.abort

中断请求任务

参数

Object object

中断请求任务的回调函数

回调参数 Object res

属性类型默认值必填说明
completefunction否接口调用结束的回调函数(调用成功、失败都会执行)
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

函数定义示例

/** * 中断请求任务 */export function abort(params: {  /** 接口调用结束的回调函数(调用成功、失败都会执行) */  complete?: () => void;  /** 接口调用成功的回调函数 */  success?: (params: null) => void;  failure?: (params: {    errorMsg: string;    errorCode: string | number;    innerError: {      errorCode: string | number;      errorMsg: string;    };  }) => void;}): void;

 

RequestTask.onHeadersReceived

监听 HTTP Response Header 事件。会比请求完成事件更早

参数

function callback

监听 HTTP Response Header 事件。会比请求完成事件更早的回调函数

回调参数 Object res

属性类型默认值必填说明
headerany是开发者服务器返回的 HTTP Response Header
requestIdstring是网络请求 id

 

RequestTask.offHeadersReceived

取消监听 HTTP Response Header 事件

参数

function callback

取消监听 HTTP Response Header 事件的回调函数

回调参数 Object res

属性类型默认值必填说明
headerany是开发者服务器返回的 HTTP Response Header
requestIdstring是网络请求 id

   立即开发。

ty.uploadFile

获取上传请求任务对象 UploadFileTask

参数

Object object

将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 content-type 为 multipart/form-data 的回调函数

回调参数 Object res

属性类型默认值必填说明
urlstring是开发者服务器地址
filePathstring是要上传文件资源的路径 (本地路径)
namestring是文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容
headerany否HTTP 请求的 Header,Header 中不能设置 Referer
formDataany否HTTP 请求中其他额外的 form data
timeoutnumber否超时时间,单位为毫秒
completefunction否接口调用结束的回调函数(调用成功、失败都会执行)
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
datastring开发者服务器返回的数据
statusCodenumber开发者服务器返回的 HTTP 状态码

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

返回值

UploadFileTask

获取上传请求任务对象 UploadFileTask

 

ty.downloadFile

下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求,返回文件的本地临时路径 (本地路径),单次下载允许的最大文件为 200MB。使用前请注意阅读相关说明。 注意:请在服务端响应的 header 中指定合理的 Content-Type 字段,以保证客户端正确处理文件类型。的回调函数

回调参数 Object res

属性类型默认值必填说明
urlstring是下载资源的 url
headerany否HTTP 请求的 Header,Header 中不能设置 Referer
timeoutnumber否超时时间,单位为毫秒
filePathstring否指定文件下载后存储的路径 (本地路径)
completefunction否接口调用结束的回调函数(调用成功、失败都会执行)
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性类型说明
tempFilePathstring临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回,下载后的文件会存储到一个临时文件
filePathstring用户文件路径 (本地路径)。传入 filePath 时会返回,跟传入的 filePath 一致
statusCodenumber开发者服务器返回的 HTTP 状态码
profileProfile网络请求过程中一些调试信息

object.fail 回调参数

参数

Object res

属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

返回值

DownloadFileTask

一个可以监听下载进度变化事件,以及取消下载任务的对象

   立即开发。

上一篇:怎么给电脑开通服务器连接?

下一篇:浙江服务器托管怎么样?