diff options
Diffstat (limited to 'doc/classes/HTTPRequest.xml')
| -rw-r--r-- | doc/classes/HTTPRequest.xml | 74 |
1 files changed, 13 insertions, 61 deletions
diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index a1a84d2211..7c37479295 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="HTTPRequest" inherits="Node" category="Core" version="3.0-alpha"> +<class name="HTTPRequest" inherits="Node" category="Core" version="3.0-beta"> <brief_description> A Node with the ability to send HTTP requests. </brief_description> @@ -26,13 +26,6 @@ Return the response body length. </description> </method> - <method name="get_body_size_limit" qualifiers="const"> - <return type="int"> - </return> - <description> - Return current body size limit. - </description> - </method> <method name="get_download_file" qualifiers="const"> <return type="String"> </return> @@ -54,20 +47,6 @@ Return the current status of the underlying [HTTPClient]. </description> </method> - <method name="get_max_redirects" qualifiers="const"> - <return type="int"> - </return> - <description> - Return the maximum amount of redirects that will be followed. - </description> - </method> - <method name="is_using_threads" qualifiers="const"> - <return type="bool"> - </return> - <description> - Whether this request is using threads. - </description> - </method> <method name="request"> <return type="int" enum="Error"> </return> @@ -84,15 +63,6 @@ <description> </description> </method> - <method name="set_body_size_limit"> - <return type="void"> - </return> - <argument index="0" name="bytes" type="int"> - </argument> - <description> - Set the response body size limit. - </description> - </method> <method name="set_download_file"> <return type="void"> </return> @@ -102,24 +72,6 @@ Set the file to download into. Outputs the response body into the file. </description> </method> - <method name="set_max_redirects"> - <return type="void"> - </return> - <argument index="0" name="amount" type="int"> - </argument> - <description> - Set the maximum amount of redirects the request will follow. - </description> - </method> - <method name="set_use_threads"> - <return type="void"> - </return> - <argument index="0" name="enable" type="bool"> - </argument> - <description> - Make this HTTPRequest use threads. - </description> - </method> </methods> <members> <member name="body_size_limit" type="int" setter="set_body_size_limit" getter="get_body_size_limit"> @@ -145,39 +97,39 @@ </signal> </signals> <constants> - <constant name="RESULT_SUCCESS" value="0"> + <constant name="RESULT_SUCCESS" value="0" enum="Result"> Request successful. </constant> - <constant name="RESULT_CHUNKED_BODY_SIZE_MISMATCH" value="1"> + <constant name="RESULT_CHUNKED_BODY_SIZE_MISMATCH" value="1" enum="Result"> </constant> - <constant name="RESULT_CANT_CONNECT" value="2"> + <constant name="RESULT_CANT_CONNECT" value="2" enum="Result"> Request failed while connecting. </constant> - <constant name="RESULT_CANT_RESOLVE" value="3"> + <constant name="RESULT_CANT_RESOLVE" value="3" enum="Result"> Request failed while resolving. </constant> - <constant name="RESULT_CONNECTION_ERROR" value="4"> + <constant name="RESULT_CONNECTION_ERROR" value="4" enum="Result"> Request failed due to connection(read/write) error. </constant> - <constant name="RESULT_SSL_HANDSHAKE_ERROR" value="5"> + <constant name="RESULT_SSL_HANDSHAKE_ERROR" value="5" enum="Result"> Request failed on SSL handshake. </constant> - <constant name="RESULT_NO_RESPONSE" value="6"> + <constant name="RESULT_NO_RESPONSE" value="6" enum="Result"> Request does not have a response(yet). </constant> - <constant name="RESULT_BODY_SIZE_LIMIT_EXCEEDED" value="7"> + <constant name="RESULT_BODY_SIZE_LIMIT_EXCEEDED" value="7" enum="Result"> Request exceeded its maximum size limit, see [method set_body_size_limit]. </constant> - <constant name="RESULT_REQUEST_FAILED" value="8"> + <constant name="RESULT_REQUEST_FAILED" value="8" enum="Result"> Request failed. (unused) </constant> - <constant name="RESULT_DOWNLOAD_FILE_CANT_OPEN" value="9"> + <constant name="RESULT_DOWNLOAD_FILE_CANT_OPEN" value="9" enum="Result"> HTTPRequest couldn't open the download file. </constant> - <constant name="RESULT_DOWNLOAD_FILE_WRITE_ERROR" value="10"> + <constant name="RESULT_DOWNLOAD_FILE_WRITE_ERROR" value="10" enum="Result"> HTTPRequest couldn't write to the download file. </constant> - <constant name="RESULT_REDIRECT_LIMIT_REACHED" value="11"> + <constant name="RESULT_REDIRECT_LIMIT_REACHED" value="11" enum="Result"> Request reached its maximum redirect limit, see [method set_max_redirects]. </constant> </constants> |