HttpResponse Node.js Reference Documentation

HttpResponse

Current Version: 9.5.0.73

Represents a complete HTTP response.

Object Creation

var obj = new chilkat.HttpResponse();

Properties

Body
Body
· Buffer, read-only

The response body returned as a byte array.

top
BodyQP
BodyQP
· string, read-only

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

top
BodyStr
BodyStr
· string, read-only

The response body returned as a string.

top
Charset
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
ContentLength
· integer, read-only

The content length of the response, in bytes.

top
DateStr
DateStr
· string, read-only

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

top
DebugLogFilePath
DebugLogFilePath
· string

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
Domain
Domain
· string, read-only

The domain of the HTTP server that created this response.

top
FinalRedirectUrl
FinalRedirectUrl
· string, read-only
Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

top
FullMime
FullMime
· string, read-only

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

top
Header
Header
· string, read-only

The full text of the response header.

top
LastErrorHtml
LastErrorHtml
· string, read-only

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText
· string, read-only

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml
· string, read-only

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess
· boolean
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumCookies
NumCookies
· integer, read-only

The number of cookies included in the response.

top
NumHeaderFields
NumHeaderFields
· integer, read-only

The number of response header fields.

top
StatusCode
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
StatusLine
· string, read-only

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

top
StatusText
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
VerboseLogging
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
Version
· string, read-only

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

top

Methods

GetBodyBd
var status = GetBodyBd(binData);
· Returns Boolean (true for success, false for failure).
· binDatabool
Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns true for success, false for failure.

top
GetBodySb
var status = GetBodySb(sb);
· Returns Boolean (true for success, false for failure).
· sbbool
Introduced in version 9.5.0.64

Copies the response body to a Chilkat StringBuilder object.

Returns true for success, false for failure.

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

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.

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
SaveLastError
var status = SaveLastError(path);
· Returns Boolean (true for success, false for failure).
· path String

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

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