HttpClient
描述:
代表一个HTTP客户端。
postAsync
类型: 函数。
描述:
向指定的URL发送JSON文本的POST请求,并返回响应文本。
签名:
postAsync: function(self: HttpClient, url: string, json: string, timeout?: number): string | nil
参数:
参数名 | 类型 | 描述 |
---|---|---|
url | string | 要发送请求的URL。 |
json | string | 要在请求中发送的JSON文本。 |
timeout | number | [可选] 请求超时时间(以秒为单位,默认为5秒)。 |
返回值:
返回类型 | 描述 |
---|---|
string | 响应体的文本,如果请求失败则返回nil。 |
postAsync
类型: 函数。
描述:
向指定的URL发送带有指定头部和JSON文本的POST请求,并返回响应文本。
签名:
postAsync: function(self: HttpClient, url: string, headers: {string}, json: string, timeout?: number): string | nil
参数:
参数名 | 类型 | 描述 |
---|---|---|
url | string | 要发送请求的URL。 |
headers | {string} | 要在请求中发送的头部。每个头部应该以 "name: value" 的格式。 |
json | string | 要在请求中发送的JSON文本。 |
timeout | number | [可选] 请求超时时间(以秒为单位,默认为5秒)。 |
返回值:
返回类型 | 描述 |
---|---|
string | 响应体的文本,如果请求失败则返回nil。 |
getAsync
类型: 函数。
描述:
向指定的URL发送GET请求,并返回响应文本。
签名:
getAsync: function(self: HttpClient, url: string, timeout?: number): string | nil
参数:
参数名 | 类型 | 描述 |
---|---|---|
url | string | 要发送请求的URL。 |
timeout | number | [可选] 请求超时时间(以秒为单位,默认为5秒)。 |
返回值:
返回类型 | 描述 |
---|---|
string | 响应体的文本,如果请求失败则返回nil。 |
downloadAsync
类型: 函数。
描述:
从指定的URL异步下载文件,并保存到指定的路径。必须在一个协程中调用此方法。
签名:
downloadAsync: function(self: HttpClient, url: string, fullPath: string, timeout?: number, progress?: function(current: integer, total: integer): boolean): boolean
参数:
参数名 | 类型 | 描述 |
---|---|---|
url | string | 需要下载的文件的URL。 |
fullPath | string | 下载文件应保存的完整路径。 |
timeout | number | [可选] 下载超时时间(以秒为单位,默认为30秒)。 |
progress | string | [可选] 一个定期报告下载进度的回调函数。 该函数接收两个参数:current(到目前为止下载的字节数)和 total(需要下载的总字节数)。 如果回调函数返回 true ,则下载将被取消。 |
返回值:
返回类型 | 描述 |
---|---|
boolean | 一个布尔值,表示下载是否成功完成。 |