com.files.models

Class Clickwrap

java.lang.Object

com.files.models.Clickwrap

All Implemented Interfaces:

ModelInterface

public class Clickwrap
extends Object
implements ModelInterface

Field Summary

Fields

Modifier and Type	Field and Description
String	body Body text of Clickwrap (supports Markdown formatting).
Long	id Clickwrap ID
String	name Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
String	useWithBundles Use this Clickwrap for Bundles?
String	useWithInboxes Use this Clickwrap for Inboxes?
String	useWithUsers Use this Clickwrap for User Registrations?

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static ListIterator<Clickwrap>	all()
static ListIterator<Clickwrap>	all(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Clickwrap	create(HashMap<String,Object> parameters) Parameters: name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
static Clickwrap	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 Clickwrap	find(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Clickwrap	find(Long id, HashMap<String,Object> parameters) Parameters: id (required) - int64 - Clickwrap ID.
static Clickwrap	find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static Clickwrap	get()
static Clickwrap	get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)
static ListIterator<Clickwrap>	list() Parameters: cursor - string - Used for pagination.
static ListIterator<Clickwrap>	list(HashMap<String,Object> parameters)
static ListIterator<Clickwrap>	list(HashMap<String,Object> parameters, HashMap<String,Object> options)
void	save()
Clickwrap	update() Parameters: name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
static Clickwrap	update(HashMap<String,Object> parameters, HashMap<String,Object> options)
static Clickwrap	update(Long id, HashMap<String,Object> parameters) Parameters: name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)
static Clickwrap	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

id

public Long id

Clickwrap ID

name

public String name

Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.)

body

public String body

Body text of Clickwrap (supports Markdown formatting).

useWithUsers

public String useWithUsers

Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

useWithBundles

public String useWithBundles

Use this Clickwrap for Bundles?

useWithInboxes

public String useWithInboxes

Use this Clickwrap for Inboxes?

Constructor Detail

Clickwrap

public Clickwrap()

Clickwrap

public Clickwrap(HashMap<String,Object> parameters)

Clickwrap

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

Method Detail

update

public Clickwrap update()
                 throws IOException

Parameters: name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.) body - string - Body text of Clickwrap (supports Markdown formatting). use_with_bundles - string - Use this Clickwrap for Bundles? use_with_inboxes - string - Use this Clickwrap for Inboxes? use_with_users - string - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

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<Clickwrap> 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).

Throws:

RuntimeException

list

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

Throws:

RuntimeException

list

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

Throws:

RuntimeException

all

public static ListIterator<Clickwrap> all()
                                   throws RuntimeException

Throws:

RuntimeException

all

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

Throws:

RuntimeException

find

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

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

Throws:

RuntimeException

find

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

Throws:

RuntimeException

find

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

Throws:

RuntimeException

get

public static Clickwrap get()
                     throws RuntimeException

Throws:

RuntimeException

get

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

Throws:

RuntimeException

create

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

Parameters: name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.) body - string - Body text of Clickwrap (supports Markdown formatting). use_with_bundles - string - Use this Clickwrap for Bundles? use_with_inboxes - string - Use this Clickwrap for Inboxes? use_with_users - string - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

Throws:

RuntimeException

create

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

Throws:

RuntimeException

update

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

Parameters: name - string - Name of the Clickwrap agreement (used when selecting from multiple Clickwrap agreements.) body - string - Body text of Clickwrap (supports Markdown formatting). use_with_bundles - string - Use this Clickwrap for Bundles? use_with_inboxes - string - Use this Clickwrap for Inboxes? use_with_users - string - Use this Clickwrap for User Registrations? Note: This only applies to User Registrations where the User is invited to your Files.com site using an E-Mail invitation process where they then set their own password.

Throws:

RuntimeException

update

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

Throws:

RuntimeException

update

public static Clickwrap 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