Delphi DLL Requires Chilkat v11.7.0+
Delphi DLL
Box: List All Files and Subfolders with Pagination
See more Box Examples
Run the reusable setup once per HttpCurl object, then select names and execute the operation. The setup is repeated here only to make this published example independently runnable. List every page of direct children using marker pagination. This does not recursively traverse subfolders.
See the Box API guide for setup and the complete workflow.
Chilkat Delphi DLL Downloads
var
success: Boolean;
curl: HCkHttpCurl;
setupCommand: HCkStringBuilder;
setupReplacements: Integer;
parentName: PWideChar;
folderName: PWideChar;
page: HCkJsonObject;
i: Integer;
count: Integer;
more: Boolean;
nextMarker: PWideChar;
authorizedCommand1: HCkStringBuilder;
headerReplacement1: Integer;
pageCommand: PWideChar;
authorizedCommand2: HCkStringBuilder;
headerReplacement2: Integer;
begin
success := False;
// Requires Chilkat 11.7.0 or later and a previously unlocked Chilkat bundle.
// See Global Unlock Sample.
// Guide: Box API Guide.
success := False;
// BEGIN ONE-TIME SETUP
// This block is repeated so each published example can run on its own.
// In an application, run the setup example once and pass the SAME curl object
// to operation code below. Do not recreate it for every operation.
// See Reusable Box HttpCurl Setup.
curl := CkHttpCurl_Create();
CkHttpCurl_SetVar(curl,'access_token','BOX_ACCESS_TOKEN');
CkHttpCurl_SetVar(curl,'parent_name','/');
// Box's fixed root ID is an implementation detail; callers supply names.
CkHttpCurl_SetVar(curl,'parent_id','0');
setupCommand := CkStringBuilder_Create();
// Register findParent; registration sends no request.
CkStringBuilder_SetString(setupCommand,'curl -X GET "https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements := CkStringBuilder_Replace(setupCommand,'ACCESS_TOKEN',CkHttpCurl__getVar(curl,'access_token'));
success := CkHttpCurl_AddFunction(curl,'findParent',CkStringBuilder__getAsString(setupCommand));
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
// Register findFolder; registration sends no request.
CkStringBuilder_SetString(setupCommand,'curl -X GET "https://api.box.com/2.0/folders/{{parent_id}}/items?limit=1000&fields=id,type,name" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements := CkStringBuilder_Replace(setupCommand,'ACCESS_TOKEN',CkHttpCurl__getVar(curl,'access_token'));
success := CkHttpCurl_AddFunction(curl,'findFolder',CkStringBuilder__getAsString(setupCommand));
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
// Register findFile; registration sends no request.
CkStringBuilder_SetString(setupCommand,'curl -X GET "https://api.box.com/2.0/folders/{{folder_id}}/items?limit=1000&fields=id,type,name" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements := CkStringBuilder_Replace(setupCommand,'ACCESS_TOKEN',CkHttpCurl__getVar(curl,'access_token'));
success := CkHttpCurl_AddFunction(curl,'findFile',CkStringBuilder__getAsString(setupCommand));
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
// Register findDestination; registration sends no request.
CkStringBuilder_SetString(setupCommand,'curl -X GET "https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements := CkStringBuilder_Replace(setupCommand,'ACCESS_TOKEN',CkHttpCurl__getVar(curl,'access_token'));
success := CkHttpCurl_AddFunction(curl,'findDestination',CkStringBuilder__getAsString(setupCommand));
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
// Register getFileDetails; registration sends no request.
CkStringBuilder_SetString(setupCommand,'curl -X GET "https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements := CkStringBuilder_Replace(setupCommand,'ACCESS_TOKEN',CkHttpCurl__getVar(curl,'access_token'));
success := CkHttpCurl_AddFunction(curl,'getFileDetails',CkStringBuilder__getAsString(setupCommand));
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
// Register getEnterprise; registration sends no request.
CkStringBuilder_SetString(setupCommand,'curl -X GET "https://api.box.com/2.0/users/me?fields=enterprise" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements := CkStringBuilder_Replace(setupCommand,'ACCESS_TOKEN',CkHttpCurl__getVar(curl,'access_token'));
success := CkHttpCurl_AddFunction(curl,'getEnterprise',CkStringBuilder__getAsString(setupCommand));
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
// Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
// when extracting each output, using the current value at that time.
success := CkHttpCurl_AddOutput2(curl,'findParent','entries','name','{{parent_name}}',True,'id','parent_id');
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
success := CkHttpCurl_AddOutput2(curl,'findFolder','entries','name','{{folder_name}}',True,'id','folder_id');
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
success := CkHttpCurl_AddOutput2(curl,'findFile','entries','name','{{file_name}}',True,'id','file_id');
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
success := CkHttpCurl_AddOutput2(curl,'findDestination','entries','name','{{destination_name}}',True,'id','destination_id');
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
success := CkHttpCurl_AddOutput(curl,'getFileDetails','file_version.id','file_version_id');
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
success := CkHttpCurl_AddOutput(curl,'getFileDetails','sha1','file_sha1');
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
success := CkHttpCurl_AddOutput(curl,'getEnterprise','enterprise.id','enterprise_id');
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
// END ONE-TIME SETUP
// The name lookups below assume each listing fits in one page (1000 items).
// Parent and destination names select root children; folder_name selects a child
// of parent_name. "/" selects the root parent. These are not arbitrary paths.
// BEGIN OPERATION -- keep the configured object when reusing it.
// Inputs are names. Retain cached IDs when the selected names have not changed.
parentName := '/';
folderName := 'images';
if ((CkHttpCurl__getVar(curl,'parent_name') <> parentName) or ((parentName = '/') and (CkHttpCurl_VarDefined(curl,'parent_id') = False))) then
begin
CkHttpCurl_SetVar(curl,'parent_name',parentName);
CkHttpCurl_ClearVar(curl,'parent_id');
CkHttpCurl_ClearVar(curl,'folder_id');
CkHttpCurl_ClearVar(curl,'file_id');
CkHttpCurl_ClearVar(curl,'file_version_id');
CkHttpCurl_ClearVar(curl,'file_sha1');
if (parentName = '/') then
begin
CkHttpCurl_SetVar(curl,'parent_id','0');
end;
end;
if (CkHttpCurl__getVar(curl,'folder_name') <> folderName) then
begin
CkHttpCurl_SetVar(curl,'folder_name',folderName);
CkHttpCurl_ClearVar(curl,'folder_id');
CkHttpCurl_ClearVar(curl,'file_id');
CkHttpCurl_ClearVar(curl,'file_version_id');
CkHttpCurl_ClearVar(curl,'file_sha1');
end;
CkHttpCurl_SetVar(curl,'marker','');
page := CkJsonObject_Create();
i := 0;
count := 0;
more := True;
authorizedCommand1 := CkStringBuilder_Create();
CkStringBuilder_SetString(authorizedCommand1,'curl -X GET "https://api.box.com/2.0/folders/{{folder_id}}/items?usemarker=true&limit=1000&fields=id,type,name" -H "Authorization: Bearer {{access_token}}"');
headerReplacement1 := CkStringBuilder_Replace(authorizedCommand1,'{{access_token}}',CkHttpCurl__getVar(curl,'access_token'));
pageCommand := CkStringBuilder__getAsString(authorizedCommand1);
while (more = True) do
begin
CkHttpCurl_ClearTargetOutput(curl,'*');
success := CkHttpCurl_DoYourThing(curl,pageCommand);
if ((success <> True) or (CkHttpCurl_getStatusCode(curl) <> 200)) then
begin
Memo1.Lines.Add('Box request failed. HTTP status: ' + IntToStr(CkHttpCurl_getStatusCode(curl)));
Memo1.Lines.Add('Failure reason: ' + IntToStr(CkHttpCurl_getFailReason(curl)));
Memo1.Lines.Add(CkHttpCurl__responseBodyStr(curl));
Exit;
end;
success := CkHttpCurl_GetResponseJson(curl,page);
if (success <> True) then
begin
Memo1.Lines.Add(CkHttpCurl__lastErrorText(curl));
Exit;
end;
count := CkJsonObject_SizeOfArray(page,'entries');
i := 0;
while i < count do
begin
CkJsonObject_putI(page,i);
Memo1.Lines.Add(CkJsonObject__stringOf(page,'entries[i].type') + ' ' + CkJsonObject__stringOf(page,'entries[i].id') + ' ' + CkJsonObject__stringOf(page,'entries[i].name'));
i := i + 1;
end;
more := False;
if (CkJsonObject_HasMember(page,'next_marker') = True) then
begin
if (CkJsonObject_IsNullOf(page,'next_marker') = False) then
begin
nextMarker := CkJsonObject__stringOf(page,'next_marker');
if (nextMarker <> '') then
begin
if (nextMarker = CkHttpCurl__getVar(curl,'marker')) then
begin
Memo1.Lines.Add('Box returned the same pagination marker; stopping.');
Exit;
end;
CkHttpCurl_SetVar(curl,'marker',nextMarker);
authorizedCommand2 := CkStringBuilder_Create();
CkStringBuilder_SetString(authorizedCommand2,'curl -X GET "https://api.box.com/2.0/folders/{{folder_id}}/items?usemarker=true&limit=1000&fields=id,type,name&marker={{marker}}" -H "Authorization: Bearer {{access_token}}"');
headerReplacement2 := CkStringBuilder_Replace(authorizedCommand2,'{{access_token}}',CkHttpCurl__getVar(curl,'access_token'));
pageCommand := CkStringBuilder__getAsString(authorizedCommand2);
more := True;
end;
end;
end;
end;
CkHttpCurl_Dispose(curl);
CkStringBuilder_Dispose(setupCommand);
CkJsonObject_Dispose(page);
CkStringBuilder_Dispose(authorizedCommand1);
CkStringBuilder_Dispose(authorizedCommand2);