public class DbxUserFilesRequests
extends java.lang.Object
| Constructor and Description |
|---|
DbxUserFilesRequests(DbxRawClientV2 client) |
| Modifier and Type | Method and Description |
|---|---|
Metadata |
alphaGetMetadata(java.lang.String path)
Deprecated.
use
getMetadata(String) instead. |
AlphaGetMetadataBuilder |
alphaGetMetadataBuilder(java.lang.String path)
Deprecated.
use
getMetadata(String) instead. |
AlphaUploadUploader |
alphaUpload(java.lang.String path)
Deprecated.
use
alphaUpload(String) instead. |
AlphaUploadBuilder |
alphaUploadBuilder(java.lang.String path)
Deprecated.
use
alphaUpload(String) instead. |
Metadata |
copy(java.lang.String fromPath,
java.lang.String toPath)
Deprecated.
use
copyV2(String,String)
instead. |
RelocationBatchLaunch |
copyBatch(java.util.List<RelocationPath> entries)
Copy multiple files or folders to different locations at once in the
user's Dropbox.
|
CopyBatchBuilder |
copyBatchBuilder(java.util.List<RelocationPath> entries)
Copy multiple files or folders to different locations at once in the
user's Dropbox.
|
RelocationBatchJobStatus |
copyBatchCheck(java.lang.String asyncJobId)
Returns the status of an asynchronous job for
copyBatch(List). |
CopyBuilder |
copyBuilder(java.lang.String fromPath,
java.lang.String toPath)
Deprecated.
use
copyV2(String,String)
instead. |
GetCopyReferenceResult |
copyReferenceGet(java.lang.String path)
Get a copy reference to a file or folder.
|
SaveCopyReferenceResult |
copyReferenceSave(java.lang.String copyReference,
java.lang.String path)
Save a copy reference returned by
copyReferenceGet(String) to the user's Dropbox. |
RelocationResult |
copyV2(java.lang.String fromPath,
java.lang.String toPath)
Copy a file or folder to a different location in the user's Dropbox.
|
CopyV2Builder |
copyV2Builder(java.lang.String fromPath,
java.lang.String toPath)
Copy a file or folder to a different location in the user's Dropbox.
|
FolderMetadata |
createFolder(java.lang.String path)
Deprecated.
use
createFolderV2(String,boolean) instead. |
FolderMetadata |
createFolder(java.lang.String path,
boolean autorename)
Deprecated.
use
createFolderV2(String,boolean) instead. |
CreateFolderBatchLaunch |
createFolderBatch(java.util.List<java.lang.String> paths)
Create multiple folders at once.
|
CreateFolderBatchBuilder |
createFolderBatchBuilder(java.util.List<java.lang.String> paths)
Create multiple folders at once.
|
CreateFolderBatchJobStatus |
createFolderBatchCheck(java.lang.String asyncJobId)
Returns the status of an asynchronous job for
createFolderBatch(List). |
CreateFolderResult |
createFolderV2(java.lang.String path)
Create a folder at a given path.
|
CreateFolderResult |
createFolderV2(java.lang.String path,
boolean autorename)
Create a folder at a given path.
|
Metadata |
delete(java.lang.String path)
Deprecated.
use
deleteV2(String,String)
instead. |
Metadata |
delete(java.lang.String path,
java.lang.String parentRev)
Deprecated.
use
deleteV2(String,String)
instead. |
DeleteBatchLaunch |
deleteBatch(java.util.List<DeleteArg> entries)
Delete multiple files/folders at once.
|
DeleteBatchJobStatus |
deleteBatchCheck(java.lang.String asyncJobId)
Returns the status of an asynchronous job for
deleteBatch(List). |
DeleteResult |
deleteV2(java.lang.String path)
Delete the file or folder at a given path.
|
DeleteResult |
deleteV2(java.lang.String path,
java.lang.String parentRev)
Delete the file or folder at a given path.
|
DbxDownloader<FileMetadata> |
download(java.lang.String path)
Download a file from a user's Dropbox.
|
DbxDownloader<FileMetadata> |
download(java.lang.String path,
java.lang.String rev)
Download a file from a user's Dropbox.
|
DownloadBuilder |
downloadBuilder(java.lang.String path)
Download a file from a user's Dropbox.
|
DbxDownloader<DownloadZipResult> |
downloadZip(java.lang.String path)
Download a folder from the user's Dropbox, as a zip file.
|
DownloadZipBuilder |
downloadZipBuilder(java.lang.String path)
Download a folder from the user's Dropbox, as a zip file.
|
Metadata |
getMetadata(java.lang.String path)
Returns the metadata for a file or folder.
|
GetMetadataBuilder |
getMetadataBuilder(java.lang.String path)
Returns the metadata for a file or folder.
|
DbxDownloader<FileMetadata> |
getPreview(java.lang.String path)
Get a preview for a file.
|
DbxDownloader<FileMetadata> |
getPreview(java.lang.String path,
java.lang.String rev)
Get a preview for a file.
|
GetPreviewBuilder |
getPreviewBuilder(java.lang.String path)
Get a preview for a file.
|
GetTemporaryLinkResult |
getTemporaryLink(java.lang.String path)
Get a temporary link to stream content of a file.
|
DbxDownloader<FileMetadata> |
getThumbnail(java.lang.String path)
Get a thumbnail for an image.
|
GetThumbnailBatchResult |
getThumbnailBatch(java.util.List<ThumbnailArg> entries)
Get thumbnails for a list of images.
|
GetThumbnailBuilder |
getThumbnailBuilder(java.lang.String path)
Get a thumbnail for an image.
|
ListFolderResult |
listFolder(java.lang.String path)
Starts returning the contents of a folder.
|
ListFolderBuilder |
listFolderBuilder(java.lang.String path)
Starts returning the contents of a folder.
|
ListFolderResult |
listFolderContinue(java.lang.String cursor)
Once a cursor has been retrieved from
listFolder(String), use this to paginate through
all files and retrieve updates to the folder, following the same rules as
documented for listFolder(String). |
ListFolderGetLatestCursorResult |
listFolderGetLatestCursor(java.lang.String path)
A way to quickly get a cursor for the folder's state.
|
ListFolderGetLatestCursorBuilder |
listFolderGetLatestCursorBuilder(java.lang.String path)
A way to quickly get a cursor for the folder's state.
|
ListFolderLongpollResult |
listFolderLongpoll(java.lang.String cursor)
A longpoll endpoint to wait for changes on an account.
|
ListFolderLongpollResult |
listFolderLongpoll(java.lang.String cursor,
long timeout)
A longpoll endpoint to wait for changes on an account.
|
ListRevisionsResult |
listRevisions(java.lang.String path)
Returns revisions for files based on a file path or a file id.
|
ListRevisionsBuilder |
listRevisionsBuilder(java.lang.String path)
Returns revisions for files based on a file path or a file id.
|
Metadata |
move(java.lang.String fromPath,
java.lang.String toPath)
Deprecated.
use
moveV2(String,String)
instead. |
RelocationBatchLaunch |
moveBatch(java.util.List<RelocationPath> entries)
Move multiple files or folders to different locations at once in the
user's Dropbox.
|
MoveBatchBuilder |
moveBatchBuilder(java.util.List<RelocationPath> entries)
Move multiple files or folders to different locations at once in the
user's Dropbox.
|
RelocationBatchJobStatus |
moveBatchCheck(java.lang.String asyncJobId)
Returns the status of an asynchronous job for
moveBatch(List). |
MoveBuilder |
moveBuilder(java.lang.String fromPath,
java.lang.String toPath)
Deprecated.
use
moveV2(String,String)
instead. |
RelocationResult |
moveV2(java.lang.String fromPath,
java.lang.String toPath)
Move a file or folder to a different location in the user's Dropbox.
|
MoveV2Builder |
moveV2Builder(java.lang.String fromPath,
java.lang.String toPath)
Move a file or folder to a different location in the user's Dropbox.
|
void |
permanentlyDelete(java.lang.String path)
Permanently delete the file or folder at a given path (see
https://www.dropbox.com/en/help/40).
|
void |
permanentlyDelete(java.lang.String path,
java.lang.String parentRev)
Permanently delete the file or folder at a given path (see
https://www.dropbox.com/en/help/40).
|
void |
propertiesAdd(java.lang.String path,
java.util.List<PropertyGroup> propertyGroups)
Deprecated.
|
void |
propertiesOverwrite(java.lang.String path,
java.util.List<PropertyGroup> propertyGroups)
Deprecated.
|
void |
propertiesRemove(java.lang.String path,
java.util.List<java.lang.String> propertyTemplateIds)
Deprecated.
|
GetTemplateResult |
propertiesTemplateGet(java.lang.String templateId)
Deprecated.
|
ListTemplateResult |
propertiesTemplateList()
Deprecated.
|
void |
propertiesUpdate(java.lang.String path,
java.util.List<PropertyGroupUpdate> updatePropertyGroups)
Deprecated.
|
FileMetadata |
restore(java.lang.String path,
java.lang.String rev)
Restore a file to a specific revision.
|
SaveUrlResult |
saveUrl(java.lang.String path,
java.lang.String url)
Save a specified URL into a file in user's Dropbox.
|
SaveUrlJobStatus |
saveUrlCheckJobStatus(java.lang.String asyncJobId)
Check the status of a
saveUrl(String,String)
job. |
SearchResult |
search(java.lang.String path,
java.lang.String query)
Searches for files and folders.
|
SearchBuilder |
searchBuilder(java.lang.String path,
java.lang.String query)
Searches for files and folders.
|
UploadUploader |
upload(java.lang.String path)
Create a new file with the contents provided in the request.
|
UploadBuilder |
uploadBuilder(java.lang.String path)
Create a new file with the contents provided in the request.
|
UploadSessionAppendUploader |
uploadSessionAppend(java.lang.String sessionId,
long offset)
Deprecated.
use
uploadSessionAppendV2(UploadSessionCursor,boolean)
instead. |
UploadSessionAppendV2Uploader |
uploadSessionAppendV2(UploadSessionCursor cursor)
Append more data to an upload session.
|
UploadSessionAppendV2Uploader |
uploadSessionAppendV2(UploadSessionCursor cursor,
boolean close)
Append more data to an upload session.
|
UploadSessionFinishUploader |
uploadSessionFinish(UploadSessionCursor cursor,
CommitInfo commit)
Finish an upload session and save the uploaded data to the given file
path.
|
UploadSessionFinishBatchLaunch |
uploadSessionFinishBatch(java.util.List<UploadSessionFinishArg> entries)
This route helps you commit many files at once into a user's Dropbox.
|
UploadSessionFinishBatchJobStatus |
uploadSessionFinishBatchCheck(java.lang.String asyncJobId)
Returns the status of an asynchronous job for
uploadSessionFinishBatch(List). |
UploadSessionStartUploader |
uploadSessionStart()
Upload sessions allow you to upload a single file in one or more
requests, for example where the size of the file is greater than 150 MB.
|
UploadSessionStartUploader |
uploadSessionStart(boolean close)
Upload sessions allow you to upload a single file in one or more
requests, for example where the size of the file is greater than 150 MB.
|
public DbxUserFilesRequests(DbxRawClientV2 client)
@Deprecated public Metadata alphaGetMetadata(java.lang.String path) throws AlphaGetMetadataErrorException, DbxException
getMetadata(String) instead. The default values for the optional request parameters will be used.
See AlphaGetMetadataBuilder for more details.
path - The path of a file or folder on Dropbox. Must match pattern
"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.AlphaGetMetadataErrorExceptionDbxException@Deprecated public AlphaGetMetadataBuilder alphaGetMetadataBuilder(java.lang.String path)
getMetadata(String) instead.path - The path of a file or folder on Dropbox. Must match pattern
"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.@Deprecated public AlphaUploadUploader alphaUpload(java.lang.String path) throws DbxException
alphaUpload(String) instead.upload(String). Do not use
this to upload a file larger than 150 MB. Instead, create an upload
session with uploadSessionStart(boolean).
The default values for the optional request parameters will be used.
See AlphaUploadBuilder for more details.
path - Path in the user's Dropbox to save the file. Must match
pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)" and not
be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DbxException@Deprecated public AlphaUploadBuilder alphaUploadBuilder(java.lang.String path)
alphaUpload(String) instead.upload(String). Do not use
this to upload a file larger than 150 MB. Instead, create an upload
session with uploadSessionStart(boolean).path - Path in the user's Dropbox to save the file. Must match
pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)" and not
be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.@Deprecated public Metadata copy(java.lang.String fromPath, java.lang.String toPath) throws RelocationErrorException, DbxException
copyV2(String,String)
instead. The default values for the optional request parameters will be used.
See CopyBuilder for more details.
fromPath - Path in the user's Dropbox to be copied or moved. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.toPath - Path in the user's Dropbox that is the destination. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.RelocationErrorExceptionDbxException@Deprecated public CopyBuilder copyBuilder(java.lang.String fromPath, java.lang.String toPath)
copyV2(String,String)
instead.fromPath - Path in the user's Dropbox to be copied or moved. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.toPath - Path in the user's Dropbox that is the destination. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public RelocationBatchLaunch copyBatch(java.util.List<RelocationPath> entries) throws DbxApiException, DbxException
RelocationBatchArg.getAllowSharedFolder() is
false, this route is atomic. If on entry failes, the whole transaction
will abort. If RelocationBatchArg.getAllowSharedFolder() is true,
not atomicity is guaranteed, but you will be able to copy the contents of
shared folders to new locations. This route will return job ID
immediately and do the async copy job in background. Please use copyBatchCheck(String) to check the job status.
The default values for the optional request parameters will be used.
See CopyBatchBuilder for more details.
entries - List of entries to be moved or copied. Each entry is
RelocationPath. Must contain at least 1 items, not contain a
null item, and not be null.copyBatch(List)
or moveBatch(List) that may either
launch an asynchronous job or complete synchronously.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DbxApiExceptionDbxExceptionpublic CopyBatchBuilder copyBatchBuilder(java.util.List<RelocationPath> entries)
RelocationBatchArg.getAllowSharedFolder() is
false, this route is atomic. If on entry failes, the whole transaction
will abort. If RelocationBatchArg.getAllowSharedFolder() is true,
not atomicity is guaranteed, but you will be able to copy the contents of
shared folders to new locations. This route will return job ID
immediately and do the async copy job in background. Please use copyBatchCheck(String) to check the job status.entries - List of entries to be moved or copied. Each entry is
RelocationPath. Must contain at least 1 items, not contain a
null item, and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public RelocationBatchJobStatus copyBatchCheck(java.lang.String asyncJobId) throws PollErrorException, DbxException
copyBatch(List). If success, it returns list of
results for each entry.asyncJobId - Id of the asynchronous job. This is the value of a
response returned from the method that launched the job. Must have
length of at least 1 and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.PollErrorExceptionDbxExceptionpublic GetCopyReferenceResult copyReferenceGet(java.lang.String path) throws GetCopyReferenceErrorException, DbxException
copyReferenceSave(String,String).path - The path to the file or folder you want to get a copy
reference to. Must match pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not
be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.GetCopyReferenceErrorExceptionDbxExceptionpublic SaveCopyReferenceResult copyReferenceSave(java.lang.String copyReference, java.lang.String path) throws SaveCopyReferenceErrorException, DbxException
copyReferenceGet(String) to the user's Dropbox.copyReference - A copy reference returned by copyReferenceGet(String). Must not be null.path - Path in the user's Dropbox that is the destination. Must
match pattern "/(.|[\\r\\n])*" and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.SaveCopyReferenceErrorExceptionDbxExceptionpublic RelocationResult copyV2(java.lang.String fromPath, java.lang.String toPath) throws RelocationErrorException, DbxException
The default values for the optional request parameters will be used.
See CopyV2Builder for more details.
fromPath - Path in the user's Dropbox to be copied or moved. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.toPath - Path in the user's Dropbox that is the destination. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.RelocationErrorExceptionDbxExceptionpublic CopyV2Builder copyV2Builder(java.lang.String fromPath, java.lang.String toPath)
fromPath - Path in the user's Dropbox to be copied or moved. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.toPath - Path in the user's Dropbox that is the destination. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.@Deprecated public FolderMetadata createFolder(java.lang.String path) throws CreateFolderErrorException, DbxException
createFolderV2(String,boolean) instead. The autorename request parameter will default to false (see createFolder(String,boolean)).
path - Path in the user's Dropbox to create. Must match pattern
"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)" and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.CreateFolderErrorExceptionDbxException@Deprecated public FolderMetadata createFolder(java.lang.String path, boolean autorename) throws CreateFolderErrorException, DbxException
createFolderV2(String,boolean) instead.path - Path in the user's Dropbox to create. Must match pattern
"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)" and not be null.autorename - If there's a conflict, have the Dropbox server try to
autorename the folder to avoid the conflict.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.CreateFolderErrorExceptionDbxExceptionpublic CreateFolderBatchLaunch createFolderBatch(java.util.List<java.lang.String> paths) throws DbxApiException, DbxException
CreateFolderBatchArg.getForceAsync() flag.
Use createFolderBatchCheck(String) to check
the job status.
The default values for the optional request parameters will be used.
See CreateFolderBatchBuilder for more details.
paths - List of paths to be created in the user's Dropbox.
Duplicate path arguments in the batch are considered only once. Must
not contain a null item and not be null.createFolderBatch(List) that may either launch
an asynchronous job or complete synchronously.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DbxApiExceptionDbxExceptionpublic CreateFolderBatchBuilder createFolderBatchBuilder(java.util.List<java.lang.String> paths)
CreateFolderBatchArg.getForceAsync() flag.
Use createFolderBatchCheck(String) to check
the job status.paths - List of paths to be created in the user's Dropbox.
Duplicate path arguments in the batch are considered only once. Must
not contain a null item and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public CreateFolderBatchJobStatus createFolderBatchCheck(java.lang.String asyncJobId) throws PollErrorException, DbxException
createFolderBatch(List). If success, it returns
list of result for each entry.asyncJobId - Id of the asynchronous job. This is the value of a
response returned from the method that launched the job. Must have
length of at least 1 and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.PollErrorExceptionDbxExceptionpublic CreateFolderResult createFolderV2(java.lang.String path) throws CreateFolderErrorException, DbxException
The autorename request parameter will default to false (see createFolderV2(String,boolean)).
path - Path in the user's Dropbox to create. Must match pattern
"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)" and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.CreateFolderErrorExceptionDbxExceptionpublic CreateFolderResult createFolderV2(java.lang.String path, boolean autorename) throws CreateFolderErrorException, DbxException
path - Path in the user's Dropbox to create. Must match pattern
"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)" and not be null.autorename - If there's a conflict, have the Dropbox server try to
autorename the folder to avoid the conflict.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.CreateFolderErrorExceptionDbxException@Deprecated public Metadata delete(java.lang.String path) throws DeleteErrorException, DbxException
deleteV2(String,String)
instead.FileMetadata or FolderMetadata for the item
at time of deletion, and not a DeletedMetadata object.path - Path in the user's Dropbox to delete. Must match pattern
"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)" and not be
null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DeleteErrorExceptionDbxException@Deprecated public Metadata delete(java.lang.String path, java.lang.String parentRev) throws DeleteErrorException, DbxException
deleteV2(String,String)
instead.FileMetadata or FolderMetadata for the item
at time of deletion, and not a DeletedMetadata object.path - Path in the user's Dropbox to delete. Must match pattern
"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)" and not be
null.parentRev - Perform delete if given "rev" matches the existing
file's latest "rev". This field does not support deleting a folder.
Must have length of at least 9 and match pattern "[0-9a-f]+".java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DeleteErrorExceptionDbxExceptionpublic DeleteBatchLaunch deleteBatch(java.util.List<DeleteArg> entries) throws DbxApiException, DbxException
deleteBatchCheck(String) to check the
job status.entries - Must not contain a null item and not be null.deleteBatch(List)
that may either launch an asynchronous job or complete synchronously.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DbxApiExceptionDbxExceptionpublic DeleteBatchJobStatus deleteBatchCheck(java.lang.String asyncJobId) throws PollErrorException, DbxException
deleteBatch(List). If success, it returns list of
result for each entry.asyncJobId - Id of the asynchronous job. This is the value of a
response returned from the method that launched the job. Must have
length of at least 1 and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.PollErrorExceptionDbxExceptionpublic DeleteResult deleteV2(java.lang.String path) throws DeleteErrorException, DbxException
FileMetadata or FolderMetadata for the item
at time of deletion, and not a DeletedMetadata object.path - Path in the user's Dropbox to delete. Must match pattern
"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)" and not be
null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DeleteErrorExceptionDbxExceptionpublic DeleteResult deleteV2(java.lang.String path, java.lang.String parentRev) throws DeleteErrorException, DbxException
FileMetadata or FolderMetadata for the item
at time of deletion, and not a DeletedMetadata object.path - Path in the user's Dropbox to delete. Must match pattern
"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)" and not be
null.parentRev - Perform delete if given "rev" matches the existing
file's latest "rev". This field does not support deleting a folder.
Must have length of at least 9 and match pattern "[0-9a-f]+".java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DeleteErrorExceptionDbxExceptionpublic DbxDownloader<FileMetadata> download(java.lang.String path) throws DownloadErrorException, DbxException
path - The path of the file to download. Must match pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not
be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DownloadErrorExceptionDbxExceptionpublic DbxDownloader<FileMetadata> download(java.lang.String path, java.lang.String rev) throws DownloadErrorException, DbxException
path - The path of the file to download. Must match pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not
be null.rev - Please specify revision in the path argument to
download(String,String) instead. Must
have length of at least 9 and match pattern "[0-9a-f]+".java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DownloadErrorExceptionDbxExceptionpublic DownloadBuilder downloadBuilder(java.lang.String path)
path - The path of the file to download. Must match pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not
be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public DbxDownloader<DownloadZipResult> downloadZip(java.lang.String path) throws DownloadZipErrorException, DbxException
path - The path of the folder to download. Must match pattern
"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DownloadZipErrorExceptionDbxExceptionpublic DownloadZipBuilder downloadZipBuilder(java.lang.String path)
path - The path of the folder to download. Must match pattern
"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public Metadata getMetadata(java.lang.String path) throws GetMetadataErrorException, DbxException
The default values for the optional request parameters will be used.
See GetMetadataBuilder for more details.
path - The path of a file or folder on Dropbox. Must match pattern
"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.GetMetadataErrorExceptionDbxExceptionpublic GetMetadataBuilder getMetadataBuilder(java.lang.String path)
path - The path of a file or folder on Dropbox. Must match pattern
"(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public DbxDownloader<FileMetadata> getPreview(java.lang.String path) throws PreviewErrorException, DbxException
path - The path of the file to preview. Must match pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not
be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.PreviewErrorExceptionDbxExceptionpublic DbxDownloader<FileMetadata> getPreview(java.lang.String path, java.lang.String rev) throws PreviewErrorException, DbxException
path - The path of the file to preview. Must match pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not
be null.rev - Please specify revision in the path argument to
getPreview(String,String) instead. Must
have length of at least 9 and match pattern "[0-9a-f]+".java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.PreviewErrorExceptionDbxExceptionpublic GetPreviewBuilder getPreviewBuilder(java.lang.String path)
path - The path of the file to preview. Must match pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not
be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public GetTemporaryLinkResult getTemporaryLink(java.lang.String path) throws GetTemporaryLinkErrorException, DbxException
path - The path to the file you want a temporary link to. Must
match pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not
be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.GetTemporaryLinkErrorExceptionDbxExceptionpublic DbxDownloader<FileMetadata> getThumbnail(java.lang.String path) throws ThumbnailErrorException, DbxException
The default values for the optional request parameters will be used.
See GetThumbnailBuilder for more details.
path - The path to the image file you want to thumbnail. Must match
pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not
be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.ThumbnailErrorExceptionDbxExceptionpublic GetThumbnailBuilder getThumbnailBuilder(java.lang.String path)
path - The path to the image file you want to thumbnail. Must match
pattern "(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?)" and not
be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public GetThumbnailBatchResult getThumbnailBatch(java.util.List<ThumbnailArg> entries) throws GetThumbnailBatchErrorException, DbxException
entries - List of files to get thumbnails. Must not contain a
null item and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.GetThumbnailBatchErrorExceptionDbxExceptionpublic ListFolderResult listFolder(java.lang.String path) throws ListFolderErrorException, DbxException
ListFolderResult.getHasMore() field is true, call listFolderContinue(String) with the returned ListFolderResult.getCursor() to retrieve more entries. If you're using
ListFolderArg.getRecursive() set to true to keep a local
cache of the contents of a Dropbox account, iterate through each entry in
order and process them as follows to keep your local state in sync: For
each FileMetadata, store the new entry at the given path in your
local state. If the required parent folders don't exist yet, create them.
If there's already something else at the given path, replace it and
remove all its children. For each FolderMetadata, store the new
entry at the given path in your local state. If the required parent
folders don't exist yet, create them. If there's already something else
at the given path, replace it but leave the children as they are. Check
the new entry's FolderSharingInfo.getReadOnly() and set all its
children's read-only statuses to match. For each DeletedMetadata,
if your local state has something at the given path, remove it and all
its children. If there's nothing at the given path, ignore this entry.
Note: RateLimitError may be returned if
multiple listFolder(String) or listFolderContinue(String) calls with same
parameters are made simultaneously by same API app for same user. If your
app implements retry logic, please hold off the retry until the previous
request finishes.
The default values for the optional request parameters will be used.
See ListFolderBuilder for more details.
path - A unique identifier for the file. Must match pattern "(/(.|[\\r\\n])*)?|id:.*|(ns:[0-9]+(/.*)?)" and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.ListFolderErrorExceptionDbxExceptionpublic ListFolderBuilder listFolderBuilder(java.lang.String path)
ListFolderResult.getHasMore() field is true, call listFolderContinue(String) with the returned ListFolderResult.getCursor() to retrieve more entries. If you're using
ListFolderArg.getRecursive() set to true to keep a local
cache of the contents of a Dropbox account, iterate through each entry in
order and process them as follows to keep your local state in sync: For
each FileMetadata, store the new entry at the given path in your
local state. If the required parent folders don't exist yet, create them.
If there's already something else at the given path, replace it and
remove all its children. For each FolderMetadata, store the new
entry at the given path in your local state. If the required parent
folders don't exist yet, create them. If there's already something else
at the given path, replace it but leave the children as they are. Check
the new entry's FolderSharingInfo.getReadOnly() and set all its
children's read-only statuses to match. For each DeletedMetadata,
if your local state has something at the given path, remove it and all
its children. If there's nothing at the given path, ignore this entry.
Note: RateLimitError may be returned if
multiple listFolder(String) or listFolderContinue(String) calls with same
parameters are made simultaneously by same API app for same user. If your
app implements retry logic, please hold off the retry until the previous
request finishes.path - A unique identifier for the file. Must match pattern "(/(.|[\\r\\n])*)?|id:.*|(ns:[0-9]+(/.*)?)" and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public ListFolderResult listFolderContinue(java.lang.String cursor) throws ListFolderContinueErrorException, DbxException
listFolder(String), use this to paginate through
all files and retrieve updates to the folder, following the same rules as
documented for listFolder(String).cursor - The cursor returned by your last call to listFolder(String) or listFolderContinue(String). Must have length of
at least 1 and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.ListFolderContinueErrorExceptionDbxExceptionpublic ListFolderGetLatestCursorResult listFolderGetLatestCursor(java.lang.String path) throws ListFolderErrorException, DbxException
listFolder(String), listFolderGetLatestCursor(String) doesn't return
any entries. This endpoint is for app which only needs to know about new
files and modifications and doesn't need to know about files that already
exist in Dropbox.
The default values for the optional request parameters will be used.
See ListFolderGetLatestCursorBuilder for more details.
path - A unique identifier for the file. Must match pattern "(/(.|[\\r\\n])*)?|id:.*|(ns:[0-9]+(/.*)?)" and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.ListFolderErrorExceptionDbxExceptionpublic ListFolderGetLatestCursorBuilder listFolderGetLatestCursorBuilder(java.lang.String path)
listFolder(String), listFolderGetLatestCursor(String) doesn't return
any entries. This endpoint is for app which only needs to know about new
files and modifications and doesn't need to know about files that already
exist in Dropbox.path - A unique identifier for the file. Must match pattern "(/(.|[\\r\\n])*)?|id:.*|(ns:[0-9]+(/.*)?)" and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public ListFolderLongpollResult listFolderLongpoll(java.lang.String cursor) throws ListFolderLongpollErrorException, DbxException
listFolderContinue(String), this call
gives you a low-latency way to monitor an account for file changes. The
connection will block until there are changes available or a timeout
occurs. This endpoint is useful mostly for client-side apps. If you're
looking for server-side notifications, check out our webhooks
documentation.
The timeout request parameter will default to 30L
(see listFolderLongpoll(String,long)).
cursor - A cursor as returned by listFolder(String) or listFolderContinue(String). Cursors retrieved
by setting ListFolderArg.getIncludeMediaInfo() to true
are not supported. Must have length of at least 1 and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.ListFolderLongpollErrorExceptionDbxExceptionpublic ListFolderLongpollResult listFolderLongpoll(java.lang.String cursor, long timeout) throws ListFolderLongpollErrorException, DbxException
listFolderContinue(String), this call
gives you a low-latency way to monitor an account for file changes. The
connection will block until there are changes available or a timeout
occurs. This endpoint is useful mostly for client-side apps. If you're
looking for server-side notifications, check out our webhooks
documentation.cursor - A cursor as returned by listFolder(String) or listFolderContinue(String). Cursors retrieved
by setting ListFolderArg.getIncludeMediaInfo() to true
are not supported. Must have length of at least 1 and not be null.timeout - A timeout in seconds. The request will block for at most
this length of time, plus up to 90 seconds of random jitter added to
avoid the thundering herd problem. Care should be taken when using
this parameter, as some network infrastructure does not support long
timeouts. Must be greater than or equal to 30 and be less than or
equal to 480.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.ListFolderLongpollErrorExceptionDbxExceptionpublic ListRevisionsResult listRevisions(java.lang.String path) throws ListRevisionsErrorException, DbxException
ListRevisionsMode.PATH (default) mode, all revisions at the same
file path as the latest file entry are returned. If revisions with the
same file id are desired, then mode must be set to ListRevisionsMode.ID. The ListRevisionsMode.ID mode is useful to
retrieve revisions for a given file across moves or renames.
The default values for the optional request parameters will be used.
See ListRevisionsBuilder for more details.
path - The path to the file you want to see the revisions of. Must
match pattern "/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)" and
not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.ListRevisionsErrorExceptionDbxExceptionpublic ListRevisionsBuilder listRevisionsBuilder(java.lang.String path)
ListRevisionsMode.PATH (default) mode, all revisions at the same
file path as the latest file entry are returned. If revisions with the
same file id are desired, then mode must be set to ListRevisionsMode.ID. The ListRevisionsMode.ID mode is useful to
retrieve revisions for a given file across moves or renames.path - The path to the file you want to see the revisions of. Must
match pattern "/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)" and
not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.@Deprecated public Metadata move(java.lang.String fromPath, java.lang.String toPath) throws RelocationErrorException, DbxException
moveV2(String,String)
instead. The default values for the optional request parameters will be used.
See MoveBuilder for more details.
fromPath - Path in the user's Dropbox to be copied or moved. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.toPath - Path in the user's Dropbox that is the destination. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.RelocationErrorExceptionDbxException@Deprecated public MoveBuilder moveBuilder(java.lang.String fromPath, java.lang.String toPath)
moveV2(String,String)
instead.fromPath - Path in the user's Dropbox to be copied or moved. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.toPath - Path in the user's Dropbox that is the destination. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public RelocationBatchLaunch moveBatch(java.util.List<RelocationPath> entries) throws DbxApiException, DbxException
moveBatchCheck(String) to check the job status.
The default values for the optional request parameters will be used.
See MoveBatchBuilder for more details.
entries - List of entries to be moved or copied. Each entry is
RelocationPath. Must contain at least 1 items, not contain a
null item, and not be null.copyBatch(List)
or moveBatch(List) that may either
launch an asynchronous job or complete synchronously.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DbxApiExceptionDbxExceptionpublic MoveBatchBuilder moveBatchBuilder(java.util.List<RelocationPath> entries)
moveBatchCheck(String) to check the job status.entries - List of entries to be moved or copied. Each entry is
RelocationPath. Must contain at least 1 items, not contain a
null item, and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public RelocationBatchJobStatus moveBatchCheck(java.lang.String asyncJobId) throws PollErrorException, DbxException
moveBatch(List). If success, it returns list of
results for each entry.asyncJobId - Id of the asynchronous job. This is the value of a
response returned from the method that launched the job. Must have
length of at least 1 and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.PollErrorExceptionDbxExceptionpublic RelocationResult moveV2(java.lang.String fromPath, java.lang.String toPath) throws RelocationErrorException, DbxException
The default values for the optional request parameters will be used.
See MoveV2Builder for more details.
fromPath - Path in the user's Dropbox to be copied or moved. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.toPath - Path in the user's Dropbox that is the destination. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.RelocationErrorExceptionDbxExceptionpublic MoveV2Builder moveV2Builder(java.lang.String fromPath, java.lang.String toPath)
fromPath - Path in the user's Dropbox to be copied or moved. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.toPath - Path in the user's Dropbox that is the destination. Must
match pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)"
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public void permanentlyDelete(java.lang.String path)
throws DeleteErrorException,
DbxException
path - Path in the user's Dropbox to delete. Must match pattern
"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)" and not be
null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DeleteErrorExceptionDbxExceptionpublic void permanentlyDelete(java.lang.String path,
java.lang.String parentRev)
throws DeleteErrorException,
DbxException
path - Path in the user's Dropbox to delete. Must match pattern
"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)" and not be
null.parentRev - Perform delete if given "rev" matches the existing
file's latest "rev". This field does not support deleting a folder.
Must have length of at least 9 and match pattern "[0-9a-f]+".java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DeleteErrorExceptionDbxException@Deprecated
public void propertiesAdd(java.lang.String path,
java.util.List<PropertyGroup> propertyGroups)
throws AddPropertiesErrorException,
DbxException
path - A unique identifier for the file or folder. Must match
pattern "/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)" and not be
null.propertyGroups - The property groups which are to be added to a
Dropbox file. Must not contain a null item and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.AddPropertiesErrorExceptionDbxException@Deprecated
public void propertiesOverwrite(java.lang.String path,
java.util.List<PropertyGroup> propertyGroups)
throws InvalidPropertyGroupErrorException,
DbxException
path - A unique identifier for the file or folder. Must match
pattern "/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)" and not be
null.propertyGroups - The property groups "snapshot" updates to force
apply. Must contain at least 1 items, not contain a null
item, and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.InvalidPropertyGroupErrorExceptionDbxException@Deprecated
public void propertiesRemove(java.lang.String path,
java.util.List<java.lang.String> propertyTemplateIds)
throws RemovePropertiesErrorException,
DbxException
path - A unique identifier for the file or folder. Must match
pattern "/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)" and not be
null.propertyTemplateIds - A list of identifiers for a template created
by DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List)
or templatesAddForTeam. Must not contain a null item
and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.RemovePropertiesErrorExceptionDbxException@Deprecated public GetTemplateResult propertiesTemplateGet(java.lang.String templateId) throws TemplateErrorException, DbxException
templateId - An identifier for template added by route See DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List)
or templatesAddForTeam. Must have length of at least 1, match
pattern "(/|ptid:).*", and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.TemplateErrorExceptionDbxException@Deprecated public ListTemplateResult propertiesTemplateList() throws TemplateErrorException, DbxException
TemplateErrorExceptionDbxException@Deprecated
public void propertiesUpdate(java.lang.String path,
java.util.List<PropertyGroupUpdate> updatePropertyGroups)
throws UpdatePropertiesErrorException,
DbxException
path - A unique identifier for the file or folder. Must match
pattern "/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)" and not be
null.updatePropertyGroups - The property groups "delta" updates to
apply. Must not contain a null item and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.UpdatePropertiesErrorExceptionDbxExceptionpublic FileMetadata restore(java.lang.String path, java.lang.String rev) throws RestoreErrorException, DbxException
path - The path to the file you want to restore. Must match pattern
"(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)" and not be null.rev - The revision to restore for the file. Must have length of at
least 9, match pattern "[0-9a-f]+", and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.RestoreErrorExceptionDbxExceptionpublic SaveUrlResult saveUrl(java.lang.String path, java.lang.String url) throws SaveUrlErrorException, DbxException
path - The path in Dropbox where the URL will be saved to. Must
match pattern "/(.|[\\r\\n])*" and not be null.url - The URL to be saved. Must not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.SaveUrlErrorExceptionDbxExceptionpublic SaveUrlJobStatus saveUrlCheckJobStatus(java.lang.String asyncJobId) throws PollErrorException, DbxException
saveUrl(String,String)
job.asyncJobId - Id of the asynchronous job. This is the value of a
response returned from the method that launched the job. Must have
length of at least 1 and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.PollErrorExceptionDbxExceptionpublic SearchResult search(java.lang.String path, java.lang.String query) throws SearchErrorException, DbxException
The default values for the optional request parameters will be used.
See SearchBuilder for more details.
path - The path in the user's Dropbox to search. Should probably be
a folder. Must match pattern "(/(.|[\\r\\n])*)?|id:.*|(ns:[0-9]+(/.*)?)" and not be null.query - The string to search for. The search string is split on
spaces into multiple tokens. For file name searching, the last token
is used for prefix matching (i.e. "bat c" matches "bat cave" but not
"batman car"). Must not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.SearchErrorExceptionDbxExceptionpublic SearchBuilder searchBuilder(java.lang.String path, java.lang.String query)
path - The path in the user's Dropbox to search. Should probably be
a folder. Must match pattern "(/(.|[\\r\\n])*)?|id:.*|(ns:[0-9]+(/.*)?)" and not be null.query - The string to search for. The search string is split on
spaces into multiple tokens. For file name searching, the last token
is used for prefix matching (i.e. "bat c" matches "bat cave" but not
"batman car"). Must not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.public UploadUploader upload(java.lang.String path) throws DbxException
uploadSessionStart(boolean).
The default values for the optional request parameters will be used.
See UploadBuilder for more details.
path - Path in the user's Dropbox to save the file. Must match
pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)" and not
be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DbxExceptionpublic UploadBuilder uploadBuilder(java.lang.String path)
uploadSessionStart(boolean).path - Path in the user's Dropbox to save the file. Must match
pattern "(/(.|[\\r\\n])*)|(ns:[0-9]+(/.*)?)|(id:.*)" and not
be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.@Deprecated public UploadSessionAppendUploader uploadSessionAppend(java.lang.String sessionId, long offset) throws DbxException
uploadSessionAppendV2(UploadSessionCursor,boolean)
instead.sessionId - The upload session ID (returned by uploadSessionStart(boolean)). Must not be
null.offset - The amount of data that has been uploaded so far. We use
this to make sure upload data isn't lost or duplicated in the event
of a network error.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DbxExceptionpublic UploadSessionAppendV2Uploader uploadSessionAppendV2(UploadSessionCursor cursor) throws DbxException
The close request parameter will default to false
(see uploadSessionAppendV2(UploadSessionCursor,boolean)).
cursor - Contains the upload session ID and the offset. Must not be
null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DbxExceptionpublic UploadSessionAppendV2Uploader uploadSessionAppendV2(UploadSessionCursor cursor, boolean close) throws DbxException
cursor - Contains the upload session ID and the offset. Must not be
null.close - If true, the current session will be closed, at which point
you won't be able to call uploadSessionAppendV2(UploadSessionCursor,boolean)
anymore with the current session.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DbxExceptionpublic UploadSessionFinishUploader uploadSessionFinish(UploadSessionCursor cursor, CommitInfo commit) throws DbxException
cursor - Contains the upload session ID and the offset. Must not be
null.commit - Contains the path and other optional modifiers for the
commit. Must not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DbxExceptionpublic UploadSessionFinishBatchLaunch uploadSessionFinishBatch(java.util.List<UploadSessionFinishArg> entries) throws DbxApiException, DbxException
uploadSessionStart(boolean) and uploadSessionAppendV2(UploadSessionCursor,boolean)
to upload file contents. We recommend uploading many files in parallel to
increase throughput. Once the file contents have been uploaded, rather
than calling uploadSessionFinish(UploadSessionCursor,CommitInfo),
use this route to finish all your upload sessions in a single request.
the close argument to uploadSessionStart(boolean) or the close
argument to uploadSessionAppendV2(UploadSessionCursor,boolean)
needs to be true for the last uploadSessionStart(boolean) or uploadSessionAppendV2(UploadSessionCursor,boolean)
call. The maximum size of a file one can upload to an upload session is
350 GB. This route will return a job_id immediately and do the async
commit job in background. Use uploadSessionFinishBatchCheck(String) to check the
job status. For the same account, this route should be executed serially.
That means you should not start the next job before current job finishes.
We allow up to 1000 entries in a single request.entries - Commit information for each file in the batch. Must
contain at most 1000 items, not contain a null item, and not
be null.uploadSessionFinishBatch(List) that may either
launch an asynchronous job or complete synchronously.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.DbxApiExceptionDbxExceptionpublic UploadSessionFinishBatchJobStatus uploadSessionFinishBatchCheck(java.lang.String asyncJobId) throws PollErrorException, DbxException
uploadSessionFinishBatch(List). If success, it
returns list of result for each entry.asyncJobId - Id of the asynchronous job. This is the value of a
response returned from the method that launched the job. Must have
length of at least 1 and not be null.java.lang.IllegalArgumentException - If any argument does not meet its
preconditions.PollErrorExceptionDbxExceptionpublic UploadSessionStartUploader uploadSessionStart() throws DbxException
uploadSessionAppendV2(UploadSessionCursor,boolean)
to add more data and uploadSessionFinish(UploadSessionCursor,CommitInfo)
to save all the data to a file in Dropbox. A single request should not
upload more than 150 MB. The maximum size of a file one can upload to an
upload session is 350 GB. An upload session can be used for a maximum of
48 hours. Attempting to use an UploadSessionStartResult.getSessionId() with uploadSessionAppendV2(UploadSessionCursor,boolean)
or uploadSessionFinish(UploadSessionCursor,CommitInfo)
more than 48 hours after its creation will return a UploadSessionLookupError.NOT_FOUND.
The close request parameter will default to false
(see uploadSessionStart(boolean)).
DbxExceptionpublic UploadSessionStartUploader uploadSessionStart(boolean close) throws DbxException
uploadSessionAppendV2(UploadSessionCursor,boolean)
to add more data and uploadSessionFinish(UploadSessionCursor,CommitInfo)
to save all the data to a file in Dropbox. A single request should not
upload more than 150 MB. The maximum size of a file one can upload to an
upload session is 350 GB. An upload session can be used for a maximum of
48 hours. Attempting to use an UploadSessionStartResult.getSessionId() with uploadSessionAppendV2(UploadSessionCursor,boolean)
or uploadSessionFinish(UploadSessionCursor,CommitInfo)
more than 48 hours after its creation will return a UploadSessionLookupError.NOT_FOUND.close - If true, the current session will be closed, at which point
you won't be able to call uploadSessionAppendV2(UploadSessionCursor,boolean)
anymore with the current session.DbxException