(JavaScript) Download File from Dropbox

Downloads a file from Dropbox.

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.

var success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// A Dropbox access token should have been previously obtained.
// Dropbox access tokens do not expire.
// See Dropbox Access Token.

var rest = new CkRest();

// Connect to Dropbox
success = rest.Connect("content.dropboxapi.com",443,true,true);
if (success == false) {
    console.log(rest.LastErrorText);
    return;
}

// Add request headers.
rest.AddHeader("Authorization","Bearer DROPBOX_ACCESS_TOKEN");

// The download "parameters" are contained in JSON passed in an HTTP request header.
// This is the JSON indicating the file to be downloaded:
// { 
//    "path": "/Homework/lit/hamlet.xml",
// }

var json = new CkJsonObject();
json.AppendString("path","/Homework/lit/hamlet.xml");
rest.AddHeader("Dropbox-API-Arg",json.Emit());

var bd = new CkBinData();
success = rest.FullRequestNoBodyBd("POST","/2/files/download",bd);
if (success == false) {
    console.log(rest.LastErrorText);
    return;
}

// When successful, Dropbox responds with a 200 response code.
if (rest.ResponseStatusCode !== 200) {
    // Examine the request/response to see what happened.
    console.log("response status code = " + rest.ResponseStatusCode);
    console.log("response status text = " + rest.ResponseStatusText);
    console.log("response header: " + rest.ResponseHeader);
    console.log("response body (if any): " + bd.GetString("utf-8"));
    console.log("---");
    console.log("LastRequestStartLine: " + rest.LastRequestStartLine);
    console.log("LastRequestHeader: " + rest.LastRequestHeader);
    return;
}

// The file was downloaded into bd.
// Save it to the filesystem.
success = bd.WriteFile("c:/temp/qa_output/hamlet.xml");

// Information about the downloaded file is also available as JSON in a response header.
// The "dropbox-api-result" response header contains the information.  For example:
var apiResult = rest.ResponseHdrByName("dropbox-api-result");
console.log(apiResult);

// In this case, the pretty-formatted dropbox-api-result JSON looks like this:
// { 
//   "name": "hamlet.xml",
//   "path_lower": "/homework/lit/hamlet.xml",
//   "path_display": "/Homework/lit/hamlet.xml",
//   "id": "id:74FkdeNuyKAAAAAAAAAAAQ",
//   "client_modified": "2016-06-02T23:19:00Z",
//   "server_modified": "2016-06-02T23:19:00Z",
//   "rev": "9482db15f",
//   "size": 279658
// }

// Load the JSON, pretty-print it, and demonstrate how to get some values...
var jsonResult = new CkJsonObject();
jsonResult.EmitCompact = false;
jsonResult.Load(apiResult);
// Show the JSON pretty-printed...
console.log(jsonResult.Emit());

// Sample code to get data from the JSON response:
var size = jsonResult.IntOf("size");
console.log("size = " + size);

var rev = jsonResult.StringOf("rev");
console.log("rev = " + rev);

var clientModified = jsonResult.StringOf("client_modified");
var ckdt = new CkDateTime();
ckdt.SetFromTimestamp(clientModified);
var bLocalTime = true;
var dt = new CkDtObj();
ckdt.ToDtObj(bLocalTime,dt);

console.log(dt.Day + "/" + dt.Month + "/" + dt.Year + " " + dt.Hour + ":" + dt.Minute);