File (Files.com Java SDK 1.4.56 API)

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

All Implemented Interfaces:: ModelInterface

public class File
extends Object
implements ModelInterface

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`action` The action to perform.
`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
`Long`	`length` Length of file.
`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.
`Long`	`part` Part if uploading a part.
`Long`	`parts` How many parts to fetch?
`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`	`ref`
`String`	`region` Region location
`Long`	`restart` File byte offset to restart from.
`Long`	`size` File/Folder size
`String`	`structure` If copying folder, copy just the structure?
`Boolean`	`subfoldersLocked` Are subfolders locked and unable to be modified?
`String`	`type` Type: `directory` or `file`.
`Boolean`	`withRename` Allow file rename instead of overwrite?

Constructor Summary

Constructors
Constructor and Description

File()

Constructors
Constructor and Description
`File()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FileUploadPart`	`beginUpload()` Begin File Upload Parameters: mkdir_parents - boolean - Create parent directories if they do not exist?
`static FileUploadPart`	`beginUpload(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static FileUploadPart`	`beginUpload(String path, HashMap<String,Object> parameters)` Begin File Upload Parameters: mkdir_parents - boolean - Create parent directories if they do not exist?
`static FileUploadPart`	`beginUpload(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static File`	`completeUpload(String path, HashMap<String,Object> parameters)`
`static File`	`completeUpload(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`FileAction`	`copy()` Copy file/folder Parameters: destination (required) - string - Copy destination path.
`static FileAction`	`copy(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static FileAction`	`copy(String path, HashMap<String,Object> parameters)` Copy file/folder Parameters: destination (required) - string - Copy destination path.
`static FileAction`	`copy(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static FileUploadPart`	`create(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static FileUploadPart`	`create(String path, HashMap<String,Object> parameters)` Parameters: path (required) - string - Path to operate on.
`static FileUploadPart`	`create(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`void`	`delete()` Parameters: recursive - boolean - If true, will recursively delete folers.
`static void`	`delete(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static void`	`delete(String path, HashMap<String,Object> parameters)` Parameters: recursive - boolean - If true, will recursively delete folers.
`static void`	`delete(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static void`	`destroy()`
`void`	`destroy(HashMap<String,Object> parameters)`
`static void`	`destroy(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`File`	`download()` Download file Parameters: action - string - Can be blank, `redirect` or `stat`.
`static File`	`download(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static File`	`download(String path, HashMap<String,Object> parameters)` Download file Parameters: action - string - Can be blank, `redirect` or `stat`.
`static File`	`download(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static File`	`find(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static File`	`find(String path, HashMap<String,Object> parameters)` Parameters: path (required) - string - Path to operate on.
`static File`	`find(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static File`	`get()`
`static File`	`get(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`FilesInputStream`	`getInputStream()`
`FilesInputStream`	`getInputStream(long start)`
`FilesInputStream`	`getInputStream(long start, long end)`
`FileAction`	`move()` Move file/folder Parameters: destination (required) - string - Move destination path.
`static FileAction`	`move(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static FileAction`	`move(String path, HashMap<String,Object> parameters)` Move file/folder Parameters: destination (required) - string - Move destination path.
`static FileAction`	`move(String path, HashMap<String,Object> parameters, HashMap<String,Object> options)`
`void`	`save()`
`void`	`saveAsLocalFile(String path)` Save the File to disk.
`File`	`update()` Parameters: custom_metadata - object - Custom metadata map of keys and values.
`static File`	`update(HashMap<String,Object> parameters, HashMap<String,Object> options)`
`static File`	`update(String path, HashMap<String,Object> parameters)` Parameters: custom_metadata - object - Custom metadata map of keys and values.
`static File`	`update(String path, 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
- 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
- action
```
public String action
```
  The action to perform. Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
- length
```
public Long length
```
  Length of file.
- mkdirParents
```
public Boolean mkdirParents
```
  Create parent directories if they do not exist?
- part
```
public Long part
```
  Part if uploading a part.
- parts
```
public Long parts
```
  How many parts to fetch?
- ref
```
public String ref
```
- restart
```
public Long restart
```
  File byte offset to restart from.
- structure
```
public String structure
```
  If copying folder, copy just the structure?
- withRename
```
public Boolean withRename
```
  Allow file rename instead of overwrite?

Constructor Detail
- File
```
public File()
```

Method Detail

getInputStream

public FilesInputStream getInputStream()
                                throws IOException

Throws:: IOException

getInputStream

public FilesInputStream getInputStream(long start)
                                throws IOException

Throws:: IOException

getInputStream

public FilesInputStream getInputStream(long start,
                                       long end)
                                throws IOException

Throws:: IOException

saveAsLocalFile

public void saveAsLocalFile(String path)
                     throws IOException

Save the File to disk.

Throws:: IOException

completeUpload

public static File completeUpload(String path,
                                  HashMap<String,Object> parameters)
                           throws IOException

Throws:: IOException

completeUpload

public static File completeUpload(String path,
                                  HashMap<String,Object> parameters,
                                  HashMap<String,Object> options)
                           throws IOException

Throws:: IOException

download
```
public File download()
              throws IOException
```
Download file Parameters: action - string - Can be blank, `redirect` or `stat`. If set to `stat`, we will return file information but without a download URL, and without logging a download. If set to `redirect` we will serve a 302 redirect directly to the file. This is used for integrations with Zapier, and is not recommended for most integrations. preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`. with_previews - boolean - Include file preview information? with_priority_color - boolean - Include file priority color information?

Throws:

IOException

update
```
public File update()
            throws IOException
```
Parameters: custom_metadata - object - Custom metadata map of keys and values. Limited to 32 keys, 256 characters per key and 1024 characters per value. provided_mtime - string - Modified time of file. priority_color - string - Priority/Bookmark color of file.

Throws:

IOException

delete
```
public void delete()
            throws IOException
```
Parameters: recursive - boolean - If true, will recursively delete folers. Otherwise, will error on non-empty folders.

Throws:

IOException

destroy

public void destroy(HashMap<String,Object> parameters)
             throws IOException

Throws:: IOException

copy
```
public FileAction copy()
                throws IOException
```
Copy file/folder Parameters: destination (required) - string - Copy destination path. structure - boolean - Copy structure only? overwrite - boolean - Overwrite existing file(s) in the destination?

Throws:

IOException

move
```
public FileAction move()
                throws IOException
```
Move file/folder Parameters: destination (required) - string - Move destination path. overwrite - boolean - Overwrite existing file(s) in the destination?

Throws:

IOException

beginUpload
```
public FileUploadPart beginUpload()
                           throws IOException
```
Begin File Upload Parameters: mkdir_parents - boolean - Create parent directories if they do not exist? part - int64 - Part if uploading a part. parts - int64 - How many parts to fetch? ref - string - restart - int64 - File byte offset to restart from. size - int64 - Total bytes of file being uploaded (include bytes being retained if appending/restarting). with_rename - boolean - Allow file rename instead of overwrite?

Throws:

IOException

save

public void save()
          throws IOException

Throws:: IOException

download
```
public static File download(String path,
                            HashMap<String,Object> parameters)
                     throws RuntimeException
```
Download file Parameters: action - string - Can be blank, `redirect` or `stat`. If set to `stat`, we will return file information but without a download URL, and without logging a download. If set to `redirect` we will serve a 302 redirect directly to the file. This is used for integrations with Zapier, and is not recommended for most integrations. preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`. with_previews - boolean - Include file preview information? with_priority_color - boolean - Include file priority color information?

Throws:

RuntimeException

download

public static File download(HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException

Throws:: RuntimeException

download

public static File download(String path,
                            HashMap<String,Object> parameters,
                            HashMap<String,Object> options)
                     throws RuntimeException

Throws:: RuntimeException

create
```
public static FileUploadPart create(String path,
                                    HashMap<String,Object> parameters)
                             throws RuntimeException
```
Parameters: path (required) - string - Path to operate on. action - string - The action to perform. Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist etags[etag] (required) - array(string) - etag identifier. etags[part] (required) - array(int64) - Part number. length - int64 - Length of file. mkdir_parents - boolean - Create parent directories if they do not exist? part - int64 - Part if uploading a part. parts - int64 - How many parts to fetch? provided_mtime - string - User provided modification time. ref - string - restart - int64 - File byte offset to restart from. size - int64 - Size of file. structure - string - If copying folder, copy just the structure? with_rename - boolean - Allow file rename instead of overwrite?

Throws:

RuntimeException

create

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

Throws:: RuntimeException

create

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

Throws:: RuntimeException

update
```
public static File update(String path,
                          HashMap<String,Object> parameters)
                   throws RuntimeException
```
Parameters: custom_metadata - object - Custom metadata map of keys and values. Limited to 32 keys, 256 characters per key and 1024 characters per value. provided_mtime - string - Modified time of file. priority_color - string - Priority/Bookmark color of file.

Throws:

RuntimeException

update

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

Throws:: RuntimeException

update

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

Throws:: RuntimeException

delete

public static void delete(String path,
                          HashMap<String,Object> parameters)
                   throws RuntimeException

Parameters: recursive - boolean - If true, will recursively delete folers. Otherwise, will error on non-empty folders.

Throws:: RuntimeException

delete

public static void delete(HashMap<String,Object> parameters,
                          HashMap<String,Object> options)
                   throws RuntimeException

Throws:: RuntimeException

delete

public static void delete(String path,
                          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(String path,
                           HashMap<String,Object> parameters,
                           HashMap<String,Object> options)
                    throws RuntimeException

Throws:: RuntimeException

find
```
public static File find(String path,
                        HashMap<String,Object> parameters)
                 throws RuntimeException
```
Parameters: path (required) - string - Path to operate on. preview_size - string - Request a preview size. Can be `small` (default), `large`, `xlarge`, or `pdf`. with_previews - boolean - Include file preview information? with_priority_color - boolean - Include file priority color information?

Throws:

RuntimeException

find

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

Throws:: RuntimeException

find

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

Throws:: RuntimeException

get

public static File get()
                throws RuntimeException

Throws:: RuntimeException

get

public static File get(String path,
                       HashMap<String,Object> parameters,
                       HashMap<String,Object> options)
                throws RuntimeException

Throws:: RuntimeException

copy
```
public static FileAction copy(String path,
                              HashMap<String,Object> parameters)
                       throws RuntimeException
```
Copy file/folder Parameters: destination (required) - string - Copy destination path. structure - boolean - Copy structure only? overwrite - boolean - Overwrite existing file(s) in the destination?

Throws:

RuntimeException

copy

public static FileAction copy(HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException

Throws:: RuntimeException

copy

public static FileAction copy(String path,
                              HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException

Throws:: RuntimeException

move

public static FileAction move(String path,
                              HashMap<String,Object> parameters)
                       throws RuntimeException

Move file/folder Parameters: destination (required) - string - Move destination path. overwrite - boolean - Overwrite existing file(s) in the destination?

Throws:: RuntimeException

move

public static FileAction move(HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException

Throws:: RuntimeException

move

public static FileAction move(String path,
                              HashMap<String,Object> parameters,
                              HashMap<String,Object> options)
                       throws RuntimeException

Throws:: RuntimeException

beginUpload
```
public static FileUploadPart beginUpload(String path,
                                         HashMap<String,Object> parameters)
                                  throws RuntimeException
```
Begin File Upload Parameters: mkdir_parents - boolean - Create parent directories if they do not exist? part - int64 - Part if uploading a part. parts - int64 - How many parts to fetch? ref - string - restart - int64 - File byte offset to restart from. size - int64 - Total bytes of file being uploaded (include bytes being retained if appending/restarting). with_rename - boolean - Allow file rename instead of overwrite?

Throws:

RuntimeException

beginUpload

public static FileUploadPart beginUpload(HashMap<String,Object> parameters,
                                         HashMap<String,Object> options)
                                  throws RuntimeException

Throws:: RuntimeException

beginUpload

public static FileUploadPart beginUpload(String path,
                                         HashMap<String,Object> parameters,
                                         HashMap<String,Object> options)
                                  throws RuntimeException

Throws:: RuntimeException

Class File

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

action

length

mkdirParents

part

parts

ref

restart

structure

withRename

Constructor Detail

File

Method Detail

getInputStream

getInputStream

getInputStream

saveAsLocalFile

completeUpload

completeUpload

download

update

delete

destroy

copy

move

beginUpload

save

download

download

download

create

create

create

update

update

update

delete

delete

delete

destroy

destroy