HttpResponse React Native Reference Documentation

HttpResponse

Current Version: 11.6.1

Chilkat.HttpResponse

Inspect HTTP status, headers, cookies, redirects, and response bodies.

Chilkat.HttpResponse represents an HTTP response returned by certain Chilkat.Http methods. It provides access to the response status line, status code, headers, cookies, charset, content length, body bytes, body text, full MIME response, redirect URL, and helper methods for saving or loading the response body into Chilkat objects such as BinData, StringBuilder, JsonObject, JsonArray, and Xml.

Status and reason

Read the HTTP status code, status line, and related response information to determine whether the request succeeded, redirected, or failed.

Headers and cookies

Inspect response headers, retrieve individual header values, and access cookies returned by the server.

Body as text or bytes

Get the response body as raw bytes or decoded text, using the response charset information when appropriate.

Structured body loading

Load the body directly into JsonObject, JsonArray, Xml, BinData, or StringBuilder objects for further processing.

Redirect information

Access redirect-related information such as the redirect URL when the server responds with a redirect status.

Save and inspect responses

Save body content, inspect the full MIME-style response, and use response metadata for diagnostics, logging, or API troubleshooting.

Common pattern: Send a request with Chilkat.Http, check the StatusCode, inspect headers or cookies as needed, then retrieve the body in the form best suited to the response content: text, bytes, BinData, StringBuilder, JSON, or XML. Use HttpResponse for response inspection; use Chilkat.Http for the actual network request.

For an extended overview, see HttpResponse Class Overview.

Object Creation

// npm install @chilkat/react-native react-native-nitro-modules
// (React Native 0.76+ with the New Architecture; then `pod install` for iOS.  The Chilkat
//  native library is downloaded and verified during the native build -- see the package README.)

import { Chilkat, HttpResponse } from '@chilkat/react-native'

// Once per app start, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial')   // shorthand for new Global().unlockBundle(..)

const httpResponse = new HttpResponse()
// ... the native object is released when `httpResponse` is garbage collected, or now with httpResponse.dispose()

new HttpResponse()

Creates the underlying native Chilkat object. HttpResponse is a Nitro Module HybridObject: use it from the JavaScript thread only (it cannot be passed to a Worklet or another runtime). Every member is synchronous and blocks the JavaScript thread until Chilkat returns; a method that can take a while also exists as a ...Async twin returning a Promise, which runs the same call on a native worker thread so the UI keeps rendering. While such a call is pending, every other call on this object throws, except abort() and assigning onPercentDone / onProgressInfo.

dispose(): void

Releases the native object immediately instead of waiting for garbage collection (useful for a large BinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws. An object with a pending ...Async call cannot be disposed until the promise settles.

Errors

A method that can fail throws a plain Error: a method whose only outcome is success or failure returns void and throws on failure; a method producing a string or an object returns it and throws where Chilkat would have returned null. The error's message is "Class.method(...): reason", where the reason is the last informative line of the object's lastErrorText, which holds the full Chilkat log of the failed call. A ...Async twin rejects its promise with the same Error instead of throwing. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain boolean.

try {
  httpResponse.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // HttpResponse.someMethod(...): <reason>
  console.log(httpResponse.lastErrorText)   // the full Chilkat log of the failed call
}

// The same call without blocking the JavaScript thread:
try {
  await httpResponse.someMethodAsync(...)
} catch (e) {
  console.log((e as Error).message)   // HttpResponse.someMethodAsync: <reason>
}

Properties

BodyQP

// read-only
readonly bodyQP: string

The same as the Body property, but returned as a quoted-printable encoded string.

HttpResponse React Native Reference Documentation

HttpResponse

Current Version: 11.6.1

Inspect HTTP status, headers, cookies, redirects, and response bodies.

Status and reason

Headers and cookies

Body as text or bytes

Structured body loading

Redirect information

Save and inspect responses

Object Creation

Errors

Properties

BodyQP

BodyStr

Charset

ContentLength

ContentLength64

DateStr

DebugLogFilePath

Domain

FinalRedirectUrl

FullMime

Header

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

NumCookies

NumHeaderFields

StatusCode

StatusLine

StatusText

UncommonOptions

VerboseLogging

Version

Methods

GetBodyBd

GetBodyJarr

GetBodyJson

GetBodySb

GetBodyXml

GetCookieDomain

GetCookieExpiresStr

GetCookieName

GetCookiePath

GetCookieValue

GetHeaderField

GetHeaderFieldAttr

GetHeaderName

GetHeaderValue

SaveBodyBinary

SaveBodyText

UrlEncParamValue