Node.js

REST Upload Bandwidth Throttle

See more REST Examples

Demonstrates how to use upload bandwidth throttling with the REST API. This example will upload a file to Drobox using a file stream, with a limit on the bandwidth that can be used for the transfer. Node.js

NODEJS_PRELUDE

function chilkatExample() {

    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.

    //  To use bandwidth throttling, the connection should be made using the socket API.
    //  This provides numerous properties to customize the connection, such as
    //  BandwidthThrottleDown, BandwidthThrottleUp, ClientIpAddress, ClintPort, Http Proxy,
    //  KeepAlive, PreferIpv6, RequireSslCertVerify, SoRcvBuf, SoSndBuf, SoReuseAddr,
    //  SOCKS proxy, TcpNoSDelay, TlsPinSet, TlsCipherSuite, SslAllowedCiphers, etc.

    var socket = new chilkat.Socket();
    var maxWaitMs = 5000;
    success = socket.Connect("content.dropboxapi.com",443,true,maxWaitMs);
    if (success !== true) {
        console.log(socket.LastErrorText);
        console.log("Connect Fail Reason: " + socket.ConnectFailReason);
        return;
    }

    //  Set the upload bandwidth throttle rate to 50000 bytes per second.
    socket.BandwidthThrottleUp = 50000;

    var rest = new chilkat.Rest();

    //  Tell the REST object to use the connected socket.
    rest.UseConnection(socket,true);

    //  The remainder of this example is identical to the example at:
    //  Dropbox File Stream Upload.

    //  Add request headers.
    rest.AddHeader("Content-Type","application/octet-stream");
    rest.AddHeader("Authorization","Bearer DROPBOX_ACCESS_TOKEN");

    //  The upload "parameters" contained in JSON passed in an HTTP request header.
    //  This is the JSON to be added in this example:
    //  { 
    //     "path": "/Homework/lit/hamlet.xml",
    //     "mode": "add",
    //     "autorename": true,
    //     "mute": false
    //  }

    var json = new chilkat.JsonObject();
    json.AppendString("path","/Homework/lit/hamlet.xml");
    json.AppendString("mode","add");
    json.AppendBool("autorename",true);
    json.AppendBool("mute",false);
    rest.AddHeader("Dropbox-API-Arg",json.Emit());

    //  Almost ready to go...
    //  Let's setup a file stream to point to a file.
    var fileStream = new chilkat.Stream();
    fileStream.SourceFile = "qa_data/xml/hamlet.xml";

    //  Do the upload.  The URL is https://content.dropboxapi.com/2/files/upload.
    //  We already connected to content.dropboxapi.com using TLS (i.e. HTTPS),
    //  so now we only need to specify the path "/2/files/upload".

    //  Note: The file is streamed directly from disk.  (The entire
    //  file will not be loaded into memory.)
    var responseStr = rest.FullRequestStream("POST","/2/files/upload",fileStream);
    if (rest.LastMethodSuccess == 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): " + responseStr);
        console.log("---");
        console.log("LastRequestStartLine: " + rest.LastRequestStartLine);
        console.log("LastRequestHeader: " + rest.LastRequestHeader);
        return;
    }

    //  The response is JSON.
    var jsonResp = new chilkat.JsonObject();
    jsonResp.EmitCompact = false;
    jsonResp.Load(responseStr);

    //  Show the JSON response.
    console.log(jsonResp.Emit());

    //  Returns JSON that 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
    //  }

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

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

    var clientModified = jsonResp.StringOf("client_modified");
    var ckdt = new chilkat.CkDateTime();
    ckdt.SetFromTimestamp(clientModified);
    var bLocalTime = true;
    var dt = new chilkat.DtObj();
    ckdt.ToDtObj(bLocalTime,dt);

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

}

chilkatExample();