Bundle Downloads

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

List Share Link Downloads

SDK Function

BundleDownload.list()

Return Object

ListIterator<BundleDownload>

Authorization Requirement

Available to all authenticated keys or sessions.

Function Arguments

ArgumentDescription
bundle_id
int64		Bundle ID
bundle_registration_id
int64		BundleRegistration ID

Additional Arguments

Example Request

import com.files.ListIterator;
import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.BundleDownload;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("bundle_id", 1);
  
  ListIterator<BundleDownload> bundleDownloads = BundleDownload.list(parameters);
  for (BundleDownload bundleDownload : bundleDownloads.listAutoPaging()) {
    // Operate on bundleDownload
  }
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The BundleDownload Object

Some of the functions 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