Objective-C Requires Chilkat v11.7.0+

Box: Reuse HttpCurl and Invalidate Cached IDs

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. Perform three operations with one configured object: cold file lookup, warm download without lookups, then another download to a different local path after clearing only file state. Functions and output rules are registered only once; their variables are evaluated when used.

See the Box API guide for setup and the complete workflow.

Objective-C

#import <CkoHttpCurl.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
#import <CkoJsonObject.h>

BOOL success = NO;

//  Requires Chilkat 11.7.0 or later and a previously unlocked Chilkat bundle.
//  See Global Unlock Sample.
//  Guide: Box API Guide.

success = NO;

//  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.
CkoHttpCurl *curl = [[CkoHttpCurl alloc] init];
[curl SetVar: @"access_token" varValue: @"BOX_ACCESS_TOKEN"];
[curl SetVar: @"parent_name" varValue: @"/"];
//  Box's fixed root ID is an implementation detail; callers supply names.
[curl SetVar: @"parent_id" varValue: @"0"];
CkoStringBuilder *setupCommand = [[CkoStringBuilder alloc] init];
int setupReplacements;

//  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" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl AddFunction: @"findParent" curl: [setupCommand GetAsString]];
if (success != YES) {
    NSLog(@"%@",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" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl AddFunction: @"findFolder" curl: [setupCommand GetAsString]];
if (success != YES) {
    NSLog(@"%@",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" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl AddFunction: @"findFile" curl: [setupCommand GetAsString]];
if (success != YES) {
    NSLog(@"%@",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" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl AddFunction: @"findDestination" curl: [setupCommand GetAsString]];
if (success != YES) {
    NSLog(@"%@",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" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl AddFunction: @"getFileDetails" curl: [setupCommand GetAsString]];
if (success != YES) {
    NSLog(@"%@",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" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl AddFunction: @"getEnterprise" curl: [setupCommand GetAsString]];
if (success != YES) {
    NSLog(@"%@",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 = [curl AddOutput2: @"findParent" arrayPath: @"entries" wherePath: @"name" whereValue: @"{{parent_name}}" caseSensitive: YES subPath: @"id" varName: @"parent_id"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

success = [curl AddOutput2: @"findFolder" arrayPath: @"entries" wherePath: @"name" whereValue: @"{{folder_name}}" caseSensitive: YES subPath: @"id" varName: @"folder_id"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

success = [curl AddOutput2: @"findFile" arrayPath: @"entries" wherePath: @"name" whereValue: @"{{file_name}}" caseSensitive: YES subPath: @"id" varName: @"file_id"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

success = [curl AddOutput2: @"findDestination" arrayPath: @"entries" wherePath: @"name" whereValue: @"{{destination_name}}" caseSensitive: YES subPath: @"id" varName: @"destination_id"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

success = [curl AddOutput: @"getFileDetails" jsonPath: @"file_version.id" varName: @"file_version_id"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

success = [curl AddOutput: @"getFileDetails" jsonPath: @"sha1" varName: @"file_sha1"];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

success = [curl AddOutput: @"getEnterprise" jsonPath: @"enterprise.id" varName: @"enterprise_id"];
if (success != YES) {
    NSLog(@"%@",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.
NSString *parentName = @"/";
NSString *folderName = @"images";
NSString *fileName = @"penguins.jpg";
if (([curl GetVar: @"parent_name"] != parentName) || ((parentName == @"/") && ([curl VarDefined: @"parent_id"] == NO))) {
    [curl SetVar: @"parent_name" varValue: 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" varValue: @"0"];
    }

}

if ([curl GetVar: @"folder_name"] != folderName) {
    [curl SetVar: @"folder_name" varValue: folderName];
    [curl ClearVar: @"folder_id"];
    [curl ClearVar: @"file_id"];
    [curl ClearVar: @"file_version_id"];
    [curl ClearVar: @"file_sha1"];
}

if ([curl GetVar: @"file_name"] != fileName) {
    [curl SetVar: @"file_name" varValue: fileName];
    [curl ClearVar: @"file_id"];
    [curl ClearVar: @"file_version_id"];
    [curl ClearVar: @"file_sha1"];
}

[curl SetVar: @"local_path" varValue: @"qa_output/penguins.jpg"];
//  Operation 1: get information by name. This resolves folder_id and file_id.
[curl ClearTargetOutput: @"*"];
CkoStringBuilder *authorizedCommand1 = [[CkoStringBuilder alloc] init];
[authorizedCommand1 SetString: @"curl -X GET \"https://api.box.com/2.0/files/{{file_id}}?fields=id,name\" -H \"Authorization: Bearer {{access_token}}\""];
int headerReplacement1 = [[authorizedCommand1 Replace: @"{{access_token}}" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl DoYourThing: [authorizedCommand1 GetAsString]];
if ((success != YES) || ([curl.StatusCode intValue] != 200)) {
    NSLog(@"%@%d",@"Box request failed. HTTP status: ",[curl.StatusCode intValue]);
    NSLog(@"%@%d",@"Failure reason: ",[curl.FailReason intValue]);
    NSLog(@"%@",curl.ResponseBodyStr);
    return;
}

//  Operation 2: keep the same object and IDs. Only the final download is needed.
CkoJsonObject *warmPlan = [[CkoJsonObject alloc] init];
warmPlan.EmitCompact = NO;
CkoStringBuilder *authorizedCommand2 = [[CkoStringBuilder alloc] init];
[authorizedCommand2 SetString: @"curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"{{local_path}}\""];
int headerReplacement2 = [[authorizedCommand2 Replace: @"{{access_token}}" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl ExaminePlan: [authorizedCommand2 GetAsString] json: warmPlan];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

NSLog(@"%@",[warmPlan Emit]);
[curl ClearTargetOutput: @"*"];
CkoStringBuilder *authorizedCommand3 = [[CkoStringBuilder alloc] init];
[authorizedCommand3 SetString: @"curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"{{local_path}}\""];
int headerReplacement3 = [[authorizedCommand3 Replace: @"{{access_token}}" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl DoYourThing: [authorizedCommand3 GetAsString]];
if ((success != YES) || ([curl.StatusCode intValue] != 200)) {
    NSLog(@"%@%d",@"Box request failed. HTTP status: ",[curl.StatusCode intValue]);
    NSLog(@"%@%d",@"Failure reason: ",[curl.FailReason intValue]);
    NSLog(@"%@",curl.ResponseBodyStr);
    return;
}

//  Operation 3: explicitly invalidate file state, retaining the known folder.
//  Here we select the same name so this demonstration needs only one real file.
//  Substitute another filename to switch files in this folder.
//  The existing output rule reads the current file_name; do not register it again.
[curl ClearVar: @"file_id"];
[curl ClearVar: @"file_version_id"];
[curl ClearVar: @"file_sha1"];
[curl SetVar: @"file_name" varValue: @"penguins.jpg"];
[curl SetVar: @"local_path" varValue: @"qa_output/penguins-copy.jpg"];
CkoStringBuilder *authorizedCommand4 = [[CkoStringBuilder alloc] init];
[authorizedCommand4 SetString: @"curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"{{local_path}}\""];
int headerReplacement4 = [[authorizedCommand4 Replace: @"{{access_token}}" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl ExaminePlan: [authorizedCommand4 GetAsString] json: warmPlan];
if (success != YES) {
    NSLog(@"%@",curl.LastErrorText);
    return;
}

NSLog(@"%@",[warmPlan Emit]);
[curl ClearTargetOutput: @"*"];
CkoStringBuilder *authorizedCommand5 = [[CkoStringBuilder alloc] init];
[authorizedCommand5 SetString: @"curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"{{local_path}}\""];
int headerReplacement5 = [[authorizedCommand5 Replace: @"{{access_token}}" replacement: [curl GetVar: @"access_token"]] intValue];
success = [curl DoYourThing: [authorizedCommand5 GetAsString]];
if ((success != YES) || ([curl.StatusCode intValue] != 200)) {
    NSLog(@"%@%d",@"Box request failed. HTTP status: ",[curl.StatusCode intValue]);
    NSLog(@"%@%d",@"Failure reason: ",[curl.FailReason intValue]);
    NSLog(@"%@",curl.ResponseBodyStr);
    return;
}

//  Changing parent_name invalidates parent_id, folder_id, and file state.
//  Changing folder_name invalidates folder_id and file state.
//  Changing destination_name invalidates destination_id.