.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. .. _class_HTTPRequest: HTTPRequest =========== **Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core Brief Description ----------------- A Node with the ability to send HTTP requests. Member Functions ---------------- +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`cancel_request` **(** **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_body_size` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_body_size_limit` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_download_file` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_http_client_status` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_max_redirects` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_using_threads` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`request` **(** :ref:`String` url, :ref:`StringArray` custom_headers=StringArray([]), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_body_size_limit` **(** :ref:`int` bytes **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_download_file` **(** :ref:`String` path **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_max_redirects` **(** :ref:`int` amount **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_use_threads` **(** :ref:`bool` enable **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- - **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`StringArray` headers, :ref:`RawArray` body **)** This signal is emitted upon request completion. Numeric Constants ----------------- - **RESULT_SUCCESS** = **0** --- Request successful. - **RESULT_CHUNKED_BODY_SIZE_MISMATCH** = **1** - **RESULT_CANT_CONNECT** = **2** --- Request failed while connecting. - **RESULT_CANT_RESOLVE** = **3** --- Request failed while resolving. - **RESULT_CONNECTION_ERROR** = **4** --- Request failed due to connection(read/write) error. - **RESULT_SSL_HANDSHAKE_ERROR** = **5** --- Request failed on SSL handshake. - **RESULT_NO_RESPONSE** = **6** --- Request does not have a response(yet). - **RESULT_BODY_SIZE_LIMIT_EXCEEDED** = **7** --- Request exceded its maximum size limit, see :ref:`set_body_size_limit`. - **RESULT_REQUEST_FAILED** = **8** --- Request failed. (unused) - **RESULT_DOWNLOAD_FILE_CANT_OPEN** = **9** --- HTTPRequest couldn't open the download file. - **RESULT_DOWNLOAD_FILE_WRITE_ERROR** = **10** --- HTTPRequest couldn't write to the download file. - **RESULT_REDIRECT_LIMIT_REACHED** = **11** --- Request reached its maximum redirect limit, see :ref:`set_max_redirects`. Description ----------- A Node with the ability to send HTTP requests. Uses a :ref:`HTTPClient` internally, supports HTTPS. Can be used to make HTTP requests or download files via HTTP. Member Function Description --------------------------- .. _class_HTTPRequest_cancel_request: - void **cancel_request** **(** **)** Cancel the current request. .. _class_HTTPRequest_get_body_size: - :ref:`int` **get_body_size** **(** **)** const Return the response body length. .. _class_HTTPRequest_get_body_size_limit: - :ref:`int` **get_body_size_limit** **(** **)** const Return current body size limit. .. _class_HTTPRequest_get_download_file: - :ref:`String` **get_download_file** **(** **)** const Return the file this request will download into. .. _class_HTTPRequest_get_downloaded_bytes: - :ref:`int` **get_downloaded_bytes** **(** **)** const Return the amount of bytes this HTTPRequest downloaded. .. _class_HTTPRequest_get_http_client_status: - :ref:`int` **get_http_client_status** **(** **)** const Return the current status of the underlying :ref:`HTTPClient`. .. _class_HTTPRequest_get_max_redirects: - :ref:`int` **get_max_redirects** **(** **)** const Return the maximum amount of redirects that will be followed. .. _class_HTTPRequest_is_using_threads: - :ref:`bool` **is_using_threads** **(** **)** const Whether this request is using threads. .. _class_HTTPRequest_request: - :ref:`int` **request** **(** :ref:`String` url, :ref:`StringArray` custom_headers=StringArray([]), :ref:`bool` ssl_validate_domain=true, :ref:`int` method=0, :ref:`String` request_data="" **)** Make a HTTP request (by default GET, unless specified otherwise as method). The url is the complete url including "http://" or "https://" which will be parsed for a host and a port. The custom_headers are HTTP request headers which will be used. If User-Agent is not specified a Godot specific will be used. The ssl_validate_domain specifies if in case of HTTPS the server certificate should be verified. .. _class_HTTPRequest_set_body_size_limit: - void **set_body_size_limit** **(** :ref:`int` bytes **)** Set the response body size limit. .. _class_HTTPRequest_set_download_file: - void **set_download_file** **(** :ref:`String` path **)** Set the file to download into. Outputs the response body into the file. .. _class_HTTPRequest_set_max_redirects: - void **set_max_redirects** **(** :ref:`int` amount **)** Set the maximum amount of redirects the request will follow. .. _class_HTTPRequest_set_use_threads: - void **set_use_threads** **(** :ref:`bool` enable **)** Make this HTTPRequest use threads.