[−][src]Module dropbox_sdk::files
This namespace contains endpoints and data types for basic file operations.
Structs
Enums
Functions
alpha_get_metadata | Returns the metadata for a file or folder. This is an alpha endpoint compatible with the properties API. Note: Metadata for the root folder is unsupported. |
alpha_upload | Create a new file with the contents provided in the request. Note that this endpoint is part of
the properties API alpha and is slightly different from |
copy | Copy a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be copied. |
copy_batch | Copy multiple files or folders to different locations at once in the user's Dropbox. If
|
copy_batch_check | Returns the status of an asynchronous job for |
copy_batch_check_v2 | Returns the status of an asynchronous job for |
copy_batch_v2 | Copy multiple files or folders to different locations at once in the user's Dropbox. This route
will replace |
copy_reference_get | Get a copy reference to a file or folder. This reference string can be used to save that file or
folder to another user's Dropbox by passing it to
|
copy_reference_save | Save a copy reference returned by |
copy_v2 | Copy a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be copied. |
create_folder | Create a folder at a given path. |
create_folder_batch | Create multiple folders at once. This route is asynchronous for large batches, which returns a
job ID immediately and runs the create folder batch asynchronously. Otherwise, creates the
folders and returns the result synchronously for smaller inputs. You can force asynchronous
behaviour by using the |
create_folder_batch_check | Returns the status of an asynchronous job for |
create_folder_v2 | Create a folder at a given path. |
delete | Delete the file or folder at a given path. If the path is a folder, all its contents will be
deleted too. A successful response indicates that the file or folder was deleted. The returned
metadata will be the corresponding |
delete_batch | Delete multiple files/folders at once. This route is asynchronous, which returns a job ID
immediately and runs the delete batch asynchronously. Use
|
delete_batch_check | Returns the status of an asynchronous job for |
delete_v2 | Delete the file or folder at a given path. If the path is a folder, all its contents will be
deleted too. A successful response indicates that the file or folder was deleted. The returned
metadata will be the corresponding |
do_move | Move a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be moved. |
download | Download a file from a user's Dropbox. |
download_zip | Download a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and have fewer than 10,000 total files. The input cannot be a single file. Any single file must be less than 4GB in size. |
export | Export a file from a user's Dropbox. This route only supports exporting files that cannot be
downloaded directly and whose |
get_metadata | Returns the metadata for a file or folder. Note: Metadata for the root folder is unsupported. |
get_preview | Get a preview for a file. Currently, PDF previews are generated for files with the following extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf. HTML previews are generated for files with the following extensions: .csv, .ods, .xls, .xlsm, .gsheet, .xlsx. Other formats will return an unsupported extension error. |
get_temporary_link | Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. This URL should not be used to display content directly in the browser. The Content-Type of the link is determined automatically by the file's mime type. |
get_temporary_upload_link | Get a one-time use temporary upload link to upload a file to a Dropbox location. |
get_thumbnail | Get a thumbnail for an image. This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail. |
get_thumbnail_batch | Get thumbnails for a list of images. We allow up to 25 thumbnails in a single batch. This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail. |
list_folder | Starts returning the contents of a folder. If the result's
|
list_folder_continue | Once a cursor has been retrieved from |
list_folder_get_latest_cursor | A way to quickly get a cursor for the folder's state. Unlike |
list_folder_longpoll | A longpoll endpoint to wait for changes on an account. In conjunction with
|
list_revisions | Returns revisions for files based on a file path or a file id. The file path or file id is
identified from the latest file entry at the given file path or id. This end point allows your
app to query either by file path or file id by setting the mode parameter appropriately. In the
|
move_batch | Move multiple files or folders to different locations at once in the user's Dropbox. This route
is 'all or nothing', which means if one entry fails, the whole transaction will abort. This
route will return job ID immediately and do the async moving job in background. Please use
|
move_batch_check | Returns the status of an asynchronous job for |
move_batch_check_v2 | Returns the status of an asynchronous job for |
move_batch_v2 | Move multiple files or folders to different locations at once in the user's Dropbox. This route
will replace |
move_v2 | Move a file or folder to a different location in the user's Dropbox. If the source path is a folder all its contents will be moved. |
permanently_delete | Permanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40). Note: This endpoint is only available for Dropbox Business apps. |
properties_add | |
properties_overwrite | |
properties_remove | |
properties_template_get | |
properties_template_list | |
properties_update | |
restore | Restore a specific revision of a file to the given path. |
save_url | Save the data from a specified URL into a file in user's Dropbox. Note that the transfer from the URL must complete within 5 minutes, or the operation will time out and the job will fail. If the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt). |
save_url_check_job_status | Check the status of a |
search | Searches for files and folders. Note: Recent changes may not immediately be reflected in search results due to a short delay in indexing. |
upload | Create a new file with the contents provided in the request. Do not use this to upload a file
larger than 150 MB. Instead, create an upload session with
|
upload_session_append | Append more data to an upload session. 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. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page. |
upload_session_append_v2 | Append more data to an upload session. When the parameter close is set, this call will close the session. 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. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page. |
upload_session_finish | Finish an upload session and save the uploaded data to the given file path. 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. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page. |
upload_session_finish_batch | This route helps you commit many files at once into a user's Dropbox. Use
|
upload_session_finish_batch_check | Returns the status of an asynchronous job for
|
upload_session_start | 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. This call starts a new upload session with the given
data. You can then use |
Type Definitions
CopyBatchArg | |
FileId | |
Id | |
ListFolderCursor | |
MalformedPathError | |
Path | |
PathOrId | |
PathR | |
PathROrId | |
ReadPath | |
Rev | |
Sha256HexHash | |
SharedLinkUrl | |
WritePath | |
WritePathOrId |