.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/HTTPRequest.xml. .. _class_HTTPRequest: HTTPRequest =========== **Inherits:** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`JamHttpRequestPool.HttpHolder` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`accept_gzip` | ``true`` | +-----------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`body_size_limit` | ``-1`` | +-----------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`download_chunk_size` | ``65536`` | +-----------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`download_file` | ``""`` | +-----------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`max_redirects` | ``8`` | +-----------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`timeout` | ``0.0`` | +-----------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`use_threads` | ``false`` | +-----------------------------+----------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`cancel_request` **(** **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_body_size` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_downloaded_bytes` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Status` | :ref:`get_http_client_status` **(** **)** |const| | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`request` **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`Method` method=0, :ref:`String` request_data="" **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`request_raw` **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`Method` method=0, :ref:`PackedByteArray` request_data_raw=PackedByteArray() **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_http_proxy` **(** :ref:`String` host, :ref:`int` port **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_https_proxy` **(** :ref:`String` host, :ref:`int` port **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tls_options` **(** :ref:`TLSOptions` client_options **)** | +---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_HTTPRequest_signal_request_completed: .. rst-class:: classref-signal **request_completed** **(** :ref:`int` result, :ref:`int` response_code, :ref:`PackedStringArray` headers, :ref:`PackedByteArray` body **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_HTTPRequest_Result: .. rst-class:: classref-enumeration enum **Result**: .. _class_HTTPRequest_constant_RESULT_SUCCESS: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_SUCCESS** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_CHUNKED_BODY_SIZE_MISMATCH: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_CHUNKED_BODY_SIZE_MISMATCH** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_CANT_CONNECT: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_CANT_CONNECT** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_CANT_RESOLVE: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_CANT_RESOLVE** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_CONNECTION_ERROR: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_CONNECTION_ERROR** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_TLS_HANDSHAKE_ERROR: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_TLS_HANDSHAKE_ERROR** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_NO_RESPONSE: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_NO_RESPONSE** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_BODY_SIZE_LIMIT_EXCEEDED: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_BODY_SIZE_LIMIT_EXCEEDED** = ``7`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_BODY_DECOMPRESS_FAILED: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_BODY_DECOMPRESS_FAILED** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_REQUEST_FAILED: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_REQUEST_FAILED** = ``9`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_DOWNLOAD_FILE_CANT_OPEN: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_DOWNLOAD_FILE_CANT_OPEN** = ``10`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_DOWNLOAD_FILE_WRITE_ERROR: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_DOWNLOAD_FILE_WRITE_ERROR** = ``11`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_REDIRECT_LIMIT_REACHED: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_REDIRECT_LIMIT_REACHED** = ``12`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_HTTPRequest_constant_RESULT_TIMEOUT: .. rst-class:: classref-enumeration-constant :ref:`Result` **RESULT_TIMEOUT** = ``13`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_HTTPRequest_property_accept_gzip: .. rst-class:: classref-property :ref:`bool` **accept_gzip** = ``true`` .. rst-class:: classref-property-setget - void **set_accept_gzip** **(** :ref:`bool` value **)** - :ref:`bool` **is_accepting_gzip** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_property_body_size_limit: .. rst-class:: classref-property :ref:`int` **body_size_limit** = ``-1`` .. rst-class:: classref-property-setget - void **set_body_size_limit** **(** :ref:`int` value **)** - :ref:`int` **get_body_size_limit** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_property_download_chunk_size: .. rst-class:: classref-property :ref:`int` **download_chunk_size** = ``65536`` .. rst-class:: classref-property-setget - void **set_download_chunk_size** **(** :ref:`int` value **)** - :ref:`int` **get_download_chunk_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_property_download_file: .. rst-class:: classref-property :ref:`String` **download_file** = ``""`` .. rst-class:: classref-property-setget - void **set_download_file** **(** :ref:`String` value **)** - :ref:`String` **get_download_file** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_property_max_redirects: .. rst-class:: classref-property :ref:`int` **max_redirects** = ``8`` .. rst-class:: classref-property-setget - void **set_max_redirects** **(** :ref:`int` value **)** - :ref:`int` **get_max_redirects** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_property_timeout: .. rst-class:: classref-property :ref:`float` **timeout** = ``0.0`` .. rst-class:: classref-property-setget - void **set_timeout** **(** :ref:`float` value **)** - :ref:`float` **get_timeout** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_property_use_threads: .. rst-class:: classref-property :ref:`bool` **use_threads** = ``false`` .. rst-class:: classref-property-setget - void **set_use_threads** **(** :ref:`bool` value **)** - :ref:`bool` **is_using_threads** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_HTTPRequest_method_cancel_request: .. rst-class:: classref-method void **cancel_request** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_method_get_body_size: .. rst-class:: classref-method :ref:`int` **get_body_size** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_method_get_downloaded_bytes: .. rst-class:: classref-method :ref:`int` **get_downloaded_bytes** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_method_get_http_client_status: .. rst-class:: classref-method :ref:`Status` **get_http_client_status** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_method_request: .. rst-class:: classref-method :ref:`Error` **request** **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`Method` method=0, :ref:`String` request_data="" **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_method_request_raw: .. rst-class:: classref-method :ref:`Error` **request_raw** **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`Method` method=0, :ref:`PackedByteArray` request_data_raw=PackedByteArray() **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_method_set_http_proxy: .. rst-class:: classref-method void **set_http_proxy** **(** :ref:`String` host, :ref:`int` port **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_method_set_https_proxy: .. rst-class:: classref-method void **set_https_proxy** **(** :ref:`String` host, :ref:`int` port **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_HTTPRequest_method_set_tls_options: .. rst-class:: classref-method void **set_tls_options** **(** :ref:`TLSOptions` client_options **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`