com.files.models

Class Bundle

java.lang.Object

com.files.models.Bundle

All Implemented Interfaces:

ModelInterface

public class Bundle
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Object[]	bundlepaths A list of bundlepaths in this bundle.
String	clickwrapBody Legal text that must be agreed to prior to accessing Bundle.
Long	clickwrapId ID of the clickwrap to use with this bundle.
String	code Bundle code.
String	colorLeft Page link and button color
String	colorLink Top bar link color
String	colorText Page link and button color
String	colorTop Top bar background color
String	colorTopText Top bar text color
Date	createdAt Bundle created at date/time
Boolean	createSnapshot If true, create a snapshot of this bundle's contents.
String	description Public description
Boolean	dontAllowFoldersInUploads Should folder uploads be prevented?
Boolean	dontSeparateSubmissionsByFolder Do not create subfolders for files uploaded to this share.
Date	expiresAt Bundle expiration date/time
Boolean	finalizeSnapshot If true, finalize the snapshot of this bundle's contents.
FormFieldSet	formFieldSet Custom Form to use
Long	formFieldSetId Id of Form Field Set to use with this bundle
Boolean	hasInbox Does this bundle have an associated inbox?
Long	id Bundle ID
Long	inboxId ID of the associated inbox, if available.
Long	maxUses Maximum number of times bundle can be accessed
String	note Bundle internal note
String	password Password for this bundle.
Boolean	passwordProtected Is this bundle password protected?
String[]	paths A list of paths in this bundle.
String	pathTemplate Template for creating submission subfolders.
String	pathTemplateTimeZone Timezone to use when rendering timestamps in path templates.
String	permissions Permissions that apply to Folders in this Share Link.
Boolean	previewOnly
Boolean	requireLogout If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.
Boolean	requireRegistration Show a registration page that captures the downloader's name and email address?
Boolean	requireShareRecipient Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?
Boolean	sendEmailReceiptToUploader Send delivery receipt to the uploader.
Boolean	skipCompany BundleRegistrations can be saved without providing company?
Boolean	skipEmail BundleRegistrations can be saved without providing email?
Boolean	skipName BundleRegistrations can be saved without providing name?
Long	snapshotId ID of the snapshot containing this bundle's contents.
Date	startAccessOnDate Date when share will start to be accessible.
String	url Public URL of Share Link
Long	userId Bundle creator user ID
String	username Bundle creator username
Image	watermarkAttachment Preview watermark image applied to all bundle items.
Boolean	watermarkAttachmentDelete If true, will delete the file stored in watermark_attachment
byte[]	watermarkAttachmentFile Preview watermark image applied to all bundle items.
Map<String,String>	watermarkValue Preview watermark settings applied to all bundle items.

Constructor Summary

Constructors

Constructor and Description
Bundle()
Bundle(HashMap<String,Object> parameters)
Bundle(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<Bundle>	all()
static ListIterator<Bundle>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Bundle	create(HashMap<String,Object> parameters) Parameters: user_id - int64 - User ID.
static Bundle	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	delete()
static void	delete(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	delete(Long id, HashMap<String,Object> parameters)
static void	delete(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	destroy()
void	destroy(HashMap<String,Object> parameters)
static void	destroy(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static Bundle	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Bundle	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - Bundle ID.
static Bundle	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static Bundle	get()
static Bundle	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Bundle>	list() Parameters: user_id - int64 - User ID.
static ListIterator<Bundle>	list(HashMap<String,Object> parameters)
static ListIterator<Bundle>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()
void	share() Send email(s) with a link to bundle Parameters: to - array(string) - A list of email addresses to share this bundle with.
static void	share(HashMap<String,Object> parameters, HashMap<String,Object> options)
static void	share(Long id, HashMap<String,Object> parameters) Send email(s) with a link to bundle Parameters: to - array(string) - A list of email addresses to share this bundle with.
static void	share(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
Bundle	update() Parameters: paths - array(string) - A list of paths to include in this bundle.
static Bundle	update(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Bundle	update(Long id, HashMap<String,Object> parameters) Parameters: paths - array(string) - A list of paths to include in this bundle.
static Bundle	update(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.files.models.ModelInterface

setOptions

Field Detail

code

public String code

Bundle code. This code forms the end part of the Public URL.

colorLeft

public String colorLeft

Page link and button color

colorLink

public String colorLink

Top bar link color

colorText

public String colorText

Page link and button color

colorTop

public String colorTop

Top bar background color

colorTopText

public String colorTopText

Top bar text color

url

public String url

Public URL of Share Link

description

public String description

Public description

expiresAt

public Date expiresAt

Bundle expiration date/time

passwordProtected

public Boolean passwordProtected

Is this bundle password protected?

permissions

public String permissions

Permissions that apply to Folders in this Share Link.

previewOnly

public Boolean previewOnly

requireRegistration

public Boolean requireRegistration

Show a registration page that captures the downloader's name and email address?

requireShareRecipient

public Boolean requireShareRecipient

Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI?

requireLogout

public Boolean requireLogout

If true, we will hide the 'Remember Me' box on the Bundle registration page, requiring that the user logout and log back in every time they visit the page.

clickwrapBody

public String clickwrapBody

Legal text that must be agreed to prior to accessing Bundle.

formFieldSet

public FormFieldSet formFieldSet

Custom Form to use

skipName

public Boolean skipName

BundleRegistrations can be saved without providing name?

skipEmail

public Boolean skipEmail

BundleRegistrations can be saved without providing email?

startAccessOnDate

public Date startAccessOnDate

Date when share will start to be accessible. If `nil` access granted right after create.

skipCompany

public Boolean skipCompany

BundleRegistrations can be saved without providing company?

id

public Long id

Bundle ID

createdAt

public Date createdAt

Bundle created at date/time

dontSeparateSubmissionsByFolder

public Boolean dontSeparateSubmissionsByFolder

Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required.

maxUses

public Long maxUses

Maximum number of times bundle can be accessed

note

public String note

Bundle internal note

pathTemplate

public String pathTemplate

Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data.

pathTemplateTimeZone

public String pathTemplateTimeZone

Timezone to use when rendering timestamps in path templates.

sendEmailReceiptToUploader

public Boolean sendEmailReceiptToUploader

Send delivery receipt to the uploader. Note: For writable share only

snapshotId

public Long snapshotId

ID of the snapshot containing this bundle's contents.

userId

public Long userId

Bundle creator user ID

username

public String username

Bundle creator username

clickwrapId

public Long clickwrapId

ID of the clickwrap to use with this bundle.

inboxId

public Long inboxId

ID of the associated inbox, if available.

watermarkAttachment

public Image watermarkAttachment

Preview watermark image applied to all bundle items.

watermarkValue

public Map<String,String> watermarkValue

Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value

hasInbox

public Boolean hasInbox

Does this bundle have an associated inbox?

dontAllowFoldersInUploads

public Boolean dontAllowFoldersInUploads

Should folder uploads be prevented?

paths

public String[] paths

A list of paths in this bundle. For performance reasons, this is not provided when listing bundles.

bundlepaths

public Object[] bundlepaths

A list of bundlepaths in this bundle. For performance reasons, this is not provided when listing bundles.

password

public String password

Password for this bundle.

formFieldSetId

public Long formFieldSetId

Id of Form Field Set to use with this bundle

createSnapshot

public Boolean createSnapshot

If true, create a snapshot of this bundle's contents.

finalizeSnapshot

public Boolean finalizeSnapshot

If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true.

watermarkAttachmentFile

public byte[] watermarkAttachmentFile

Preview watermark image applied to all bundle items.

watermarkAttachmentDelete

public Boolean watermarkAttachmentDelete

If true, will delete the file stored in watermark_attachment

Constructor Detail

Bundle

public Bundle()

Bundle

public Bundle(HashMap<String,Object> parameters)

Bundle

public Bundle(HashMap<String,Object> parameters,
              HashMap<String,Object> options)

Method Detail

share

public void share()
           throws IOException

Send email(s) with a link to bundle Parameters: to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used. note - string - Note to include in email. recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.

Throws:

IOException

update

public Bundle update()
              throws IOException

Parameters: paths - array(string) - A list of paths to include in this bundle. password - string - Password for this bundle. form_field_set_id - int64 - Id of Form Field Set to use with this bundle clickwrap_id - int64 - ID of the clickwrap to use with this bundle. code - string - Bundle code. This code forms the end part of the Public URL. create_snapshot - boolean - If true, create a snapshot of this bundle's contents. description - string - Public description dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required. expires_at - string - Bundle expiration date/time finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true. inbox_id - int64 - ID of the associated inbox, if available. max_uses - int64 - Maximum number of times bundle can be accessed note - string - Bundle internal note path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data. path_template_time_zone - string - Timezone to use when rendering timestamps in path templates. permissions - string - Permissions that apply to Folders in this Share Link. require_registration - boolean - Show a registration page that captures the downloader's name and email address? require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI? send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only skip_company - boolean - BundleRegistrations can be saved without providing company? start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create. skip_email - boolean - BundleRegistrations can be saved without providing email? skip_name - boolean - BundleRegistrations can be saved without providing name? watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment watermark_attachment_file - file - Preview watermark image applied to all bundle items.

Throws:

IOException

delete

public void delete()
            throws IOException

Throws:

IOException

destroy

public void destroy(HashMap<String,Object> parameters)
             throws IOException

Throws:

IOException

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<Bundle> list()
                                 throws RuntimeException

Parameters: user_id - int64 - User ID. Provide a value of `0` to operate the current session's user. cursor - string - Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination. per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended). sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `code` or `note`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `code`, `note` or `created_at`. filter_gt - object - If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`. filter_gteq - object - If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`. filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `code` and `note`. filter_lt - object - If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`. filter_lteq - object - If set, return records where the specified field is less than or equal the supplied value. Valid fields are `created_at`.

Throws:

RuntimeException

list

public static ListIterator<Bundle> list(HashMap<String,Object> parameters)
                                 throws RuntimeException

Throws:

RuntimeException

list

public static ListIterator<Bundle> list(HashMap<String,Object> parameters,
                                        HashMap<String,Object> options)
                                 throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<Bundle> all()
                                throws RuntimeException

Throws:

RuntimeException

all

public static ListIterator<Bundle> all(HashMap<String,Object> parameters,
                                       HashMap<String,Object> options)
                                throws RuntimeException

Throws:

RuntimeException

find

public static Bundle find(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Parameters: id (required) - int64 - Bundle ID.

Throws:

RuntimeException

find

public static Bundle find(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

find

public static Bundle find(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

get

public static Bundle get()
                  throws RuntimeException

Throws:

RuntimeException

get

public static Bundle get(Long id,
                         HashMap<String,Object> parameters,
                         HashMap<String,Object> options)
                  throws RuntimeException

Throws:

RuntimeException

create

public static Bundle create(HashMap<String,Object> parameters)
                     throws RuntimeException

Parameters: user_id - int64 - User ID. Provide a value of `0` to operate the current session's user. paths (required) - array(string) - A list of paths to include in this bundle. password - string - Password for this bundle. form_field_set_id - int64 - Id of Form Field Set to use with this bundle create_snapshot - boolean - If true, create a snapshot of this bundle's contents. dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required. expires_at - string - Bundle expiration date/time finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true. max_uses - int64 - Maximum number of times bundle can be accessed description - string - Public description note - string - Bundle internal note code - string - Bundle code. This code forms the end part of the Public URL. path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data. path_template_time_zone - string - Timezone to use when rendering timestamps in path templates. permissions - string - Permissions that apply to Folders in this Share Link. require_registration - boolean - Show a registration page that captures the downloader's name and email address? clickwrap_id - int64 - ID of the clickwrap to use with this bundle. inbox_id - int64 - ID of the associated inbox, if available. require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI? send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only skip_email - boolean - BundleRegistrations can be saved without providing email? skip_name - boolean - BundleRegistrations can be saved without providing name? skip_company - boolean - BundleRegistrations can be saved without providing company? start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create. snapshot_id - int64 - ID of the snapshot containing this bundle's contents. watermark_attachment_file - file - Preview watermark image applied to all bundle items.

Throws:

RuntimeException

create

public static Bundle create(HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException

Throws:

RuntimeException

share

public static void share(Long id,
                         HashMap<String,Object> parameters)
                  throws RuntimeException

Send email(s) with a link to bundle Parameters: to - array(string) - A list of email addresses to share this bundle with. Required unless `recipients` is used. note - string - Note to include in email. recipients - array(object) - A list of recipients to share this bundle with. Required unless `to` is used.

Throws:

RuntimeException

share

public static void share(HashMap<String,Object> parameters,
                         HashMap<String,Object> options)
                  throws RuntimeException

Throws:

RuntimeException

share

public static void share(Long id,
                         HashMap<String,Object> parameters,
                         HashMap<String,Object> options)
                  throws RuntimeException

Throws:

RuntimeException

update

public static Bundle update(Long id,
                            HashMap<String,Object> parameters)
                     throws RuntimeException

Parameters: paths - array(string) - A list of paths to include in this bundle. password - string - Password for this bundle. form_field_set_id - int64 - Id of Form Field Set to use with this bundle clickwrap_id - int64 - ID of the clickwrap to use with this bundle. code - string - Bundle code. This code forms the end part of the Public URL. create_snapshot - boolean - If true, create a snapshot of this bundle's contents. description - string - Public description dont_separate_submissions_by_folder - boolean - Do not create subfolders for files uploaded to this share. Note: there are subtle security pitfalls with allowing anonymous uploads from multiple users to live in the same folder. We strongly discourage use of this option unless absolutely required. expires_at - string - Bundle expiration date/time finalize_snapshot - boolean - If true, finalize the snapshot of this bundle's contents. Note that `create_snapshot` must also be true. inbox_id - int64 - ID of the associated inbox, if available. max_uses - int64 - Maximum number of times bundle can be accessed note - string - Bundle internal note path_template - string - Template for creating submission subfolders. Can use the uploader's name, email address, ip, company, `strftime` directives, and any custom form data. path_template_time_zone - string - Timezone to use when rendering timestamps in path templates. permissions - string - Permissions that apply to Folders in this Share Link. require_registration - boolean - Show a registration page that captures the downloader's name and email address? require_share_recipient - boolean - Only allow access to recipients who have explicitly received the share via an email sent through the Files.com UI? send_email_receipt_to_uploader - boolean - Send delivery receipt to the uploader. Note: For writable share only skip_company - boolean - BundleRegistrations can be saved without providing company? start_access_on_date - string - Date when share will start to be accessible. If `nil` access granted right after create. skip_email - boolean - BundleRegistrations can be saved without providing email? skip_name - boolean - BundleRegistrations can be saved without providing name? watermark_attachment_delete - boolean - If true, will delete the file stored in watermark_attachment watermark_attachment_file - file - Preview watermark image applied to all bundle items.

Throws:

RuntimeException

update

public static Bundle update(HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException

Throws:

RuntimeException

update

public static Bundle update(Long id,
                            HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

delete

public static void delete(Long id,
                          HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy()
                    throws RuntimeException

Throws:

RuntimeException

destroy

public static void destroy(Long id,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException

Throws:

RuntimeException