Bundle Downloads

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

List Share Link Downloads

SDK Method

\Files\Model\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

try {
  $bundle_downloads = \Files\Model\BundleDownload::list([
    'bundle_id' => 1
  ]);
  foreach ($bundle_downloads as $bundle_download) {
    // Operate on $bundle_download
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

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