diff options
Diffstat (limited to 'doc/classes/HTTPRequest.xml')
| -rw-r--r-- | doc/classes/HTTPRequest.xml | 24 |
1 files changed, 7 insertions, 17 deletions
diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 985198c76f..ec9f86993f 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HTTPRequest" inherits="Node" category="Core" version="3.0-beta"> +<class name="HTTPRequest" inherits="Node" category="Core" version="3.1"> <brief_description> A node with the ability to send HTTP requests. </brief_description> @@ -8,6 +8,7 @@ Can be used to make HTTP requests, i.e. download or upload files or web content via HTTP. </description> <tutorials> + http://docs.godotengine.org/en/3.0/tutorials/networking/ssl_certificates.html </tutorials> <demos> </demos> @@ -26,13 +27,6 @@ Returns the response body length. </description> </method> - <method name="get_download_file" qualifiers="const"> - <return type="String"> - </return> - <description> - Returns the file this request will download into. - </description> - </method> <method name="get_downloaded_bytes" qualifiers="const"> <return type="int"> </return> @@ -61,15 +55,8 @@ <argument index="4" name="request_data" type="String" default=""""> </argument> <description> - </description> - </method> - <method name="set_download_file"> - <return type="void"> - </return> - <argument index="0" name="path" type="String"> - </argument> - <description> - Sets the file to download into. Outputs the response body into the file if set. + Creates request on the underlying [HTTPClient]. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request]. + Returns [code]OK[/code] if request is successfully created. (Does not imply that the server has responded), [code]ERR_UNCONFIGURED[/code] if not in the tree, [code]ERR_BUSY[/code] if still processing previous request, [code]ERR_INVALID_PARAMETER[/code] if given string is not a valid URL format, or [code]ERR_CANT_CONNECT[/code] if not using thread and the [HTTPClient] cannot connect to host. </description> </method> </methods> @@ -77,6 +64,9 @@ <member name="body_size_limit" type="int" setter="set_body_size_limit" getter="get_body_size_limit"> Maximum allowed size for response bodies. </member> + <member name="download_file" type="String" setter="set_download_file" getter="get_download_file"> + The file to download into. Will output any received file into it. + </member> <member name="max_redirects" type="int" setter="set_max_redirects" getter="get_max_redirects"> Maximum number of allowed redirects. </member> |