Bundle Notifications

A BundleNotification is an E-Mail sent out to users when certain actions are performed on or within a shared set of files and folders.

List Share Link Notifications

SDK Method

\Files\Model\BundleNotification::list;

Return Object

BundleNotification[]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
bundle_id
int64		Bundle ID

Additional Arguments

Example Request

try {
  $bundle_notifications = \Files\Model\BundleNotification::list([
    'user_id' => 1
  ]);
  foreach ($bundle_notifications as $bundle_notification) {
    // Operate on $bundle_notification
  }
} 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";
}

Show Share Link Notification

SDK Method

\Files\Model\BundleNotification::find;

Return Object

BundleNotification

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
id
int64
Required		Bundle Notification ID.

Example Request

try {
  $bundle_notification = \Files\Model\BundleNotification::find($id);
  // Operate on $bundle_notification
} 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";
}

Create Share Link Notification

SDK Method

\Files\Model\BundleNotification::create;

Return Object

BundleNotification

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDefaultDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
bundle_id
int64
Required		Bundle ID to notify on
notify_user_id
int64		The id of the user to notify.
notify_on_registration
boolean		falseTriggers bundle notification when a registration action occurs for it.
notify_on_upload
boolean		falseTriggers bundle notification when a upload action occurs for it.

Example Request

try {
  $bundle_notification = \Files\Model\BundleNotification::create([
    'bundle_id' => 1
  ]);
  // Operate on $bundle_notification
} 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";
}

Update Share Link Notification

SDK Method

$bundle_notification->update;

Return Object

BundleNotification

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
notify_on_registration
boolean		Triggers bundle notification when a registration action occurs for it.
notify_on_upload
boolean		Triggers bundle notification when a upload action occurs for it.

Example Request

try {
  // Find the bundle_notification object by its id.
  $bundle_notification = \Files\Model\BundleNotification::find(id);
  $bundle_notification->update([
    'notify_on_registration' => true
  ]);
} 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";
}

Delete Share Link Notification

SDK Method

$bundle_notification->delete;

Return Object

No return value.

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

try {
  // Find the bundle_notification object by its id.
  $bundle_notification = \Files\Model\BundleNotification::find(id);
  $bundle_notification->delete();
} 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 BundleNotification Object

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

AttributeDescription
bundle_id
int64		Bundle ID to notify on
id
int64		Bundle Notification ID
notify_on_registration
boolean		Triggers bundle notification when a registration action occurs for it.
notify_on_upload
boolean		Triggers bundle notification when a upload action occurs for it.
notify_current_user
boolean		Is the current user the user to notify?
notify_user_id
int64		The id of the user to notify.
workspace_id
int64		Workspace ID. 0 means the default workspace.