godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (705b7a0)

Browse Source
This commit is contained in:
Godot Organization
2024-05-31 13:54:35 +00:00
parent 32f1b6ea48
commit eacfba2716
835 changed files with 17350 additions and 17256 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
classes/class_httpclient.rst
View File

@@ -119,7 +119,7 @@ Enumerations
.. rst-class:: classref-enumeration
enum **Method**:
enum **Method**: :ref:`🔗<enum_HTTPClient_Method>`
.. _class_HTTPClient_constant_METHOD_GET:
@@ -209,7 +209,7 @@ Represents the size of the :ref:`Method<enum_HTTPClient_Method>` enum.
.. rst-class:: classref-enumeration
enum **Status**:
enum **Status**: :ref:`🔗<enum_HTTPClient_Status>`
.. _class_HTTPClient_constant_STATUS_DISCONNECTED:
@@ -299,7 +299,7 @@ Status: Error in TLS handshake.
.. rst-class:: classref-enumeration
enum **ResponseCode**:
enum **ResponseCode**: :ref:`🔗<enum_HTTPClient_ResponseCode>`
.. _class_HTTPClient_constant_RESPONSE_CONTINUE:
@@ -806,7 +806,7 @@ Property Descriptions
.. rst-class:: classref-property
:ref:`bool<class_bool>` **blocking_mode_enabled** = ``false``
:ref:`bool<class_bool>` **blocking_mode_enabled** = ``false`` :ref:`🔗<class_HTTPClient_property_blocking_mode_enabled>`
.. rst-class:: classref-property-setget
@@ -823,7 +823,7 @@ If ``true``, execution will block until all data is read from the response.
.. rst-class:: classref-property
:ref:`StreamPeer<class_StreamPeer>` **connection**
:ref:`StreamPeer<class_StreamPeer>` **connection** :ref:`🔗<class_HTTPClient_property_connection>`
.. rst-class:: classref-property-setget
@@ -840,7 +840,7 @@ The connection to use for this client.
.. rst-class:: classref-property
:ref:`int<class_int>` **read_chunk_size** = ``65536``
:ref:`int<class_int>` **read_chunk_size** = ``65536`` :ref:`🔗<class_HTTPClient_property_read_chunk_size>`
.. rst-class:: classref-property-setget
@@ -862,7 +862,7 @@ Method Descriptions
.. rst-class:: classref-method
|void| **close**\ (\ )
|void| **close**\ (\ ) :ref:`🔗<class_HTTPClient_method_close>`
Closes the current connection, allowing reuse of this **HTTPClient**.
@@ -874,7 +874,7 @@ Closes the current connection, allowing reuse of this **HTTPClient**.
.. rst-class:: classref-method
:ref:`Error<enum_@GlobalScope_Error>` **connect_to_host**\ (\ host\: :ref:`String<class_String>`, port\: :ref:`int<class_int>` = -1, tls_options\: :ref:`TLSOptions<class_TLSOptions>` = null\ )
:ref:`Error<enum_@GlobalScope_Error>` **connect_to_host**\ (\ host\: :ref:`String<class_String>`, port\: :ref:`int<class_int>` = -1, tls_options\: :ref:`TLSOptions<class_TLSOptions>` = null\ ) :ref:`🔗<class_HTTPClient_method_connect_to_host>`
Connects to a host. This needs to be done before any requests are sent.
@@ -888,7 +888,7 @@ If no ``port`` is specified (or ``-1`` is used), it is automatically set to 80 f
.. rst-class:: classref-method
:ref:`int<class_int>` **get_response_body_length**\ (\ ) |const|
:ref:`int<class_int>` **get_response_body_length**\ (\ ) |const| :ref:`🔗<class_HTTPClient_method_get_response_body_length>`
Returns the response's body length.
@@ -904,7 +904,7 @@ Returns the response's body length.
.. rst-class:: classref-method
:ref:`int<class_int>` **get_response_code**\ (\ ) |const|
:ref:`int<class_int>` **get_response_code**\ (\ ) |const| :ref:`🔗<class_HTTPClient_method_get_response_code>`
Returns the response's HTTP status code.
@@ -916,7 +916,7 @@ Returns the response's HTTP status code.
.. rst-class:: classref-method
:ref:`PackedStringArray<class_PackedStringArray>` **get_response_headers**\ (\ )
:ref:`PackedStringArray<class_PackedStringArray>` **get_response_headers**\ (\ ) :ref:`🔗<class_HTTPClient_method_get_response_headers>`
Returns the response headers.
@@ -928,7 +928,7 @@ Returns the response headers.
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **get_response_headers_as_dictionary**\ (\ )
:ref:`Dictionary<class_Dictionary>` **get_response_headers_as_dictionary**\ (\ ) :ref:`🔗<class_HTTPClient_method_get_response_headers_as_dictionary>`
Returns all response headers as a Dictionary of structure ``{ "key": "value1; value2" }`` where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator.
@@ -949,7 +949,7 @@ Returns all response headers as a Dictionary of structure ``{ "key": "value1; va
.. rst-class:: classref-method
:ref:`Status<enum_HTTPClient_Status>` **get_status**\ (\ ) |const|
:ref:`Status<enum_HTTPClient_Status>` **get_status**\ (\ ) |const| :ref:`🔗<class_HTTPClient_method_get_status>`
Returns a :ref:`Status<enum_HTTPClient_Status>` constant. Need to call :ref:`poll<class_HTTPClient_method_poll>` in order to get status updates.
@@ -961,7 +961,7 @@ Returns a :ref:`Status<enum_HTTPClient_Status>` constant. Need to call :ref:`pol
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_response**\ (\ ) |const|
:ref:`bool<class_bool>` **has_response**\ (\ ) |const| :ref:`🔗<class_HTTPClient_method_has_response>`
If ``true``, this **HTTPClient** has a response available.
@@ -973,7 +973,7 @@ If ``true``, this **HTTPClient** has a response available.
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_response_chunked**\ (\ ) |const|
:ref:`bool<class_bool>` **is_response_chunked**\ (\ ) |const| :ref:`🔗<class_HTTPClient_method_is_response_chunked>`
If ``true``, this **HTTPClient** has a response that is chunked.
@@ -985,7 +985,7 @@ If ``true``, this **HTTPClient** has a response that is chunked.
.. rst-class:: classref-method
:ref:`Error<enum_@GlobalScope_Error>` **poll**\ (\ )
:ref:`Error<enum_@GlobalScope_Error>` **poll**\ (\ ) :ref:`🔗<class_HTTPClient_method_poll>`
This needs to be called in order to have any request processed. Check results with :ref:`get_status<class_HTTPClient_method_get_status>`.
@@ -997,7 +997,7 @@ This needs to be called in order to have any request processed. Check results wi
.. rst-class:: classref-method
:ref:`String<class_String>` **query_string_from_dict**\ (\ fields\: :ref:`Dictionary<class_Dictionary>`\ )
:ref:`String<class_String>` **query_string_from_dict**\ (\ fields\: :ref:`Dictionary<class_Dictionary>`\ ) :ref:`🔗<class_HTTPClient_method_query_string_from_dict>`
Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.:
@@ -1050,7 +1050,7 @@ Furthermore, if a key has a ``null`` value, only the key itself is added, withou
.. rst-class:: classref-method
:ref:`PackedByteArray<class_PackedByteArray>` **read_response_body_chunk**\ (\ )
:ref:`PackedByteArray<class_PackedByteArray>` **read_response_body_chunk**\ (\ ) :ref:`🔗<class_HTTPClient_method_read_response_body_chunk>`
Reads one chunk from the response.
@@ -1062,7 +1062,7 @@ Reads one chunk from the response.
.. rst-class:: classref-method
:ref:`Error<enum_@GlobalScope_Error>` **request**\ (\ method\: :ref:`Method<enum_HTTPClient_Method>`, url\: :ref:`String<class_String>`, headers\: :ref:`PackedStringArray<class_PackedStringArray>`, body\: :ref:`String<class_String>` = ""\ )
:ref:`Error<enum_@GlobalScope_Error>` **request**\ (\ method\: :ref:`Method<enum_HTTPClient_Method>`, url\: :ref:`String<class_String>`, headers\: :ref:`PackedStringArray<class_PackedStringArray>`, body\: :ref:`String<class_String>` = ""\ ) :ref:`🔗<class_HTTPClient_method_request>`
Sends a request to the connected host.
@@ -1101,7 +1101,7 @@ To create a POST request with query strings to push to the server, do:
.. rst-class:: classref-method
:ref:`Error<enum_@GlobalScope_Error>` **request_raw**\ (\ method\: :ref:`Method<enum_HTTPClient_Method>`, url\: :ref:`String<class_String>`, headers\: :ref:`PackedStringArray<class_PackedStringArray>`, body\: :ref:`PackedByteArray<class_PackedByteArray>`\ )
:ref:`Error<enum_@GlobalScope_Error>` **request_raw**\ (\ method\: :ref:`Method<enum_HTTPClient_Method>`, url\: :ref:`String<class_String>`, headers\: :ref:`PackedStringArray<class_PackedStringArray>`, body\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_HTTPClient_method_request_raw>`
Sends a raw request to the connected host.
@@ -1119,7 +1119,7 @@ Sends the body data raw, as a byte array and does not encode it in any way.
.. rst-class:: classref-method
|void| **set_http_proxy**\ (\ host\: :ref:`String<class_String>`, port\: :ref:`int<class_int>`\ )
|void| **set_http_proxy**\ (\ host\: :ref:`String<class_String>`, port\: :ref:`int<class_int>`\ ) :ref:`🔗<class_HTTPClient_method_set_http_proxy>`
Sets the proxy server for HTTP requests.
@@ -1133,7 +1133,7 @@ The proxy server is unset if ``host`` is empty or ``port`` is -1.
.. rst-class:: classref-method
|void| **set_https_proxy**\ (\ host\: :ref:`String<class_String>`, port\: :ref:`int<class_int>`\ )
|void| **set_https_proxy**\ (\ host\: :ref:`String<class_String>`, port\: :ref:`int<class_int>`\ ) :ref:`🔗<class_HTTPClient_method_set_https_proxy>`
Sets the proxy server for HTTPS requests.