com.files.models

Class InboxRecipient

java.lang.Object

com.files.models.InboxRecipient

All Implemented Interfaces:

ModelInterface

public class InboxRecipient
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	company The recipient's company.
Long	inboxId Inbox to share.
String	name The recipient's name.
String	note A note sent to the recipient with the inbox.
String	recipient The recipient's email address.
Date	sentAt When the Inbox 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
InboxRecipient()
InboxRecipient(HashMap<String,Object> parameters)
InboxRecipient(HashMap<String,Object> parameters, HashMap<String,Object> options)

Method Summary

Modifier and Type	Method and Description
static ListIterator<InboxRecipient>	all()
static ListIterator<InboxRecipient>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static InboxRecipient	create(HashMap<String,Object> parameters) Parameters: inbox_id (required) - int64 - Inbox to share.
static InboxRecipient	create(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<InboxRecipient>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<InboxRecipient>	list(HashMap<String,Object> parameters)
static ListIterator<InboxRecipient>	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 inbox.

recipient

public String recipient

The recipient's email address.

sentAt

public Date sentAt

When the Inbox was shared with this recipient.

inboxId

public Long inboxId

Inbox to share.

shareAfterCreate

public Boolean shareAfterCreate

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

Constructor Detail

InboxRecipient

public InboxRecipient()

InboxRecipient

public InboxRecipient(HashMap<String,Object> parameters)

InboxRecipient

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

Method Detail

save

public void save()
          throws IOException

Throws:

IOException

list

public static ListIterator<InboxRecipient> 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`. inbox_id (required) - int64 - List recipients for the inbox with this ID.

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<InboxRecipient> all()
                                        throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException

create

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

Parameters: inbox_id (required) - int64 - Inbox to share. recipient (required) - string - Email address to share this inbox 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 InboxRecipient create(HashMap<String,Object> parameters,
                                    HashMap<String,Object> options)
                             throws RuntimeException

Throws:

RuntimeException