React Native Requires Chilkat v11.7.0+
React Native
Box: Search Files with Offset 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. Search within a folder hierarchy. Box search is indexed and may lag recent changes; use returned upload IDs for immediate follow-up requests. Search uses offset pagination, not folder-list markers.
See the Box API guide for setup and the complete workflow.
Chilkat React Native Downloads
import { HttpCurl, JsonObject, StringBuilder } from '@chilkat/react-native'
async function chilkatExample() {
let 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.
const curl = new HttpCurl();
curl.setVar('access_token', 'BOX_ACCESS_TOKEN');
curl.setVar('parent_name', '/');
// Box's fixed root ID is an implementation detail; callers supply names.
curl.setVar('parent_id', '0');
const setupCommand = new StringBuilder();
let setupReplacements = 0;
// Register findParent; registration sends no request.
setupCommand.setString('curl -X GET "https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements = setupCommand.replace('ACCESS_TOKEN', curl.getVar('access_token'));
success = true;
try {
curl.addFunction('findParent', setupCommand.getAsString());
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
// Register findFolder; registration sends no request.
setupCommand.setString('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 = setupCommand.replace('ACCESS_TOKEN', curl.getVar('access_token'));
success = true;
try {
curl.addFunction('findFolder', setupCommand.getAsString());
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
// Register findFile; registration sends no request.
setupCommand.setString('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 = setupCommand.replace('ACCESS_TOKEN', curl.getVar('access_token'));
success = true;
try {
curl.addFunction('findFile', setupCommand.getAsString());
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
// Register findDestination; registration sends no request.
setupCommand.setString('curl -X GET "https://api.box.com/2.0/folders/0/items?limit=1000&fields=id,type,name" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements = setupCommand.replace('ACCESS_TOKEN', curl.getVar('access_token'));
success = true;
try {
curl.addFunction('findDestination', setupCommand.getAsString());
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
// Register getFileDetails; registration sends no request.
setupCommand.setString('curl -X GET "https://api.box.com/2.0/files/{{file_id}}?fields=id,sha1,file_version" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements = setupCommand.replace('ACCESS_TOKEN', curl.getVar('access_token'));
success = true;
try {
curl.addFunction('getFileDetails', setupCommand.getAsString());
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
// Register getEnterprise; registration sends no request.
setupCommand.setString('curl -X GET "https://api.box.com/2.0/users/me?fields=enterprise" -H "Authorization: Bearer ACCESS_TOKEN"');
setupReplacements = setupCommand.replace('ACCESS_TOKEN', curl.getVar('access_token'));
success = true;
try {
curl.addFunction('getEnterprise', setupCommand.getAsString());
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
// Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
// when extracting each output, using the current value at that time.
success = true;
try {
curl.addOutput2('findParent', 'entries', 'name', '{{parent_name}}', true, 'id', 'parent_id');
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
success = true;
try {
curl.addOutput2('findFolder', 'entries', 'name', '{{folder_name}}', true, 'id', 'folder_id');
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
success = true;
try {
curl.addOutput2('findFile', 'entries', 'name', '{{file_name}}', true, 'id', 'file_id');
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
success = true;
try {
curl.addOutput2('findDestination', 'entries', 'name', '{{destination_name}}', true, 'id', 'destination_id');
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
success = true;
try {
curl.addOutput('getFileDetails', 'file_version.id', 'file_version_id');
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
success = true;
try {
curl.addOutput('getFileDetails', 'sha1', 'file_sha1');
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
success = true;
try {
curl.addOutput('getEnterprise', 'enterprise.id', 'enterprise_id');
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
// 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.
const parentName = '/';
const folderName = 'images';
if ((curl.getVar('parent_name') !== parentName) || ((parentName === '/') && (!curl.varDefined('parent_id')))) {
curl.setVar('parent_name', parentName);
curl.clearVar('parent_id');
curl.clearVar('folder_id');
curl.clearVar('file_id');
curl.clearVar('file_version_id');
curl.clearVar('file_sha1');
if (parentName === '/') {
curl.setVar('parent_id', '0');
}
}
if (curl.getVar('folder_name') !== folderName) {
curl.setVar('folder_name', folderName);
curl.clearVar('folder_id');
curl.clearVar('file_id');
curl.clearVar('file_version_id');
curl.clearVar('file_sha1');
}
curl.setVar('query', 'penguins');
const page = new JsonObject();
const numberArg = new StringBuilder();
let offset = 0;
let count = 0;
let pageLimit = 0;
let total = 0;
let i = 0;
let more = true;
while (more) {
numberArg.clear();
numberArg.appendInt(offset);
curl.setVar('offset', numberArg.getAsString());
curl.clearTargetOutput('*');
const authorizedCommand1 = new StringBuilder();
authorizedCommand1.setString('curl -X GET "https://api.box.com/2.0/search?query={{query}}&type=file&ancestor_folder_ids={{folder_id}}&content_types=name&limit=100&offset={{offset}}" -H "Authorization: Bearer {{access_token}}"');
const headerReplacement1 = authorizedCommand1.replace('{{access_token}}', curl.getVar('access_token'));
success = true;
try {
await curl.doYourThingAsync(authorizedCommand1.getAsString());
} catch {
success = false;
}
if ((!success) || (curl.statusCode !== 200)) {
console.log(`Box request failed. HTTP status: ${curl.statusCode}`);
console.log(`Failure reason: ${curl.failReason}`);
console.log(curl.responseBodyStr);
return;
}
success = true;
try {
curl.getResponseJson(page);
} catch {
success = false;
}
if (!success) {
console.log(curl.lastErrorText);
return;
}
count = page.sizeOfArray('entries');
i = 0;
while (i < count) {
page.i = i;
console.log(`${page.stringOf('entries[i].id')} ${page.stringOf('entries[i].name')}`);
i++;
}
pageLimit = page.intOf('limit');
total = page.intOf('total_count');
if (pageLimit <= 0) {
console.log('Missing or invalid search page limit.');
return;
}
offset += pageLimit;
more = (offset < total) && (count > 0);
if ((more) && (offset > 9999)) {
console.log('Search offset limit reached; narrow the query or folder scope.');
return;
}
}
}