com.files.models

Class BundleRecipient

java.lang.Object

com.files.models.BundleRecipient

All Implemented Interfaces:

ModelInterface

public class BundleRecipient
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
Long	bundleId Bundle to share.
String	company The recipient's company.
String	name The recipient's name.
String	note A note sent to the recipient with the bundle.
String	recipient The recipient's email address.
Date	sentAt When the Bundle was shared with this recipient.
Boolean	shareAfterCreate Set to true to share the link with the recipient upon creation.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<BundleRecipient>	all()
static ListIterator<BundleRecipient>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static BundleRecipient	create(HashMap<String,Object> parameters) Parameters: bundle_id (required) - int64 - Bundle to share.
static BundleRecipient	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<BundleRecipient>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<BundleRecipient>	list(HashMap<String,Object> parameters)
static ListIterator<BundleRecipient>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()

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

company

public String company

The recipient's company.

name

public String name

The recipient's name.

note

public String note

A note sent to the recipient with the bundle.

recipient

public String recipient

The recipient's email address.

sentAt

public Date sentAt

When the Bundle was shared with this recipient.

bundleId

public Long bundleId

Bundle to share.

shareAfterCreate

public Boolean shareAfterCreate

Set to true to share the link with the recipient upon creation.

Constructor Detail

BundleRecipient

public BundleRecipient()

BundleRecipient

public BundleRecipient(HashMap<String,Object> parameters)

BundleRecipient

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

Method Detail

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<BundleRecipient> list()
                                          throws RuntimeException

Parameters: 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 `has_registrations`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `has_registrations`. bundle_id (required) - int64 - List recipients for the bundle with this ID.

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<BundleRecipient> all()
                                         throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException

create

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

Parameters: bundle_id (required) - int64 - Bundle to share. recipient (required) - string - Email addresses to share this bundle with. name - string - Name of recipient. company - string - Company of recipient. note - string - Note to include in email. share_after_create - boolean - Set to true to share the link with the recipient upon creation.

Throws:

RuntimeException

create

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

Throws:

RuntimeException