Swift Requires Chilkat v11.7.0+
Swift
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.
Chilkat Swift Downloads
func chilkatTest() {
var success: Bool = 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.
let curl = CkoHttpCurl()!
curl.setVar(varName: "access_token", varValue: "BOX_ACCESS_TOKEN")
curl.setVar(varName: "parent_name", varValue: "/")
// Box's fixed root ID is an implementation detail; callers supply names.
curl.setVar(varName: "parent_id", varValue: "0")
let setupCommand = CkoStringBuilder()!
var setupReplacements: Int
// Register findParent; registration sends no request.
setupCommand.setString(value: "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(value: "ACCESS_TOKEN", replacement: curl.getVar(varName: "access_token")).intValue
success = curl.addFunction(funcName: "findParent", curl: setupCommand.getAsString())
if success != true {
print("\(curl.lastErrorText!)")
return
}
// Register findFolder; registration sends no request.
setupCommand.setString(value: "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(value: "ACCESS_TOKEN", replacement: curl.getVar(varName: "access_token")).intValue
success = curl.addFunction(funcName: "findFolder", curl: setupCommand.getAsString())
if success != true {
print("\(curl.lastErrorText!)")
return
}
// Register findFile; registration sends no request.
setupCommand.setString(value: "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(value: "ACCESS_TOKEN", replacement: curl.getVar(varName: "access_token")).intValue
success = curl.addFunction(funcName: "findFile", curl: setupCommand.getAsString())
if success != true {
print("\(curl.lastErrorText!)")
return
}
// Register findDestination; registration sends no request.
setupCommand.setString(value: "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(value: "ACCESS_TOKEN", replacement: curl.getVar(varName: "access_token")).intValue
success = curl.addFunction(funcName: "findDestination", curl: setupCommand.getAsString())
if success != true {
print("\(curl.lastErrorText!)")
return
}
// Register getFileDetails; registration sends no request.
setupCommand.setString(value: "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(value: "ACCESS_TOKEN", replacement: curl.getVar(varName: "access_token")).intValue
success = curl.addFunction(funcName: "getFileDetails", curl: setupCommand.getAsString())
if success != true {
print("\(curl.lastErrorText!)")
return
}
// Register getEnterprise; registration sends no request.
setupCommand.setString(value: "curl -X GET \"https://api.box.com/2.0/users/me?fields=enterprise\" -H \"Authorization: Bearer ACCESS_TOKEN\"")
setupReplacements = setupCommand.replace(value: "ACCESS_TOKEN", replacement: curl.getVar(varName: "access_token")).intValue
success = curl.addFunction(funcName: "getEnterprise", curl: setupCommand.getAsString())
if success != true {
print("\(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(funcName: "findParent", arrayPath: "entries", wherePath: "name", whereValue: "{{parent_name}}", caseSensitive: true, subPath: "id", varName: "parent_id")
if success != true {
print("\(curl.lastErrorText!)")
return
}
success = curl.addOutput2(funcName: "findFolder", arrayPath: "entries", wherePath: "name", whereValue: "{{folder_name}}", caseSensitive: true, subPath: "id", varName: "folder_id")
if success != true {
print("\(curl.lastErrorText!)")
return
}
success = curl.addOutput2(funcName: "findFile", arrayPath: "entries", wherePath: "name", whereValue: "{{file_name}}", caseSensitive: true, subPath: "id", varName: "file_id")
if success != true {
print("\(curl.lastErrorText!)")
return
}
success = curl.addOutput2(funcName: "findDestination", arrayPath: "entries", wherePath: "name", whereValue: "{{destination_name}}", caseSensitive: true, subPath: "id", varName: "destination_id")
if success != true {
print("\(curl.lastErrorText!)")
return
}
success = curl.addOutput(funcName: "getFileDetails", jsonPath: "file_version.id", varName: "file_version_id")
if success != true {
print("\(curl.lastErrorText!)")
return
}
success = curl.addOutput(funcName: "getFileDetails", jsonPath: "sha1", varName: "file_sha1")
if success != true {
print("\(curl.lastErrorText!)")
return
}
success = curl.addOutput(funcName: "getEnterprise", jsonPath: "enterprise.id", varName: "enterprise_id")
if success != true {
print("\(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.
var parentName: String? = "/"
var folderName: String? = "images"
var fileName: String? = "penguins.jpg"
if (curl.getVar(varName: "parent_name") != parentName) || ((parentName == "/") && (curl.varDefined(varName: "parent_id") == false)) {
curl.setVar(varName: "parent_name", varValue: parentName)
curl.clearVar(varName: "parent_id")
curl.clearVar(varName: "folder_id")
curl.clearVar(varName: "file_id")
curl.clearVar(varName: "file_version_id")
curl.clearVar(varName: "file_sha1")
if parentName == "/" {
curl.setVar(varName: "parent_id", varValue: "0")
}
}
if curl.getVar(varName: "folder_name") != folderName {
curl.setVar(varName: "folder_name", varValue: folderName)
curl.clearVar(varName: "folder_id")
curl.clearVar(varName: "file_id")
curl.clearVar(varName: "file_version_id")
curl.clearVar(varName: "file_sha1")
}
if curl.getVar(varName: "file_name") != fileName {
curl.setVar(varName: "file_name", varValue: fileName)
curl.clearVar(varName: "file_id")
curl.clearVar(varName: "file_version_id")
curl.clearVar(varName: "file_sha1")
}
curl.setVar(varName: "local_path", varValue: "qa_output/penguins.jpg")
// Operation 1: get information by name. This resolves folder_id and file_id.
curl.clearTargetOutput(varName: "*")
let authorizedCommand1 = CkoStringBuilder()!
authorizedCommand1.setString(value: "curl -X GET \"https://api.box.com/2.0/files/{{file_id}}?fields=id,name\" -H \"Authorization: Bearer {{access_token}}\"")
var headerReplacement1: Int = authorizedCommand1.replace(value: "{{access_token}}", replacement: curl.getVar(varName: "access_token")).intValue
success = curl.doYourThing(targetCurl: authorizedCommand1.getAsString())
if (success != true) || (curl.statusCode.intValue != 200) {
print("Box request failed. HTTP status: \(curl.statusCode.intValue)")
print("Failure reason: \(curl.failReason.intValue)")
print("\(curl.responseBodyStr!)")
return
}
// Operation 2: keep the same object and IDs. Only the final download is needed.
let warmPlan = CkoJsonObject()!
warmPlan.emitCompact = false
let authorizedCommand2 = CkoStringBuilder()!
authorizedCommand2.setString(value: "curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"{{local_path}}\"")
var headerReplacement2: Int = authorizedCommand2.replace(value: "{{access_token}}", replacement: curl.getVar(varName: "access_token")).intValue
success = curl.examinePlan(curl: authorizedCommand2.getAsString(), json: warmPlan)
if success != true {
print("\(curl.lastErrorText!)")
return
}
print("\(warmPlan.emit()!)")
curl.clearTargetOutput(varName: "*")
let authorizedCommand3 = CkoStringBuilder()!
authorizedCommand3.setString(value: "curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"{{local_path}}\"")
var headerReplacement3: Int = authorizedCommand3.replace(value: "{{access_token}}", replacement: curl.getVar(varName: "access_token")).intValue
success = curl.doYourThing(targetCurl: authorizedCommand3.getAsString())
if (success != true) || (curl.statusCode.intValue != 200) {
print("Box request failed. HTTP status: \(curl.statusCode.intValue)")
print("Failure reason: \(curl.failReason.intValue)")
print("\(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(varName: "file_id")
curl.clearVar(varName: "file_version_id")
curl.clearVar(varName: "file_sha1")
curl.setVar(varName: "file_name", varValue: "penguins.jpg")
curl.setVar(varName: "local_path", varValue: "qa_output/penguins-copy.jpg")
let authorizedCommand4 = CkoStringBuilder()!
authorizedCommand4.setString(value: "curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"{{local_path}}\"")
var headerReplacement4: Int = authorizedCommand4.replace(value: "{{access_token}}", replacement: curl.getVar(varName: "access_token")).intValue
success = curl.examinePlan(curl: authorizedCommand4.getAsString(), json: warmPlan)
if success != true {
print("\(curl.lastErrorText!)")
return
}
print("\(warmPlan.emit()!)")
curl.clearTargetOutput(varName: "*")
let authorizedCommand5 = CkoStringBuilder()!
authorizedCommand5.setString(value: "curl -X GET \"https://api.box.com/2.0/files/{{file_id}}/content\" -H \"Authorization: Bearer {{access_token}}\" -L -o \"{{local_path}}\"")
var headerReplacement5: Int = authorizedCommand5.replace(value: "{{access_token}}", replacement: curl.getVar(varName: "access_token")).intValue
success = curl.doYourThing(targetCurl: authorizedCommand5.getAsString())
if (success != true) || (curl.statusCode.intValue != 200) {
print("Box request failed. HTTP status: \(curl.statusCode.intValue)")
print("Failure reason: \(curl.failReason.intValue)")
print("\(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.
}