Dart Requires Chilkat v11.7.0+

Box: Create a Shared Link with Explicit Access

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. Create a collaborators-only link for a file. It points existing collaborators to the file; it does not invite new users. Wider access levels are subject to enterprise policy.

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

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  var 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.
  final curl = CkHttpCurl();
  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');
  final setupCommand = CkStringBuilder();
  var 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'));
  try {
    curl.addFunction('findParent', setupCommand.getAsString());
  } on ChilkatException catch (e) {
    print(e.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'));
  try {
    curl.addFunction('findFolder', setupCommand.getAsString());
  } on ChilkatException catch (e) {
    print(e.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'));
  try {
    curl.addFunction('findFile', setupCommand.getAsString());
  } on ChilkatException catch (e) {
    print(e.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'));
  try {
    curl.addFunction('findDestination', setupCommand.getAsString());
  } on ChilkatException catch (e) {
    print(e.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'));
  try {
    curl.addFunction('getFileDetails', setupCommand.getAsString());
  } on ChilkatException catch (e) {
    print(e.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'));
  try {
    curl.addFunction('getEnterprise', setupCommand.getAsString());
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Register output rules once. Chilkat 11.7.0 evaluates {{name}} variables
  // when extracting each output, using the current value at that time.
  try {
    curl.addOutput2('findParent', 'entries', 'name', '{{parent_name}}', true, 'id', 'parent_id');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    curl.addOutput2('findFolder', 'entries', 'name', '{{folder_name}}', true, 'id', 'folder_id');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    curl.addOutput2('findFile', 'entries', 'name', '{{file_name}}', true, 'id', 'file_id');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    curl.addOutput2('findDestination', 'entries', 'name', '{{destination_name}}', true, 'id', 'destination_id');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    curl.addOutput('getFileDetails', 'file_version.id', 'file_version_id');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    curl.addOutput('getFileDetails', 'sha1', 'file_sha1');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    curl.addOutput('getEnterprise', 'enterprise.id', 'enterprise_id');
  } on ChilkatException catch (e) {
    print(e.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.
  final parentName = '/';
  final folderName = 'images';
  final fileName = 'penguins.jpg';
  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');
  }

  if (curl.getVar('file_name') != fileName) {
    curl.setVar('file_name', fileName);
    curl.clearVar('file_id');
    curl.clearVar('file_version_id');
    curl.clearVar('file_sha1');
  }

  curl.clearTargetOutput('*');
  curl.clearVar('shared_url');
  curl.addTargetOutput('shared_link.url', 'shared_url');
  final authorizedCommand1 = CkStringBuilder();
  authorizedCommand1.setString('curl -X PUT "https://api.box.com/2.0/files/{{file_id}}?fields=id,shared_link" -H "Authorization: Bearer {{access_token}}" -H "Content-Type: application/json" -d \'{"shared_link":{"access":"collaborators"}}\'');
  final headerReplacement1 = authorizedCommand1.replace('{{access_token}}', curl.getVar('access_token'));
  success = true;
  try {
    curl.doYourThing(authorizedCommand1.getAsString());
  } on ChilkatException {
    success = false;
  }
  if ((!success) || (curl.statusCode != 200)) {
    print('Box request failed. HTTP status: ${curl.statusCode}');
    print('Failure reason: ${curl.failReason}');
    print(curl.responseBodyStr);
    return;
  }

  if (!curl.varDefined('!')) {
    print('Expected response fields are missing.');
    return;
  }

  print(curl.getVar('shared_url'));
}