2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2018-07-31 20:13:10 +02:00
<class name= "HTTPRequest" inherits= "Node" category= "Core" version= "3.0.7" >
2017-09-12 22:42:36 +02:00
<brief_description >
2017-12-10 20:32:34 +01:00
A node with the ability to send HTTP requests.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2017-12-10 20:32:34 +01:00
A node with the ability to send HTTP requests. Uses [HTTPClient] internally.
Can be used to make HTTP requests, i.e. download or upload files or web content via HTTP.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2018-01-25 09:03:59 +01:00
http://docs.godotengine.org/en/3.0/tutorials/networking/ssl_certificates.html
2017-09-12 22:42:36 +02:00
</tutorials>
<demos >
</demos>
<methods >
<method name= "cancel_request" >
<return type= "void" >
</return>
<description >
2017-12-10 20:32:34 +01:00
Cancels the current request.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_body_size" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2017-12-10 20:32:34 +01:00
Returns the response body length.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_downloaded_bytes" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2017-12-10 20:32:34 +01:00
Returns the amount of bytes this HTTPRequest downloaded.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_http_client_status" qualifiers= "const" >
<return type= "int" enum= "HTTPClient.Status" >
</return>
<description >
2017-12-10 20:32:34 +01:00
Returns the current status of the underlying [HTTPClient]. See [code]STATUS_*[/code] enum on [HTTPClient].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "request" >
<return type= "int" enum= "Error" >
</return>
<argument index= "0" name= "url" type= "String" >
</argument>
<argument index= "1" name= "custom_headers" type= "PoolStringArray" default= "PoolStringArray( )" >
</argument>
<argument index= "2" name= "ssl_validate_domain" type= "bool" default= "true" >
</argument>
<argument index= "3" name= "method" type= "int" enum= "HTTPClient.Method" default= "0" >
</argument>
<argument index= "4" name= "request_data" type= "String" default= """" >
</argument>
<description >
2018-04-20 11:25:06 +02:00
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.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<members >
2017-09-13 08:49:40 +02:00
<member name= "body_size_limit" type= "int" setter= "set_body_size_limit" getter= "get_body_size_limit" >
2017-12-10 20:32:34 +01:00
Maximum allowed size for response bodies.
2017-09-12 22:42:36 +02:00
</member>
2018-01-11 23:38:35 +01:00
<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>
2017-09-13 08:49:40 +02:00
<member name= "max_redirects" type= "int" setter= "set_max_redirects" getter= "get_max_redirects" >
2017-12-10 20:32:34 +01:00
Maximum number of allowed redirects.
2017-09-12 22:42:36 +02:00
</member>
2017-09-13 08:49:40 +02:00
<member name= "use_threads" type= "bool" setter= "set_use_threads" getter= "is_using_threads" >
2017-12-10 20:32:34 +01:00
If [code]true[/code] multithreading is used to improve performance.
2017-09-12 22:42:36 +02:00
</member>
</members>
<signals >
<signal name= "request_completed" >
<argument index= "0" name= "result" type= "int" >
</argument>
<argument index= "1" name= "response_code" type= "int" >
</argument>
<argument index= "2" name= "headers" type= "PoolStringArray" >
</argument>
<argument index= "3" name= "body" type= "PoolByteArray" >
</argument>
<description >
This signal is emitted upon request completion.
</description>
</signal>
</signals>
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "RESULT_SUCCESS" value= "0" enum= "Result" >
2017-09-12 22:42:36 +02:00
Request successful.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "RESULT_CHUNKED_BODY_SIZE_MISMATCH" value= "1" enum= "Result" >
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "RESULT_CANT_CONNECT" value= "2" enum= "Result" >
2017-09-12 22:42:36 +02:00
Request failed while connecting.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "RESULT_CANT_RESOLVE" value= "3" enum= "Result" >
2017-09-12 22:42:36 +02:00
Request failed while resolving.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "RESULT_CONNECTION_ERROR" value= "4" enum= "Result" >
2017-09-12 22:42:36 +02:00
Request failed due to connection(read/write) error.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "RESULT_SSL_HANDSHAKE_ERROR" value= "5" enum= "Result" >
2017-09-12 22:42:36 +02:00
Request failed on SSL handshake.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "RESULT_NO_RESPONSE" value= "6" enum= "Result" >
2017-09-12 22:42:36 +02:00
Request does not have a response(yet).
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "RESULT_BODY_SIZE_LIMIT_EXCEEDED" value= "7" enum= "Result" >
2017-10-14 12:45:26 +02:00
Request exceeded its maximum size limit, see [method set_body_size_limit].
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "RESULT_REQUEST_FAILED" value= "8" enum= "Result" >
2017-12-10 20:32:34 +01:00
Request failed. (Unused)
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "RESULT_DOWNLOAD_FILE_CANT_OPEN" value= "9" enum= "Result" >
2017-09-12 22:42:36 +02:00
HTTPRequest couldn't open the download file.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "RESULT_DOWNLOAD_FILE_WRITE_ERROR" value= "10" enum= "Result" >
2017-09-12 22:42:36 +02:00
HTTPRequest couldn't write to the download file.
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "RESULT_REDIRECT_LIMIT_REACHED" value= "11" enum= "Result" >
2017-09-12 22:42:36 +02:00
Request reached its maximum redirect limit, see [method set_max_redirects].
</constant>
</constants>
</class>