HttpRequestBuilder
A builder for HTTP request
This page is a WIP. It contains all the information in Figura's documentation but we're working on adding more helpful descriptions.
getBody()
Returns body of this request
- Overload 1
- Overload 2
Example:
-- example coming soon
getHeaders()
Returns table with all headers set for this request
getHeaders()
Returns:
| Type | Description |
|---|---|
Table | - |
Example:
-- example coming soon
getMethod()
Returns method of this request
getMethod()
Returns:
| Type | Description |
|---|---|
String | - |
Example:
-- example coming soon
getUri()
Returns URI of this request
getUri()
Returns:
| Type | Description |
|---|---|
String | - |
Example:
-- example coming soon
body()
Sets body for this request, returns itself for chaining. If data is nil request will be sent without body
- Overload 1
- Overload 2
body(data)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| data | InputStream | - | - |
Returns:
| Type | Description |
|---|---|
HttpRequestBuilder | Returns self for chaining |
body(data)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| data | Buffer | - | - |
Returns:
| Type | Description |
|---|---|
HttpRequestBuilder | Returns self for chaining |
Example:
-- example coming soon
header()
Sets header for this request, returns itself for chaining. If value is nil header will be removed
header(header, value)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| header | String | - | - |
| value | String | - | - |
Returns:
| Type | Description |
|---|---|
HttpRequestBuilder | Returns self for chaining |
Example:
-- example coming soon
method()
Sets method for this request, returns itself for chaining. If method is nil default value - "GET", will be used
method(method)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| method | String | - | - |
Returns:
| Type | Description |
|---|---|
HttpRequestBuilder | Returns self for chaining |
Example:
-- example coming soon
send()
Sends this request and returns Future object that will contain response object once request is done
send()
Returns:
| Type | Description |
|---|---|
Future | - |
Example:
-- example coming soon
uri()
Sets URI for this request, returns itself for chaining
uri(uri)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
| uri | String | - | - |
Returns:
| Type | Description |
|---|---|
HttpRequestBuilder | Returns self for chaining |
Example:
-- example coming soon