Delphi DLL 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}"

Delphi DLL Example

var
rest: HCkRest;
success: Boolean;
bTls: Boolean;
port: Integer;
bAutoReconnect: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
sbResponseBody: HCkStringBuilder;
respStatusCode: Integer;
jsonResponse: HCkJsonObject;
i: Integer;
count_i: Integer;
cursor: PWideChar;
has_more: Boolean;
Tag: PWideChar;
name: PWideChar;
path_lower: PWideChar;
path_display: PWideChar;
id: PWideChar;
client_modified: PWideChar;
server_modified: PWideChar;
rev: PWideChar;
size: Integer;
content_hash: PWideChar;

begin
rest := CkRest_Create();

//  URL: https://api.dropboxapi.com/2/files/list_folder
bTls := True;
port := 443;
bAutoReconnect := True;
success := CkRest_Connect(rest,'api.dropboxapi.com',port,bTls,bAutoReconnect);
if (success <> True) then
  begin
    Memo1.Lines.Add('ConnectFailReason: ' + IntToStr(CkRest_getConnectFailReason(rest)));
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

//  See the Online Tool for Generating JSON Creation Code
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'path','/Homework/math');
CkJsonObject_UpdateBool(json,'recursive',False);
CkJsonObject_UpdateBool(json,'include_media_info',False);
CkJsonObject_UpdateBool(json,'include_deleted',False);
CkJsonObject_UpdateBool(json,'include_has_explicit_shared_members',False);
CkJsonObject_UpdateBool(json,'include_mounted_folders',True);

CkRest_AddHeader(rest,'Authorization','Bearer DROPBOX-ACCESS-TOKEN');
CkRest_AddHeader(rest,'Content-Type','application/json');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
sbResponseBody := CkStringBuilder_Create();
success := CkRest_FullRequestSb(rest,'POST','/2/files/list_folder',sbRequestBody,sbResponseBody);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;
respStatusCode := CkRest_getResponseStatusCode(rest);
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkRest__responseHeader(rest));
    Memo1.Lines.Add('Response Body:');
    Memo1.Lines.Add(CkStringBuilder__getAsString(sbResponseBody));
    Exit;
  end;

jsonResponse := CkJsonObject_Create();
CkJsonObject_LoadSb(jsonResponse,sbResponseBody);

//  See the Online Tool for Generating JSON Parse Code

cursor := CkJsonObject__stringOf(jsonResponse,'cursor');
has_more := CkJsonObject_BoolOf(jsonResponse,'has_more');
i := 0;
count_i := CkJsonObject_SizeOfArray(jsonResponse,'entries');
while i < count_i do
  begin
CkJsonObject_putI(jsonResponse,i);
    Tag := CkJsonObject__stringOf(jsonResponse,'entries[i].".tag"');
    name := CkJsonObject__stringOf(jsonResponse,'entries[i].name');
    path_lower := CkJsonObject__stringOf(jsonResponse,'entries[i].path_lower');
    path_display := CkJsonObject__stringOf(jsonResponse,'entries[i].path_display');
    id := CkJsonObject__stringOf(jsonResponse,'entries[i].id');
    client_modified := CkJsonObject__stringOf(jsonResponse,'entries[i].client_modified');
    server_modified := CkJsonObject__stringOf(jsonResponse,'entries[i].server_modified');
    rev := CkJsonObject__stringOf(jsonResponse,'entries[i].rev');
    size := CkJsonObject_IntOf(jsonResponse,'entries[i].size');
    content_hash := CkJsonObject__stringOf(jsonResponse,'entries[i].content_hash');
    i := i + 1;
  end;

CkRest_Dispose(rest);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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
}