JavaScript

Download a Binary REST Response into BinData

Demonstrates Rest.FullRequestNoBodyBd, which sends a request with no body and stores the binary response body in a BinData.

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. This method is appropriate when the response is binary, such as an image or file download, allowing the received bytes to be saved or processed directly.

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.

//  FullRequestNoBodyBd sends a request with no body and stores the binary response body in a
//  BinData.  This is appropriate when the response is binary, such as an image or file download.
var bdResponse = new CkBinData();
success = rest.FullRequestNoBodyBd("GET","/api/images/1",bdResponse);
if (success == false) {
    console.log(rest.LastErrorText);
    return;
}

var bSaved = bdResponse.WriteFile("qa_output/image.png");
if (bSaved !== true) {
    console.log("Failed to save the response body.");
    return;
}

console.log("Downloaded " + bdResponse.NumBytes + " bytes.");