Bundle Downloads

A BundleDownload is a record of the download action that happened in the bundle.

List Share Link Downloads

SDK Method

BundleDownload.list()

Return Object

BundleDownload[]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
bundle_id
int64		Bundle ID
bundle_registration_id
int64		BundleRegistration ID

Additional Arguments

Example Request

import BundleDownload from 'files.com/lib/models/BundleDownload';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const bundleDownloads = await BundleDownload.list({
    bundle_id: 1,
  });
  for (const bundleDownload of bundleDownloads) {
    // Operate on bundleDownload
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

The BundleDownload Object

Some of the methods above return a BundleDownload object. The attributes of this object are listed below.

AttributeDescription
bundle_registration
BundleRegistration
download_method
string		Download method (file or full_zip)
Possible values: file, full_zip
path
string		Download path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
workspace_id
int64		Workspace ID. 0 means the default workspace.
created_at
date-time		Download date/time