diff options
| author | Poommetee Ketson <poommetee@protonmail.com> | 2018-04-20 16:25:06 +0700 |
|---|---|---|
| committer | Poommetee Ketson <poommetee@protonmail.com> | 2018-04-20 16:34:30 +0700 |
| commit | f05e24ed18575e2f48270025c4c2bb0705c667b5 (patch) | |
| tree | a64898e5f793655cd1ebb9918cc3ada6492a2867 /doc/classes | |
| parent | 59b816679e1c87d17ec48bfb5677fb9ff8a9ce5d (diff) | |
[DOCS] add HTTPRequest.request return values
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/HTTPRequest.xml | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 010ef6d9d5..ec9f86993f 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -55,6 +55,8 @@ <argument index="4" name="request_data" type="String" default=""""> </argument> <description> + Creates request on the underlying [HTTPClient]. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request]. + Returns [code]OK[/code] if request is successfully created. (Does not imply that the server has responded), [code]ERR_UNCONFIGURED[/code] if not in the tree, [code]ERR_BUSY[/code] if still processing previous request, [code]ERR_INVALID_PARAMETER[/code] if given string is not a valid URL format, or [code]ERR_CANT_CONNECT[/code] if not using thread and the [HTTPClient] cannot connect to host. </description> </method> </methods> |