JavaScript

Clear a REST Response Body Stream Destination

Demonstrates Rest.ClearResponseBodyStream, which removes a response-stream destination previously configured with SetResponseBodyStream.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background. Clearing the destination restores normal behavior, in which the full-request convenience methods return the response body rather than streaming it.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

var rest = new CkRest();
var bTls = true;
var bAutoReconnect = true;
success = rest.Connect("example.com",443,bTls,bAutoReconnect);
if (success == false) {
    console.log(rest.LastErrorText);
    return;
}

//  The file paths are relative to the application's current working directory.  Absolute paths
//  may also be used.  Supply the paths appropriate to your own environment.

var respStream = new CkStream();
respStream.SinkFile = "qa_output/response_body.dat";
var bAutoSetCharset = true;
var expectedStatus = 200;
success = rest.SetResponseBodyStream(expectedStatus,bAutoSetCharset,respStream);
if (success == false) {
    console.log(rest.LastErrorText);
    return;
}

//  Clear the response-stream destination previously configured, so subsequent full-request calls
//  return the response body normally instead of streaming it.
rest.ClearResponseBodyStream();

console.log("Response body streaming cleared.");