PureBasic

Download File from Dropbox into a String Variable

See more Dropbox Examples

Demonstrates how to download a file from Dropbox directly into a string variable. PureBasic

IncludeFile "CkDtObj.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkDateTime.pb"

Procedure ChilkatExample()

    success.i = 0

    ; 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.

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to Dropbox
    success = CkRest::ckConnect(rest,"content.dropboxapi.com",443,1,1)
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Add request headers.
    CkRest::ckAddHeader(rest,"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": "/jack.txt",
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckAppendString(json,"path","/jack.txt")
    CkRest::ckAddHeader(rest,"Dropbox-API-Arg",CkJsonObject::ckEmit(json))

    ; The content of the file on Dropbox is returned.
    fileContent.s = CkRest::ckFullRequestNoBody(rest,"POST","/2/files/download")
    If CkRest::ckLastMethodSuccess(rest) = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    ; When successful, Dropbox responds with a 200 response code.
    If CkRest::ckResponseStatusCode(rest) <> 200
        ; Examine the request/response to see what happened.
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body (if any): " + fileContent
        Debug "---"
        Debug "LastRequestStartLine: " + CkRest::ckLastRequestStartLine(rest)
        Debug "LastRequestHeader: " + CkRest::ckLastRequestHeader(rest)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    ; Show the file content that was downloaded:
    Debug fileContent
    Debug "----"

    ; 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:
    apiResult.s = CkRest::ckResponseHdrByName(rest,"dropbox-api-result")
    Debug apiResult

    ; In this case, the pretty-formatted dropbox-api-result JSON looks like this:
    ; { 
    ;   "name": "jack.txt",
    ;   "path_lower": "/jack.txt",
    ;   "path_display": "/jack.txt",
    ;   "id": "id:yqx4-tE_NKAAAAAAAAAAAQ",
    ;   "client_modified": "2016-06-02T20:42:11Z",
    ;   "server_modified": "2016-06-02T20:42:11Z",
    ;   "rev": "8482db15f",
    ;   "size": 42
    ; }

    ; Load the JSON, pretty-print it, and demonstrate how to get some values...
    jsonResult.i = CkJsonObject::ckCreate()
    If jsonResult.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(jsonResult, 0)
    CkJsonObject::ckLoad(jsonResult,apiResult)
    ; Show the JSON pretty-printed...
    Debug CkJsonObject::ckEmit(jsonResult)

    ; Sample code to get data from the JSON response:
    size.i = CkJsonObject::ckIntOf(jsonResult,"size")
    Debug "size = " + Str(size)

    rev.s = CkJsonObject::ckStringOf(jsonResult,"rev")
    Debug "rev = " + rev

    clientModified.s = CkJsonObject::ckStringOf(jsonResult,"client_modified")
    ckdt.i = CkDateTime::ckCreate()
    If ckdt.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkDateTime::ckSetFromTimestamp(ckdt,clientModified)
    bLocalTime.i = 1
    dt.i = CkDtObj::ckCreate()
    If dt.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkDateTime::ckToDtObj(ckdt,bLocalTime,dt)

    Debug Str(CkDtObj::ckDay(dt)) + "/" + Str(CkDtObj::ckMonth(dt)) + "/" + Str(CkDtObj::ckYear(dt)) + " " + Str(CkDtObj::ckHour(dt)) + ":" + Str(CkDtObj::ckMinute(dt))


    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(json)
    CkJsonObject::ckDispose(jsonResult)
    CkDateTime::ckDispose(ckdt)
    CkDtObj::ckDispose(dt)


    ProcedureReturn
EndProcedure