@chilkat/react-native 11.6.1

package/src/specs/HttpResponse.nitro.ts

@@ -0,0 +1,424 @@
+// Generated by ReactNativeNs.RnGenerator -- do not edit.
+import type { HybridObject } from 'react-native-nitro-modules'
+import type { BinData } from './BinData.nitro'
+import type { JsonArray } from './JsonArray.nitro'
+import type { JsonObject } from './JsonObject.nitro'
+import type { StringBuilder } from './StringBuilder.nitro'
+import type { Xml } from './Xml.nitro'
+
+/**
+ * Inspect HTTP status, headers, cookies, redirects, and response bodies.
+ *
+ * `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](https://www.chilkatsoft.com/httpresponse_class_overview.asp).
+ *
+ * Each `HttpResponse` instance owns a native Chilkat object. It is released when the JavaScript
+ * object is
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
+ * Create one with `new HttpResponse()`.
+ */
+export interface HttpResponse extends HybridObject<{ ios: 'c++', android: 'c++' }> {
+  // ---- Properties ----
+
+  /**
+   * Provides HTML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorHtml: string
+
+  /**
+   * Provides plain text information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorText: string
+
+  /**
+   * Provides XML-formatted information about the last called method or property. If a method call
+   * fails or behaves unexpectedly, check this property for details. Note that information is
+   * available regardless of the method call's success.
+   *
+   * This property is read-only.
+   */
+  readonly lastErrorXml: string
+
+  /**
+   * Version of the component/library, such as "10.1.0"
+   *
+   * This property is read-only.
+   */
+  readonly version: string
+
+  /**
+   * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
+   * call to the specified file. This logging helps identify the context and history of Chilkat
+   * calls leading up to any crash or hang, aiding in debugging.
+   *
+   * Enabling the VerboseLogging property provides more detailed information.
+   *
+   * This property is mainly used for debugging rare instances where a Chilkat method call causes a
+   * hang or crash, which should generally not happen.
+   *
+   * Possible causes of hangs include:
+   *
+   * - A timeout property set to 0, indicating an infinite timeout.
+   *
+   * - A hang occurring within an event callback in the application code.
+   *
+   * - An internal bug in the Chilkat code causing the hang.
+   */
+  debugLogFilePath: string
+
+  /**
+   * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
+   * contain more verbose information. The default value is `false`. Verbose logging should only be
+   * used for debugging. The potentially large quantity of logged information may adversely affect
+   * peformance.
+   */
+  verboseLogging: boolean
+
+  /**
+   * Indicates the success or failure of the most recent method call: `true` means success, `false`
+   * means failure. This property remains unchanged by property setters or getters. This method is
+   * present to address challenges in checking for null or Nothing returns in certain programming
+   * languages. Note: This property does not apply to methods that return integer values or to
+   * boolean-returning methods where the boolean does not indicate success or failure.
+   */
+  lastMethodSuccess: boolean
+
+  /**
+   * The same as the Body property, but returned as a quoted-printable encoded string.
+   *
+   * This property is read-only.
+   */
+  readonly bodyQP: string
+
+  /**
+   * The response body returned as a string.
+   *
+   * This property is read-only.
+   */
+  readonly bodyStr: string
+
+  /**
+   * The response charset, such as `iso-8859-1`, if applicable. Obviously, responses for GIF and JPG
+   * files will not have a charset.
+   *
+   * This property is read-only.
+   */
+  readonly charset: string
+
+  /**
+   * The content length of the response, in bytes.
+   *
+   * This property is read-only.
+   */
+  readonly contentLength: number
+
+  /**
+   * The content length of the response, in number of bytes, returned as a 64-bit integer.
+   *
+   * This property is read-only.
+   *
+   * A 64-bit integer in Chilkat; JavaScript numbers are exact up to 2^53.
+   */
+  readonly contentLength64: number
+
+  /**
+   * Returns the content of the Date response header field in RFC822 date/time string format.
+   *
+   * This property is read-only.
+   */
+  readonly dateStr: string
+
+  /**
+   * The domain of the HTTP server that created this response.
+   *
+   * This property is read-only.
+   */
+  readonly domain: string
+
+  /**
+   * Returns the redirect URL for 301/302 responses.
+   *
+   * This property is read-only.
+   */
+  readonly finalRedirectUrl: string
+
+  /**
+   * Returns the full MIME (header + body) of the HTTP response.
+   *
+   * This property is read-only.
+   */
+  readonly fullMime: string
+
+  /**
+   * The full text of the response header.
+   *
+   * This property is read-only.
+   */
+  readonly header: string
+
+  /**
+   * The number of cookies included in the response.
+   *
+   * This property is read-only.
+   */
+  readonly numCookies: number
+
+  /**
+   * The number of response header fields.
+   *
+   * This property is read-only.
+   */
+  readonly numHeaderFields: number
+
+  /**
+   * The status code (as an integer) from the first line of an HTTP response. If the StatusLine =
+   * `HTTP/1.0 200 OK`, the response status code returned is 200.
+   *
+   * This property is read-only.
+   */
+  readonly statusCode: number
+
+  /**
+   * The first line of an HTTP response, such as `HTTP/1.0 200 OK`.
+   *
+   * This property is read-only.
+   */
+  readonly statusLine: string
+
+  /**
+   * The text that follows the status code in the 1st line of the HTTP response. For example, i the
+   * first line of an HTTP response is `HTTP/1.0 200 OK`, then this property contains `OK`.
+   *
+   * This property is read-only.
+   */
+  readonly statusText: string
+
+  /**
+   * This is a catch-all property to be used for uncommon needs. Can be set to a list of the
+   * following comma separated keywords:
+   *
+   * - `TakeResponseBody` - Introduced in v9.5.0.89. The GetBody\* methods will transfer the body to
+   *   the target object instead of copying the contents. This can be useful if the response body is
+   *   extremely large because it will reduce the overall memory requirement.
+   */
+  uncommonOptions: string
+
+  // ---- Methods ----
+
+  /**
+   * Returns the domain of the Nth cookie in the response. Indexing begins at 0. The number of
+   * response cookies is specified in the NumCookies property.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getCookieDomain(index: number): string
+
+  /**
+   * Returns the expiration date/time of the Nth cookie in the response. Indexing begins at 0. The
+   * number of response cookies is specified in the NumCookies property.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getCookieExpiresStr(index: number): string
+
+  /**
+   * Returns the name of the Nth cookie returned in the response. Indexing begins at 0. The number
+   * of response cookies is specified in the NumCookies property.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getCookieName(index: number): string
+
+  /**
+   * Returns the path of the Nth cookie returned in the response. Indexing begins at 0. The number
+   * of response cookies is specified in the NumCookies property.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getCookiePath(index: number): string
+
+  /**
+   * Returns the value of the Nth cookie returned in the response. Indexing begins at 0. The number
+   * of response cookies is specified in the NumCookies property.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getCookieValue(index: number): string
+
+  /**
+   * Returns the value of a response header field accessed by field name.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getHeaderField(fieldName: string): string
+
+  /**
+   * Returns a response header field attribute. As an example, the response charset is simply the
+   * GetHeaderFieldAttr(`content-type`,`charset`)
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getHeaderFieldAttr(fieldName: string, attrName: string): string
+
+  /**
+   * Gets the name of the Nth response header field. Indexing begins at 0. The number of response
+   * headers is specified by the NumHeaderFields property.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getHeaderName(index: number): string
+
+  /**
+   * Gets the value of the Nth response header field. Indexing begins at 0. The number of response
+   * headers is specified by the NumHeaderFields property.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getHeaderValue(index: number): string
+
+  /**
+   * Saves the body of the HTTP response to a file.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  saveBodyBinary(path: string): void
+
+  /**
+   * Saves the HTTP response body to a file. This method provides control over CRLF vs bare-LF
+   * line-endings. If `bCrlf` is `true`, then line endings are automatically converted to CRLF if
+   * necessary. If `bCrlf` is `false`, then line-endings are automatically converted to bare-LF's
+   * (Unix style) if necessary.
+   *
+   * To save the HTTP response body exactly as-is (with no line-ending manipulation), then call
+   * SaveBodyBinary.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  saveBodyText(bCrlf: boolean, path: string): void
+
+  /**
+   * Convenience method for parsing a param's value out of a URL-encoded param string. For example,
+   * if a caller passes the following string in `encodedParamString`:
+   *
+   * ```
+   * oauth_token=ABC&oauth_token_secret=123&oauth_callback_confirmed=true
+   * ```
+   *
+   * and `oauth_token_secret` in `paramName`, then the return value would be `123`.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  urlEncParamValue(encodedParamString: string, paramName: string): string
+
+  /**
+   * Copies the response body to a Chilkat StringBuilder object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getBodySb(sb: StringBuilder): void
+
+  /**
+   * Copies the response body to a BinData object.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getBodyBd(binData: BinData): void
+
+  /**
+   * Loads the JSON response body into a JsonObject. This method should only be called when it is
+   * known that the response body contains JSON (beginning with a curly brace '\{' and ending with a
+   * curly brace '\}')
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getBodyJson(json: JsonObject): void
+
+  /**
+   * Loads the JSON array response body into a JsonArray This method should only be called when it
+   * is known that the response body contains a JSON array (beginning with a square bracket '\[' and
+   * ending with a square bracket '\]')
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getBodyJarr(jarr: JsonArray): void
+
+  /**
+   * Loads the XML response body into an XML object. This method should only be called when it is
+   * known that the response body contains XML.
+   *
+   * @throws Error if the call fails (the message names the reason); the full log is in
+   * {@link HttpResponse.lastErrorText}.
+   */
+  getBodyXml(xml: Xml): void
+}