HttpRequest React Native Reference Documentation

HttpRequest

Current Version: 11.6.1

Chilkat.HttpRequest

Build structured HTTP requests for use with Chilkat.Http.

Chilkat.HttpRequest is a helper class for constructing HTTP requests that are sent by Chilkat.Http. It does not perform network communication on its own. Instead, it provides structured control over the request method, HTTP version, path, headers, query parameters, form parameters, content type, request body, multipart uploads, streamed file bodies, and diagnostic request generation.

Request construction

Build an HTTP request object with the method, path, version, headers, parameters, and body settings required by the target endpoint.

Form parameters

Add name/value parameters for form posts and API requests that expect structured form data.

Custom headers

Set request headers such as content type, accept headers, authorization headers, or application-specific metadata.

Request bodies

Provide body content for POST, PUT, PATCH, or other methods that send data to a server.

Multipart and file uploads

Construct multipart/form-data requests, attach file parts, or stream a file as the request body when the API requires upload content.

Diagnostics

Generate a textual representation of the request to inspect headers, paths, parameters, body structure, and upload formatting before sending.

Common pattern: Create a HttpRequest, set the HTTP method and path, add any headers, parameters, body data, or file parts, then pass the request object to the appropriate Chilkat.Http method for sending. Use HttpRequest for structured or multipart requests; use simpler Http methods directly when only a basic GET, POST, upload, or download is needed.

For an extended overview, see HttpRequest 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, HttpRequest } 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 httpRequest = new HttpRequest()
// ... the native object is released when `httpRequest` is garbage collected, or now with httpRequest.dispose()

new HttpRequest()

Creates the underlying native Chilkat object. HttpRequest 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 {
  httpRequest.someMethod(...)
} catch (e) {
  console.log((e as Error).message)   // HttpRequest.someMethod(...): <reason>
  console.log(httpRequest.lastErrorText)   // the full Chilkat log of the failed call
}

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

Properties

Boundary

// read/write
boundary: string

Introduced in version 9.5.0.49

Sets an explicit boundary string to be used in multipart/form-data requests. If no Boundary is set, then a boundary string is automaticaly generated as needed during the sending of a request.

More Information and Examples

HttpRequest React Native Reference Documentation

HttpRequest

Current Version: 11.6.1

Build structured HTTP requests for use with Chilkat.Http.

Request construction

Form parameters

Custom headers

Request bodies

Multipart and file uploads

Diagnostics

Object Creation

Errors

Properties

Boundary

Charset

ContentType

DebugLogFilePath

EntireHeader

HttpVerb

HttpVersion

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

NumHeaderFields

NumParams

Path

SendCharset

VerboseLogging

Version

Methods

AddBdForUpload

AddFileForUpload

AddFileForUpload2

AddHeader

AddMwsSignature

AddParam

AddStringForUpload

AddStringForUpload2

AddSubHeader

GenerateRequestFile

GenerateRequestText

GetHeaderField

GetHeaderName

GetHeaderValue

GetParam

GetParamName

GetParamValue

GetUrlEncodedParams

LoadBodyFromBd

LoadBodyFromFile

LoadBodyFromSb

LoadBodyFromString

RemoveAllParams

RemoveHeader

RemoveParam

SetFromUrl

StreamBodyFromFile

StreamChunkFromFile