Folder (Files.com Java SDK 1.4.56 API)

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

All Implemented Interfaces:: ModelInterface

public class Folder
extends Object
implements ModelInterface

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`crc32` File CRC32 checksum.
`Date`	`createdAt` File created date/time
`Long`	`createdByApiKeyId` ID of the API key that created the file/folder
`Long`	`createdByAs2IncomingMessageId` ID of the AS2 Incoming Message that created the file/folder
`Long`	`createdByAutomationId` ID of the Automation that created the file/folder
`Long`	`createdByBundleRegistrationId` ID of the Bundle Registration that created the file/folder
`Long`	`createdById` User ID of the User who created the file/folder
`Long`	`createdByInboxId` ID of the Inbox that created the file/folder
`Long`	`createdByRemoteServerId` ID of the Remote Server that created the file/folder
`Long`	`createdByRemoteServerSyncId` ID of the Remote Server Sync that created the file/folder
`Map<String,String>`	`customMetadata` Custom metadata map of keys and values.
`String`	`displayName` File/Folder display name
`String`	`downloadUri` Link to download file.
`Boolean`	`isLocked` Is this folder locked and unable to be modified?
`Long`	`lastModifiedByApiKeyId` ID of the API key that last modified the file/folder
`Long`	`lastModifiedByAutomationId` ID of the Automation that last modified the file/folder
`Long`	`lastModifiedByBundleRegistrationId` ID of the Bundle Registration that last modified the file/folder
`Long`	`lastModifiedById` User ID of the User who last modified the file/folder
`Long`	`lastModifiedByRemoteServerId` ID of the Remote Server that last modified the file/folder
`Long`	`lastModifiedByRemoteServerSyncId` ID of the Remote Server Sync that last modified the file/folder
`String`	`md5` File MD5 checksum.
`String`	`mimeType` MIME Type.
`Boolean`	`mkdirParents` Create parent directories if they do not exist?
`Date`	`mtime` File last modified date/time, according to the server.
`String`	`path` File/Folder path.
`String`	`permissions` A short string representing the current user's permissions.
`Preview`	`preview` File preview
`Long`	`previewId` File preview ID
`String`	`priorityColor` Bookmark/priority color of file/folder
`Date`	`providedMtime` File last modified date/time, according to the client who set it.
`String`	`region` Region location
`Long`	`size` File/Folder size
`Boolean`	`subfoldersLocked` Are subfolders locked and unable to be modified?
`String`	`type` Type: `directory` or `file`.

Constructor Summary

Constructors
Constructor and Description

Folder()

Folder(HashMap<String,Object> parameters)

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

Constructors
Constructor and Description
`Folder()`
`Folder(HashMap<String,Object> parameters)`
`Folder(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 Folder`	`create(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static Folder`	`create(String path, HashMap<String,Object> parameters)` Parameters: path (required) - string - Path to operate on.
`static Folder`	`create(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static ListIterator<File>`	`listFor()` Parameters: cursor - string - Send cursor to resume an existing list from the point at which you left off.
`static ListIterator<File>`	`listFor(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static ListIterator<File>`	`listFor(String path, HashMap<String,Object> parameters)`
`static ListIterator<File>`	`listFor(String path, 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
  - path
```
public String path
```
    File/Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
  - createdById
```
public Long createdById
```
    User ID of the User who created the file/folder
  - createdByApiKeyId
```
public Long createdByApiKeyId
```
    ID of the API key that created the file/folder
  - createdByAs2IncomingMessageId
```
public Long createdByAs2IncomingMessageId
```
    ID of the AS2 Incoming Message that created the file/folder
  - createdByAutomationId
```
public Long createdByAutomationId
```
    ID of the Automation that created the file/folder
  - createdByBundleRegistrationId
```
public Long createdByBundleRegistrationId
```
    ID of the Bundle Registration that created the file/folder
  - createdByInboxId
```
public Long createdByInboxId
```
    ID of the Inbox that created the file/folder
  - createdByRemoteServerId
```
public Long createdByRemoteServerId
```
    ID of the Remote Server that created the file/folder
  - createdByRemoteServerSyncId
```
public Long createdByRemoteServerSyncId
```
    ID of the Remote Server Sync that created the file/folder
  - customMetadata
```
public Map<String,String> customMetadata
```
    Custom metadata map of keys and values. Limited to 32 keys, 256 characters per key and 1024 characters per value.
  - displayName
```
public String displayName
```
    File/Folder display name
  - type
```
public String type
```
    Type: `directory` or `file`.
  - size
```
public Long size
```
    File/Folder size
  - createdAt
```
public Date createdAt
```
    File created date/time
  - lastModifiedById
```
public Long lastModifiedById
```
    User ID of the User who last modified the file/folder
  - lastModifiedByApiKeyId
```
public Long lastModifiedByApiKeyId
```
    ID of the API key that last modified the file/folder
  - lastModifiedByAutomationId
```
public Long lastModifiedByAutomationId
```
    ID of the Automation that last modified the file/folder
  - lastModifiedByBundleRegistrationId
```
public Long lastModifiedByBundleRegistrationId
```
    ID of the Bundle Registration that last modified the file/folder
  - lastModifiedByRemoteServerId
```
public Long lastModifiedByRemoteServerId
```
    ID of the Remote Server that last modified the file/folder
  - lastModifiedByRemoteServerSyncId
```
public Long lastModifiedByRemoteServerSyncId
```
    ID of the Remote Server Sync that last modified the file/folder
  - mtime
```
public Date mtime
```
    File last modified date/time, according to the server. This is the timestamp of the last Files.com operation of the file, regardless of what modified timestamp was sent.
  - providedMtime
```
public Date providedMtime
```
    File last modified date/time, according to the client who set it. Files.com allows desktop, FTP, SFTP, and WebDAV clients to set modified at times. This allows Desktop :Cloud syncing to preserve modified at times.
  - crc32
```
public String crc32
```
    File CRC32 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
  - md5
```
public String md5
```
    File MD5 checksum. This is sometimes delayed, so if you get a blank response, wait and try again.
  - mimeType
```
public String mimeType
```
    MIME Type. This is determined by the filename extension and is not stored separately internally.
  - region
```
public String region
```
    Region location
  - permissions
```
public String permissions
```
    A short string representing the current user's permissions. Can be `r` (Read),`w` (Write),`d` (Delete), `l` (List) or any combination
  - subfoldersLocked
```
public Boolean subfoldersLocked
```
    Are subfolders locked and unable to be modified?
  - isLocked
```
public Boolean isLocked
```
    Is this folder locked and unable to be modified?
  - downloadUri
```
public String downloadUri
```
    Link to download file. Provided only in response to a download request.
  - priorityColor
```
public String priorityColor
```
    Bookmark/priority color of file/folder
  - previewId
```
public Long previewId
```
    File preview ID
  - preview
```
public Preview preview
```
    File preview
  - mkdirParents
```
public Boolean mkdirParents
```
    Create parent directories if they do not exist?
- Constructor Detail
  - Folder
```
public Folder()
```
  - Folder
```
public Folder(HashMap<String,Object> parameters)
```
  - Folder
```
public Folder(HashMap<String,Object> parameters,
              HashMap<String,Object> options)
```
- Method Detail
  - save
```
public void save()
          throws IOException
```
    Throws:
    
    IOException
  - listFor
```
public static ListIterator<File> listFor()
                                  throws RuntimeException
```
    Parameters: cursor - string - Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header. per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended). path (required) - string - Path to operate on. filter - string - If specified, will filter folders/files list by name. Ignores text before last `/`. Wildcards of `*` and `?` are acceptable here. preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`. sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`. Valid directions are `asc` and `desc`. Defaults to `{"path":"asc"}`. search - string - If `search_all` is `true`, provide the search string here. Otherwise, this parameter acts like an alias of `filter`. search_all - boolean - Search entire site? If set, we will ignore the folder path provided and search the entire site. This is the same API used by the search bar in the UI. Search results are a best effort, not real time, and not guaranteed to match every file. This field should only be used for ad-hoc (human) searching, and not as part of an automated process. with_previews - boolean - Include file previews? with_priority_color - boolean - Include file priority color information?
    
    Throws:
    
    RuntimeException
  - listFor
```
public static ListIterator<File> listFor(String path,
                                         HashMap<String,Object> parameters)
                                  throws RuntimeException
```
    Throws:
    
    RuntimeException
  - listFor
```
public static ListIterator<File> listFor(HashMap<String,Object> parameters,
                                         HashMap<String,Object> options)
                                  throws RuntimeException
```
    Throws:
    
    RuntimeException
  - listFor
```
public static ListIterator<File> listFor(String path,
                                         HashMap<String,Object> parameters,
                                         HashMap<String,Object> options)
                                  throws RuntimeException
```
    Throws:
    
    RuntimeException
  - create
```
public static Folder create(String path,
                            HashMap<String,Object> parameters)
                     throws RuntimeException
```
    Parameters: path (required) - string - Path to operate on. mkdir_parents - boolean - Create parent directories if they do not exist? provided_mtime - string - User provided modification time.
    
    Throws:
    
    RuntimeException
  - create
```
public static Folder create(HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException
```
    Throws:
    
    RuntimeException
  - create
```
public static Folder create(String path,
                            HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException
```
    Throws:
    
    RuntimeException

Class Folder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.files.models.ModelInterface

Field Detail

path

createdById

createdByApiKeyId

createdByAs2IncomingMessageId

createdByAutomationId

createdByBundleRegistrationId

createdByInboxId

createdByRemoteServerId

createdByRemoteServerSyncId

customMetadata

displayName

type

size

createdAt

lastModifiedById

lastModifiedByApiKeyId

lastModifiedByAutomationId

lastModifiedByBundleRegistrationId

lastModifiedByRemoteServerId

lastModifiedByRemoteServerSyncId

mtime

providedMtime

crc32

md5

mimeType

region

permissions

subfoldersLocked

isLocked

downloadUri

priorityColor

previewId

preview

mkdirParents

Constructor Detail

Folder

Folder

Folder

Method Detail

save

listFor

listFor

listFor

listFor

create

create

create