com.files.models

Class InboxRegistration

java.lang.Object

com.files.models.InboxRegistration

All Implemented Interfaces:

ModelInterface

public class InboxRegistration
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	clickwrapBody Clickwrap text that was shown to the registrant
String	code Registration cookie code
String	company Registrant company name
Date	createdAt Registration creation date/time
String	email Registrant email address
Map<String,String>	formFieldData Data for form field set with form field ids as keys and user data as values
Long	formFieldSetId Id of associated form field set
Long	inboxId Id of associated inbox
Long	inboxRecipientId Id of associated inbox recipient
String	inboxTitle Title of associated inbox
String	ip Registrant IP Address
String	name Registrant name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<InboxRegistration>	all()
static ListIterator<InboxRegistration>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<InboxRegistration>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<InboxRegistration>	list(HashMap<String,Object> parameters)
static ListIterator<InboxRegistration>	list(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

Registration cookie code

name

public String name

Registrant name

company

public String company

Registrant company name

email

public String email

Registrant email address

ip

public String ip

Registrant IP Address

clickwrapBody

public String clickwrapBody

Clickwrap text that was shown to the registrant

formFieldSetId

public Long formFieldSetId

Id of associated form field set

formFieldData

public Map<String,String> formFieldData

Data for form field set with form field ids as keys and user data as values

inboxId

public Long inboxId

Id of associated inbox

inboxRecipientId

public Long inboxRecipientId

Id of associated inbox recipient

inboxTitle

public String inboxTitle

Title of associated inbox

createdAt

public Date createdAt

Registration creation date/time

Constructor Detail

InboxRegistration

public InboxRegistration()

InboxRegistration

public InboxRegistration(HashMap<String,Object> parameters)

InboxRegistration

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

Method Detail

list

public static ListIterator<InboxRegistration> 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). folder_behavior_id - int64 - ID of the associated Inbox.

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<InboxRegistration> all()
                                           throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException