Behavior (Files.com Java SDK 1.4.103 API)

java.lang.Object
- com.files.models.Behavior

All Implemented Interfaces:: ModelInterface

public class Behavior
extends Object
implements ModelInterface

Field Summary

Fields
Modifier and Type	Field and Description
`Boolean`	`attachmentDelete` If `true`, delete the file stored in `attachment`.
`byte[]`	`attachmentFile` Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image.
`String`	`attachmentUrl` URL for attached file
`String`	`behavior` Behavior type.
`String`	`description` Description for this behavior.
`Boolean`	`disableParentFolderBehavior` If true, the parent folder's behavior will be disabled for this folder and its children.
`Long`	`id` Folder behavior ID
`String`	`name` Name for this behavior.
`String`	`path` Folder path.
`Boolean`	`recursive` Is behavior recursive?
`Map<String,String>`	`value` Settings for this behavior.

Constructor Summary

Constructors
Constructor and Description

Behavior()

Behavior(HashMap<String,Object> parameters)

Behavior(HashMap<String,Object> parameters, HashMap<String,Object> options)

Constructors
Constructor and Description
`Behavior()`
`Behavior(HashMap<String,Object> parameters)`
`Behavior(HashMap<String,Object> parameters, HashMap<String,Object> options)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListIterator<Behavior>`	`all()`
`static ListIterator<Behavior>`	`all(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static Behavior`	`create(HashMap<String,Object> parameters)` Parameters: value - string - This field stores a hash of data specific to the type of behavior.
`static Behavior`	`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 Behavior`	`find(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static Behavior`	`find(Long id, HashMap<String,Object> parameters)` Parameters: id (required) - int64 - Behavior ID.
`static Behavior`	`find(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static Behavior`	`get()`
`static Behavior`	`get(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static ListIterator<Behavior>`	`list()` Parameters: cursor - string - Used for pagination.
`static ListIterator<Behavior>`	`list(HashMap<String,Object> parameters)`
`static ListIterator<Behavior>`	`list(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static ListIterator<Behavior>`	`listFor()` Parameters: cursor - string - Used for pagination.
`static ListIterator<Behavior>`	`listFor(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static ListIterator<Behavior>`	`listFor(String path, HashMap<String,Object> parameters)`
`static ListIterator<Behavior>`	`listFor(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`void`	`save()`
`Behavior`	`update()` Parameters: value - string - This field stores a hash of data specific to the type of behavior.
`static Behavior`	`update(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static Behavior`	`update(Long id, HashMap<String,Object> parameters)` Parameters: value - string - This field stores a hash of data specific to the type of behavior.
`static Behavior`	`update(Long id, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static void`	`webhookTest(HashMap<String,Object> parameters)` Parameters: url (required) - string - URL for testing the webhook.
`static void`	`webhookTest(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
```
    Folder behavior ID
  - path
```
public String path
```
    Folder path. Note that Behavior paths cannot be updated once initially set. You will need to remove and re-create the behavior on the new path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
  - attachmentUrl
```
public String attachmentUrl
```
    URL for attached file
  - behavior
```
public String behavior
```
    Behavior type.
  - name
```
public String name
```
    Name for this behavior.
  - description
```
public String description
```
    Description for this behavior.
  - value
```
public Map<String,String> value
```
    Settings for this behavior. See the section above for an example value to provide here. Formatting is different for each Behavior type. May be sent as nested JSON or a single JSON-encoded string. If using XML encoding for the API call, this data must be sent as a JSON-encoded string.
  - disableParentFolderBehavior
```
public Boolean disableParentFolderBehavior
```
    If true, the parent folder's behavior will be disabled for this folder and its children.
  - recursive
```
public Boolean recursive
```
    Is behavior recursive?
  - attachmentFile
```
public byte[] attachmentFile
```
    Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here.
  - attachmentDelete
```
public Boolean attachmentDelete
```
    If `true`, delete the file stored in `attachment`.
- Constructor Detail
  - Behavior
```
public Behavior()
```
  - Behavior
```
public Behavior(HashMap<String,Object> parameters)
```
  - Behavior
```
public Behavior(HashMap<String,Object> parameters,
                HashMap<String,Object> options)
```
- Method Detail
  - update
```
public Behavior update()
                throws IOException
```
    Parameters: value - string - This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior. attachment_file - file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here. disable_parent_folder_behavior - boolean - If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree. recursive - boolean - If `true`, behavior is treated as recursive, meaning that it impacts child folders as well. name - string - Name for this behavior. description - string - Description for this behavior. attachment_delete - boolean - If `true`, delete the file stored in `attachment`.
    
    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<Behavior> 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 `behavior`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`. filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`.
    
    Throws:
    
    RuntimeException
  - list
```
public static ListIterator<Behavior> list(HashMap<String,Object> parameters)
                                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - list
```
public static ListIterator<Behavior> list(HashMap<String,Object> parameters,
                                          HashMap<String,Object> options)
                                   throws RuntimeException
```
    Throws:
    
    RuntimeException
  - all
```
public static ListIterator<Behavior> all()
                                  throws RuntimeException
```
    Throws:
    
    RuntimeException
  - all
```
public static ListIterator<Behavior> all(HashMap<String,Object> parameters,
                                         HashMap<String,Object> options)
                                  throws RuntimeException
```
    Throws:
    
    RuntimeException
  - find
```
public static Behavior find(Long id,
                            HashMap<String,Object> parameters)
                     throws RuntimeException
```
    Parameters: id (required) - int64 - Behavior ID.
    
    Throws:
    
    RuntimeException
  - find
```
public static Behavior find(HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException
```
    Throws:
    
    RuntimeException
  - find
```
public static Behavior find(Long id,
                            HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException
```
    Throws:
    
    RuntimeException
  - get
```
public static Behavior get()
                    throws RuntimeException
```
    Throws:
    
    RuntimeException
  - get
```
public static Behavior get(Long id,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException
```
    Throws:
    
    RuntimeException
  - listFor
```
public static ListIterator<Behavior> listFor()
                                      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 `behavior`. filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `impacts_ui` and `behavior`. filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `behavior`. path (required) - string - Path to operate on. ancestor_behaviors - boolean - If `true`, behaviors above this path are shown.
    
    Throws:
    
    RuntimeException
  - listFor
```
public static ListIterator<Behavior> listFor(String path,
                                             HashMap<String,Object> parameters)
                                      throws RuntimeException
```
    Throws:
    
    RuntimeException
  - listFor
```
public static ListIterator<Behavior> listFor(HashMap<String,Object> parameters,
                                             HashMap<String,Object> options)
                                      throws RuntimeException
```
    Throws:
    
    RuntimeException
  - listFor
```
public static ListIterator<Behavior> listFor(String path,
                                             HashMap<String,Object> parameters,
                                             HashMap<String,Object> options)
                                      throws RuntimeException
```
    Throws:
    
    RuntimeException
  - create
```
public static Behavior create(HashMap<String,Object> parameters)
                       throws RuntimeException
```
    Parameters: value - string - This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior. attachment_file - file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here. disable_parent_folder_behavior - boolean - If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree. recursive - boolean - If `true`, behavior is treated as recursive, meaning that it impacts child folders as well. name - string - Name for this behavior. description - string - Description for this behavior. path (required) - string - Path where this behavior should apply. behavior (required) - string - Behavior type.
    
    Throws:
    
    RuntimeException
  - create
```
public static Behavior create(HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException
```
    Throws:
    
    RuntimeException
  - webhookTest
```
public static void webhookTest(HashMap<String,Object> parameters)
                        throws RuntimeException
```
    Parameters: url (required) - string - URL for testing the webhook. method - string - HTTP request method (GET or POST). encoding - string - Encoding type for the webhook payload. Can be JSON, XML, or RAW (form data). headers - object - Additional request headers to send via HTTP. body - object - Additional body parameters to include in the webhook payload. action - string - Action for test body.
    
    Throws:
    
    RuntimeException
  - webhookTest
```
public static void webhookTest(HashMap<String,Object> parameters,
                               HashMap<String,Object> options)
                        throws RuntimeException
```
    Throws:
    
    RuntimeException
  - update
```
public static Behavior update(Long id,
                              HashMap<String,Object> parameters)
                       throws RuntimeException
```
    Parameters: value - string - This field stores a hash of data specific to the type of behavior. See The Behavior Types section for example values for each type of behavior. attachment_file - file - Certain behaviors may require a file, for instance, the `watermark` behavior requires a watermark image. Attach that file here. disable_parent_folder_behavior - boolean - If `true`, the parent folder's behavior will be disabled for this folder and its children. This is the main mechanism for canceling out a `recursive` behavior higher in the folder tree. recursive - boolean - If `true`, behavior is treated as recursive, meaning that it impacts child folders as well. name - string - Name for this behavior. description - string - Description for this behavior. attachment_delete - boolean - If `true`, delete the file stored in `attachment`.
    
    Throws:
    
    RuntimeException
  - update
```
public static Behavior update(HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException
```
    Throws:
    
    RuntimeException
  - update
```
public static Behavior 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

Class Behavior

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.files.models.ModelInterface

Field Detail

id

path

attachmentUrl

behavior

name

description

value

disableParentFolderBehavior

recursive

attachmentFile

attachmentDelete

Constructor Detail

Behavior

Behavior

Behavior

Method Detail

update

delete

destroy

save

list

list

list

all

all

find

find

find

get

get

listFor

listFor

listFor

listFor

create

create

webhookTest

webhookTest

update

update

update

delete

delete

delete

destroy

destroy