mirror of
https://github.com/Insality/druid.git
synced 2025-06-27 18:37:44 +02:00
49 lines
1.8 KiB
Lua
49 lines
1.8 KiB
Lua
--[[
|
|
Generated with github.com/astrochili/defold-annotations
|
|
Defold 1.8.0
|
|
|
|
HTTP API documentation
|
|
|
|
Functions for performing HTTP and HTTPS requests.
|
|
--]]
|
|
|
|
---@diagnostic disable: lowercase-global
|
|
---@diagnostic disable: missing-return
|
|
---@diagnostic disable: duplicate-doc-param
|
|
---@diagnostic disable: duplicate-set-field
|
|
|
|
---@class defold_api.http
|
|
http = {}
|
|
|
|
---Perform a HTTP/HTTPS request.
|
|
--- If no timeout value is passed, the configuration value "network.http_timeout" is used. If that is not set, the timeout value is 0 (which blocks indefinitely).
|
|
---@param url string target url
|
|
---@param method string HTTP/HTTPS method, e.g. "GET", "PUT", "POST" etc.
|
|
---@param callback fun(self, id, response) response callback function
|
|
---
|
|
---self
|
|
---object The script instance
|
|
---id
|
|
---hash Internal message identifier. Do not use!
|
|
---response
|
|
---table The response data. Contains the fields:
|
|
---
|
|
---
|
|
---number status: the status of the response
|
|
---string response: the response data (if not saved on disc)
|
|
---table headers: all the returned headers
|
|
---string path: the stored path (if saved to disc)
|
|
---string error: if any unforeseen errors occurred (e.g. file I/O)
|
|
---
|
|
---@param headers table|nil optional table with custom headers
|
|
---@param post_data string|nil optional data to send
|
|
---@param options table|nil optional table with request parameters. Supported entries:
|
|
---
|
|
---number timeout: timeout in seconds
|
|
---string path: path on disc where to download the file. Only overwrites the path if status is 200. Not available in HTML5 build
|
|
---boolean ignore_cache: don't return cached data if we get a 304. Not available in HTML5 build
|
|
---boolean chunked_transfer: use chunked transfer encoding for https requests larger than 16kb. Defaults to true. Not available in HTML5 build
|
|
---
|
|
function http.request(url, method, callback, headers, post_data, options) end
|
|
|
|
return http |