Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 2.1
Branches Tags
godot-docs
/
classes
/
class_httprequest.rst

class_httprequest.rst 13 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_HTTPRequest:
    5. 

  5. 

  6. HTTPRequest
    7. 

  7. ===========
    8. 

  8. 

  9. **Inherits:** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Category:** Core
    12. 

  12. 

  13. Brief Description
    14. 

  14. -----------------
    15. 

  15. 

  16. A Node with the ability to send HTTP requests.
    17. 

  17. 

  18. Member Functions
    19. 

  19. ----------------
    20. 

  20. 

  21. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22. | void                         | :ref:`cancel_request<class_HTTPRequest_cancel_request>`  **(** **)**                                                                                                                                                                                                                         |
    23. 

  23. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | :ref:`int<class_int>`        | :ref:`get_body_size<class_HTTPRequest_get_body_size>`  **(** **)** const                                                                                                                                                                                                                     |
    25. 

  25. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`int<class_int>`        | :ref:`get_body_size_limit<class_HTTPRequest_get_body_size_limit>`  **(** **)** const                                                                                                                                                                                                         |
    27. 

  27. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`String<class_string>`  | :ref:`get_download_file<class_HTTPRequest_get_download_file>`  **(** **)** const                                                                                                                                                                                                             |
    29. 

  29. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`int<class_int>`        | :ref:`get_downloaded_bytes<class_HTTPRequest_get_downloaded_bytes>`  **(** **)** const                                                                                                                                                                                                       |
    31. 

  31. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`int<class_int>`        | :ref:`get_http_client_status<class_HTTPRequest_get_http_client_status>`  **(** **)** const                                                                                                                                                                                                   |
    33. 

  33. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`int<class_int>`        | :ref:`get_max_redirects<class_HTTPRequest_get_max_redirects>`  **(** **)** const                                                                                                                                                                                                             |
    35. 

  35. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`bool<class_bool>`      | :ref:`is_using_threads<class_HTTPRequest_is_using_threads>`  **(** **)** const                                                                                                                                                                                                               |
    37. 

  37. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`int<class_int>`        | :ref:`request<class_HTTPRequest_request>`  **(** :ref:`String<class_string>` url, :ref:`StringArray<class_stringarray>` custom_headers=StringArray([]), :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`int<class_int>` method=0, :ref:`String<class_string>` request_data=""  **)** |
    39. 

  39. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | void                         | :ref:`set_body_size_limit<class_HTTPRequest_set_body_size_limit>`  **(** :ref:`int<class_int>` bytes  **)**                                                                                                                                                                                  |
    41. 

  41. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | void                         | :ref:`set_download_file<class_HTTPRequest_set_download_file>`  **(** :ref:`String<class_string>` path  **)**                                                                                                                                                                                 |
    43. 

  43. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | void                         | :ref:`set_max_redirects<class_HTTPRequest_set_max_redirects>`  **(** :ref:`int<class_int>` amount  **)**                                                                                                                                                                                     |
    45. 

  45. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | void                         | :ref:`set_use_threads<class_HTTPRequest_set_use_threads>`  **(** :ref:`bool<class_bool>` enable  **)**                                                                                                                                                                                       |
    47. 

  47. +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. 

  49. Signals
    50. 

  50. -------
    51. 

  51. 

  52. -  **request_completed**  **(** :ref:`int<class_int>` result, :ref:`int<class_int>` response_code, :ref:`StringArray<class_stringarray>` headers, :ref:`RawArray<class_rawarray>` body  **)**
    53. 

  53. This signal is emitted upon request completion.
    54. 

  54. 

  55. 

  56. Numeric Constants
    57. 

  57. -----------------
    58. 

  58. 

  59. - **RESULT_SUCCESS** = **0** --- Request successful.
    60. 

  60. - **RESULT_CHUNKED_BODY_SIZE_MISMATCH** = **1**
    61. 

  61. - **RESULT_CANT_CONNECT** = **2** --- Request failed while connecting.
    62. 

  62. - **RESULT_CANT_RESOLVE** = **3** --- Request failed while resolving.
    63. 

  63. - **RESULT_CONNECTION_ERROR** = **4** --- Request failed due to connection(read/write) error.
    64. 

  64. - **RESULT_SSL_HANDSHAKE_ERROR** = **5** --- Request failed on SSL handshake.
    65. 

  65. - **RESULT_NO_RESPONSE** = **6** --- Request does not have a response(yet).
    66. 

  66. - **RESULT_BODY_SIZE_LIMIT_EXCEEDED** = **7** --- Request exceded its maximum size limit, see :ref:`set_body_size_limit<class_HTTPRequest_set_body_size_limit>`.
    67. 

  67. - **RESULT_REQUEST_FAILED** = **8** --- Request failed. (unused)
    68. 

  68. - **RESULT_DOWNLOAD_FILE_CANT_OPEN** = **9** --- HTTPRequest couldn't open the download file.
    69. 

  69. - **RESULT_DOWNLOAD_FILE_WRITE_ERROR** = **10** --- HTTPRequest couldn't write to the download file.
    70. 

  70. - **RESULT_REDIRECT_LIMIT_REACHED** = **11** --- Request reached its maximum redirect limit, see :ref:`set_max_redirects<class_HTTPRequest_set_max_redirects>`.
    71. 

  71. 

  72. Description
    73. 

  73. -----------
    74. 

  74. 

  75. A Node with the ability to send HTTP requests. Uses a :ref:`HTTPClient<class_httpclient>` internally, supports HTTPS.
    76. 

  76. 

  77. Can be used to make HTTP requests or download files via HTTP.
    78. 

  78. 

  79. Member Function Description
    80. 

  80. ---------------------------
    81. 

  81. 

  82. .. _class_HTTPRequest_cancel_request:
    83. 

  83. 

  84. - void  **cancel_request**  **(** **)**
    85. 

  85. 

  86. Cancel the current request.
    87. 

  87. 

  88. .. _class_HTTPRequest_get_body_size:
    89. 

  89. 

  90. - :ref:`int<class_int>`  **get_body_size**  **(** **)** const
    91. 

  91. 

  92. Return the response body length.
    93. 

  93. 

  94. .. _class_HTTPRequest_get_body_size_limit:
    95. 

  95. 

  96. - :ref:`int<class_int>`  **get_body_size_limit**  **(** **)** const
    97. 

  97. 

  98. Return current body size limit.
    99. 

  99. 

  100. .. _class_HTTPRequest_get_download_file:
    101. 

  101. 

  102. - :ref:`String<class_string>`  **get_download_file**  **(** **)** const
    103. 

  103. 

  104. Return the file this request will download into.
    105. 

  105. 

  106. .. _class_HTTPRequest_get_downloaded_bytes:
    107. 

  107. 

  108. - :ref:`int<class_int>`  **get_downloaded_bytes**  **(** **)** const
    109. 

  109. 

  110. Return the amount of bytes this HTTPRequest downloaded.
    111. 

  111. 

  112. .. _class_HTTPRequest_get_http_client_status:
    113. 

  113. 

  114. - :ref:`int<class_int>`  **get_http_client_status**  **(** **)** const
    115. 

  115. 

  116. Return the current status of the underlying :ref:`HTTPClient<class_httpclient>`.
    117. 

  117. 

  118. .. _class_HTTPRequest_get_max_redirects:
    119. 

  119. 

  120. - :ref:`int<class_int>`  **get_max_redirects**  **(** **)** const
    121. 

  121. 

  122. Return the maximum amount of redirects that will be followed.
    123. 

  123. 

  124. .. _class_HTTPRequest_is_using_threads:
    125. 

  125. 

  126. - :ref:`bool<class_bool>`  **is_using_threads**  **(** **)** const
    127. 

  127. 

  128. Whether this request is using threads.
    129. 

  129. 

  130. .. _class_HTTPRequest_request:
    131. 

  131. 

  132. - :ref:`int<class_int>`  **request**  **(** :ref:`String<class_string>` url, :ref:`StringArray<class_stringarray>` custom_headers=StringArray([]), :ref:`bool<class_bool>` ssl_validate_domain=true, :ref:`int<class_int>` method=0, :ref:`String<class_string>` request_data=""  **)**
    133. 

  133. 

  134. 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.
    135. 

  135. 

  136. The custom_headers are HTTP request headers which will be used. If User-Agent is not specified a Godot specific will be used.
    137. 

  137. 

  138. The ssl_validate_domain specifies if in case of HTTPS the server certificate should be verified.
    139. 

  139. 

  140. .. _class_HTTPRequest_set_body_size_limit:
    141. 

  141. 

  142. - void  **set_body_size_limit**  **(** :ref:`int<class_int>` bytes  **)**
    143. 

  143. 

  144. Set the response body size limit.
    145. 

  145. 

  146. .. _class_HTTPRequest_set_download_file:
    147. 

  147. 

  148. - void  **set_download_file**  **(** :ref:`String<class_string>` path  **)**
    149. 

  149. 

  150. Set the file to download into. Outputs the response body into the file.
    151. 

  151. 

  152. .. _class_HTTPRequest_set_max_redirects:
    153. 

  153. 

  154. - void  **set_max_redirects**  **(** :ref:`int<class_int>` amount  **)**
    155. 

  155. 

  156. Set the maximum amount of redirects the request will follow.
    157. 

  157. 

  158. .. _class_HTTPRequest_set_use_threads:
    159. 

  159. 

  160. - void  **set_use_threads**  **(** :ref:`bool<class_bool>` enable  **)**
    161. 

  161. 

  162. Make this HTTPRequest use threads.
    163. 

  163. 

  164.