Added classref for HTTPClient and HTTPRequest

(cherry picked from commit 4c5439f8cd)
This commit is contained in:
J08nY 2016-06-03 18:01:16 +02:00 committed by Rémi Verschelde
parent f97cbdec8f
commit 8ea940e99b
1 changed files with 14 additions and 2 deletions

View File

@ -13434,8 +13434,11 @@ This approximation makes straight segments between each point, then subdivides t
</class> </class>
<class name="HTTPClient" inherits="Reference" category="Core"> <class name="HTTPClient" inherits="Reference" category="Core">
<brief_description> <brief_description>
Hyper-text transfer protocol client.
</brief_description> </brief_description>
<description> <description>
Hyper-text transfer protocol client. Supports SSL and SSL server certificate verification.
Can be reused to connect to different hosts and make many requests.
</description> </description>
<methods> <methods>
<method name="connect"> <method name="connect">
@ -13459,6 +13462,7 @@ This approximation makes straight segments between each point, then subdivides t
<argument index="0" name="connection" type="StreamPeer"> <argument index="0" name="connection" type="StreamPeer">
</argument> </argument>
<description> <description>
Set connection to use, for this client.
</description> </description>
</method> </method>
<method name="request"> <method name="request">
@ -13504,30 +13508,35 @@ This approximation makes straight segments between each point, then subdivides t
</method> </method>
<method name="close"> <method name="close">
<description> <description>
Cloces the current connection, allows for reusal of [HTTPClient].
</description> </description>
</method> </method>
<method name="has_response" qualifiers="const"> <method name="has_response" qualifiers="const">
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
Return whether this [HTTPClient] has a response available.
</description> </description>
</method> </method>
<method name="is_response_chunked" qualifiers="const"> <method name="is_response_chunked" qualifiers="const">
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
Return whether this [HTTPClient] has a response that is chunked.
</description> </description>
</method> </method>
<method name="get_response_code" qualifiers="const"> <method name="get_response_code" qualifiers="const">
<return type="int"> <return type="int">
</return> </return>
<description> <description>
Return the HTTP status code of the response.
</description> </description>
</method> </method>
<method name="get_response_headers"> <method name="get_response_headers">
<return type="StringArray"> <return type="StringArray">
</return> </return>
<description> <description>
Return the response headers.
</description> </description>
</method> </method>
<method name="get_response_headers_as_dictionary"> <method name="get_response_headers_as_dictionary">
@ -13543,32 +13552,35 @@ Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
<return type="int"> <return type="int">
</return> </return>
<description> <description>
Return the response's body length.
</description> </description>
</method> </method>
<method name="read_response_body_chunk"> <method name="read_response_body_chunk">
<return type="RawArray"> <return type="RawArray">
</return> </return>
<description> <description>
Reads one chunk from the response.
</description> </description>
</method> </method>
<method name="set_read_chunk_size"> <method name="set_read_chunk_size">
<argument index="0" name="bytes" type="int"> <argument index="0" name="bytes" type="int">
</argument> </argument>
<description> <description>
Sets the size of the buffer used and maximum bytes to read per iteration Sets the size of the buffer used and maximum bytes to read per iteration. see [method read_response_body_chunk]
</description> </description>
</method> </method>
<method name="set_blocking_mode"> <method name="set_blocking_mode">
<argument index="0" name="enabled" type="bool"> <argument index="0" name="enabled" type="bool">
</argument> </argument>
<description> <description>
If set to true, execute will wait until all data is read from the response. If set to true, execution will block until all data is read from the response.
</description> </description>
</method> </method>
<method name="is_blocking_mode_enabled" qualifiers="const"> <method name="is_blocking_mode_enabled" qualifiers="const">
<return type="bool"> <return type="bool">
</return> </return>
<description> <description>
Return whether blocking mode is enabled.
</description> </description>
</method> </method>
<method name="get_status" qualifiers="const"> <method name="get_status" qualifiers="const">