HttpResponse Node.js Reference Documentation

HttpResponse

Current Version: 10.1.2

Represents a complete HTTP response.

Object Creation

var obj = new chilkat.HttpResponse();

Properties

Body

· Buffer, read-only

The response body returned as a byte array.

top

BodyQP

· string, read-only

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

top

BodyStr

· string, read-only

The response body returned as a string.

top

Charset

· string, read-only

The response charset, such as "iso-8859-1", if applicable. Obviously, responses for GIF and JPG files will not have a charset.

top

ContentLength

· integer, read-only

The content length of the response, in bytes.

top

DateStr

· string, read-only

Returns the content of the Date response header field in RFC822 date/time string format.

top

DebugLogFilePath

· 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.

More Information and Examples

Example showing how to use DebugLogFilePath.

top

Domain

· string, read-only

The domain of the HTTP server that created this response.

top

FinalRedirectUrl

· string, read-only

Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

top

FullMime

· string, read-only

Returns the full MIME (header + body) of the HTTP response.

More Information and Examples

How to Access Parts of a multipart/related HTTP Response

top

Header

· string, read-only

The full text of the response header.

top

LastErrorHtml

· string, read-only

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.

top

LastErrorText

· string, read-only

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

top

LastErrorXml

· string, read-only

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.

top

LastMethodSuccess

· 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.

top

NumCookies

· integer, read-only

The number of cookies included in the response.

top

NumHeaderFields

· integer, read-only

The number of response header fields.

top

StatusCode

· integer, read-only

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.

top

StatusLine

· string, read-only

The first line of an HTTP response, such as "HTTP/1.0 200 OK".

top

StatusText

· string, read-only

Introduced in version 9.5.0.49

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".

top

UncommonOptions

· string

Introduced in version 9.5.0.89

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.

top

VerboseLogging

· boolean

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.

top

Version

· string, read-only

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

top

Methods

GetBodyBd

var status = GetBodyBd(binData);

· Returns Boolean (true for success, false for failure).
· binData BinData

Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns true for success, false for failure.

More Information and Examples

Parse Multipart Binary Http Response

top

GetBodyJarr

var status = GetBodyJarr(jarr);

· Returns Boolean (true for success, false for failure).
· jarr JsonArray

Introduced in version 9.5.0.89

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 ']')

Returns true for success, false for failure.

More Information and Examples

Load JSON Array from HTTP Response Body

top

GetBodyJson

var status = GetBodyJson(json);

· Returns Boolean (true for success, false for failure).
· json JsonObject

Introduced in version 9.5.0.89

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 '}')

Returns true for success, false for failure.

More Information and Examples

Load JSON Object from HTTP Response Body

top

GetBodySb

var status = GetBodySb(sb);

· Returns Boolean (true for success, false for failure).
· sb StringBuilder

Introduced in version 9.5.0.64

Copies the response body to a Chilkat StringBuilder object.

Returns true for success, false for failure.

top

GetBodyXml

var status = GetBodyXml(xml);

· Returns Boolean (true for success, false for failure).
· xml Xml

Introduced in version 9.5.0.89

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.

Returns true for success, false for failure.

More Information and Examples

Load XML Object from HTTP Response Body

top

GetCookieDomain

var retStr = GetCookieDomain(index);

· Returns a String.
· index Number

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.

Returns null on failure

top

GetCookieExpiresStr

var retStr = GetCookieExpiresStr(index);

· Returns a String.
· index Number

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.

Returns null on failure

top

GetCookieName

var retStr = GetCookieName(index);

· Returns a String.
· index Number

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.

Returns null on failure

top

GetCookiePath

var retStr = GetCookiePath(index);

· Returns a String.
· index Number

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.

Returns null on failure

top

GetCookieValue

var retStr = GetCookieValue(index);

· Returns a String.
· index Number

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.

Returns null on failure

top

GetHeaderField

var retStr = GetHeaderField(fieldName);

· Returns a String.
· fieldName String

Returns the value of a response header field accessed by field name.

Returns null on failure

top

GetHeaderFieldAttr

var retStr = GetHeaderFieldAttr(fieldName, attrName);

· Returns a String.
· fieldName String
· attrName String

Returns a response header field attribute. As an example, the response charset is simply the GetHeaderFieldAttr("content-type","charset")

Returns null on failure

top

GetHeaderName

var retStr = GetHeaderName(index);

· Returns a String.
· index Number

Gets the name of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.

Returns null on failure

top

GetHeaderValue

var retStr = GetHeaderValue(index);

· Returns a String.
· index Number

Gets the value of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.

Returns null on failure

top

LoadTaskResult

var status = LoadTaskResult(task);

· Returns Boolean (true for success, false for failure).
· task Task

Introduced in version 9.5.0.52

Loads the HTTP response from a completed asynchronous task. A failed return value indicates that no HTTP response was received in the HTTP asynchronous method call (i.e. the asynchronous HTTP request failed in such a way that no response was received).

Returns true for success, false for failure.

More Information and Examples

Getting the HTTP Response after an Asynchronous HTTP Request Completes

top

SaveBodyBinary

var status = SaveBodyBinary(path);

· Returns Boolean (true for success, false for failure).
· path String

Saves the body of the HTTP response to a file.

Returns true for success, false for failure.

More Information and Examples

IBM Cloud - Text to Speech - Synthesize Audio (POST)

top

SaveBodyText

var status = SaveBodyText(bCrlf, path);

· Returns Boolean (true for success, false for failure).
· bCrlf Boolean
· path String

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.

Returns true for success, false for failure.

top

UrlEncParamValue

var retStr = UrlEncParamValue(encodedParamString, paramName);

· Returns a String.
· encodedParamString String
· paramName String

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".

Returns null on failure

top