Tcl Dropbox: Dropbox List Contents of Folder

Back to Index

Starts returning the contents of a folder. If the result's ListFolderResult.has_more field is true, call list_folder/continue with the returned ListFolderResult.cursor to retrieve more entries.

Documentation: https://www.dropbox.com/developers/documentation/http/documentation#files-list_folder

CURL Command

curl -X POST https://api.dropboxapi.com/2/files/list_folder \
    --header "Authorization: Bearer DROPBOX-ACCESS-TOKEN" \
    --header "Content-Type: application/json" \
    --data "{\"path\": \"/Homework/math\",\"recursive\": false,\"include_media_info\": false,\"include_deleted\": false,\"include_has_explicit_shared_members\": false,\"include_mounted_folders\": true}"

Tcl Example


load ./chilkat.dll

set rest [new_CkRest]

#  URL: https://api.dropboxapi.com/2/files/list_folder
set bTls 1
set port 443
set bAutoReconnect 1
set success [CkRest_Connect $rest "api.dropboxapi.com" $port $bTls $bAutoReconnect]
if {[expr $success != 1]} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    exit
}

#  See the Online Tool for Generating JSON Creation Code
set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "path" "/Homework/math"
CkJsonObject_UpdateBool $json "recursive" 0
CkJsonObject_UpdateBool $json "include_media_info" 0
CkJsonObject_UpdateBool $json "include_deleted" 0
CkJsonObject_UpdateBool $json "include_has_explicit_shared_members" 0
CkJsonObject_UpdateBool $json "include_mounted_folders" 1

CkRest_AddHeader $rest "Authorization" "Bearer DROPBOX-ACCESS-TOKEN"
CkRest_AddHeader $rest "Content-Type" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/2/files/list_folder" $sbRequestBody $sbResponseBody]
if {[expr $success != 1]} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
if {[expr $respStatusCode >= 400]} then {
    puts "Response Status Code = $respStatusCode"
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jsonResponse [new_CkJsonObject]

CkJsonObject_LoadSb $jsonResponse $sbResponseBody

#  See the Online Tool for Generating JSON Parse Code

set cursor [CkJsonObject_stringOf $jsonResponse "cursor"]
set has_more [CkJsonObject_BoolOf $jsonResponse "has_more"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jsonResponse "entries"]
while {[expr $i < $count_i]} {
    CkJsonObject_put_I $jsonResponse $i
    set Tag [CkJsonObject_stringOf $jsonResponse "entries[i].\".tag\""]
    set name [CkJsonObject_stringOf $jsonResponse "entries[i].name"]
    set path_lower [CkJsonObject_stringOf $jsonResponse "entries[i].path_lower"]
    set path_display [CkJsonObject_stringOf $jsonResponse "entries[i].path_display"]
    set id [CkJsonObject_stringOf $jsonResponse "entries[i].id"]
    set client_modified [CkJsonObject_stringOf $jsonResponse "entries[i].client_modified"]
    set server_modified [CkJsonObject_stringOf $jsonResponse "entries[i].server_modified"]
    set rev [CkJsonObject_stringOf $jsonResponse "entries[i].rev"]
    set size [CkJsonObject_IntOf $jsonResponse "entries[i].size"]
    set content_hash [CkJsonObject_stringOf $jsonResponse "entries[i].content_hash"]
    set i [expr $i + 1]
}

delete_CkRest $rest
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jsonResponse

Sample JSON Response Body

{
  "entries": [
    {
      ".tag": "file",
      "name": "Matrices.txt",
      "path_lower": "/homework/math/matrices.txt",
      "path_display": "/Homework/math/Matrices.txt",
      "id": "id:qk7WwvROeSAAAAAAAAAAAQ",
      "client_modified": "2016-06-02T20:41:02Z",
      "server_modified": "2016-06-02T20:41:03Z",
      "rev": "5482db15f",
      "size": 6,
      "content_hash": "5a3c776e2631edabe2ba710ac72301b3aeca821ba4f7d36b56cc6050ea6c2ba8"
    },
    {
      ".tag": "file",
      "name": "Document.docx",
      "path_lower": "/homework/math/document.docx",
      "path_display": "/Homework/math/Document.docx",
      "id": "id:JSXYsxHo1hAAAAAAAAAABw",
      "client_modified": "2018-10-22T21:59:23Z",
      "server_modified": "2018-10-22T21:59:23Z",
      "rev": "10482db15f",
      "size": 11009,
      "content_hash": "ab9c1887a653a8f42e4401425ac02839e1f76533e1d44ac8d0605d870a16c25d"
    }
  ],
  "cursor": "AAHnmmjY1IztwebFmkByuZ_Vgzz-tSYXYE3KhdkUxBfETpGjPqTBz7ZzBj1G7zkPPVanKCt0FtzqXjDQ2ggQKYZTiL4mJ346fRelmP049QjN5CZzeMHbD_lSFqA96Br36vR9YLg40VAHu42TcCG38MbUPOCKa-wdguu5C1JsgYvIaXIcjRMCfbxz98JdYhhefmu0pjoxtgtCstOrmp_pXIng",
  "has_more": false
}