APIResponse

APIResponse class represents responses returned by APIRequestContext.get() and similar methods.

---

Methods

body

Added in: v1.16 apiResponse.body

Returns the buffer with response body.

Usage

APIResponse.body();

Returns

• byte[]#

---

dispose

Added in: v1.16 apiResponse.dispose

Disposes the body of this response. If not called then the body will stay in memory until the context closes.

Usage

APIResponse.dispose();

Returns

• void#

---

headers

Added in: v1.16 apiResponse.headers

An object with all the response HTTP headers associated with this response.

Usage

APIResponse.headers();

Returns

• Map<String, String>#

---

headersArray

Added in: v1.16 apiResponse.headersArray

An array with all the response HTTP headers associated with this response. Header names are not lower-cased. Headers with multiple entries, such as Set-Cookie, appear in the array multiple times.

Usage

APIResponse.headersArray();

Returns

• List<HttpHeader>#

  • name String

    Name of the header.

  • value String

    Value of the header.

---

ok

Added in: v1.16 apiResponse.ok

Contains a boolean stating whether the response was successful (status in the range 200-299) or not.

Usage

APIResponse.ok();

Returns

• boolean#

---

status

Added in: v1.16 apiResponse.status

Contains the status code of the response (e.g., 200 for a success).

Usage

APIResponse.status();

Returns

• int#

---

statusText

Added in: v1.16 apiResponse.statusText

Contains the status text of the response (e.g. usually an "OK" for a success).

Usage

APIResponse.statusText();

Returns

• String#

---

text

Added in: v1.16 apiResponse.text

Returns the text representation of response body.

Usage

APIResponse.text();

Returns

• String#

---

url

Added in: v1.16 apiResponse.url

Contains the URL of the response.

Usage

APIResponse.url();

Returns

• String#