code
stringlengths 10
343k
| docstring
stringlengths 36
21.9k
| func_name
stringlengths 1
3.35k
| language
stringclasses 1
value | repo
stringlengths 7
58
| path
stringlengths 4
131
| url
stringlengths 44
195
| license
stringclasses 5
values |
|---|---|---|---|---|---|---|---|
routes.filesAlphaGetMetadata = function (arg) {
return this.request('files/alpha/get_metadata', arg, 'user', 'api', 'rpc', 'files.metadata.read');
}; | 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.
Route attributes:
scope: files.metadata.read
@function Dropbox#filesAlphaGetMetadata
@deprecated
@arg {FilesAlphaGetMetadataArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<(FilesFileMetadata|FilesFolderMetadata|FilesDeletedMetadata)>, DropboxResponseError.<FilesAlphaGetMetadataError>>} | routes.filesAlphaGetMetadata ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesAlphaUpload = function (arg) {
return this.request('files/alpha/upload', arg, 'user', 'content', 'upload', 'files.content.write');
}; | Create a new file with the contents provided in the request. Note that the
behavior of this alpha endpoint is unstable and subject to change. Do not use
this to upload a file larger than 150 MB. Instead, create an upload session
with upload_session/start.
Route attributes:
scope: files.content.write
@function Dropbox#filesAlphaUpload
@deprecated
@arg {FilesUploadArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesFileMetadata>, DropboxResponseError.<FilesUploadError>>} | routes.filesAlphaUpload ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesCopyV2 = function (arg) {
return this.request('files/copy_v2', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | 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.
Route attributes:
scope: files.content.write
@function Dropbox#filesCopyV2
@arg {FilesRelocationArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesRelocationResult>, DropboxResponseError.<FilesRelocationError>>} | routes.filesCopyV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesCopy = function (arg) {
return this.request('files/copy', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | 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.
Route attributes:
scope: files.content.write
@function Dropbox#filesCopy
@deprecated
@arg {FilesRelocationArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<(FilesFileMetadata|FilesFolderMetadata|FilesDeletedMetadata)>, DropboxResponseError.<FilesRelocationError>>} | routes.filesCopy ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesCopyBatchV2 = function (arg) {
return this.request('files/copy_batch_v2', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Copy multiple files or folders to different locations at once in the user's
Dropbox. This route will replace copy_batch. The main difference is this
route will return status for each entry, while copy_batch raises failure if
any entry fails. This route will either finish synchronously, or return a job
ID and do the async copy job in background. Please use copy_batch/check_v2 to
check the job status.
Route attributes:
scope: files.content.write
@function Dropbox#filesCopyBatchV2
@arg {Object} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesRelocationBatchV2Launch>, DropboxResponseError.<void>>} | routes.filesCopyBatchV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesCopyBatch = function (arg) {
return this.request('files/copy_batch', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Copy multiple files or folders to different locations at once in the user's
Dropbox. This route will return job ID immediately and do the async copy job
in background. Please use copy_batch/check to check the job status.
Route attributes:
scope: files.content.write
@function Dropbox#filesCopyBatch
@deprecated
@arg {FilesRelocationBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesRelocationBatchLaunch>, DropboxResponseError.<void>>} | routes.filesCopyBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesCopyBatchCheckV2 = function (arg) {
return this.request('files/copy_batch/check_v2', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Returns the status of an asynchronous job for copy_batch_v2. It returns list
of results for each entry.
Route attributes:
scope: files.content.write
@function Dropbox#filesCopyBatchCheckV2
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesRelocationBatchV2JobStatus>, DropboxResponseError.<AsyncPollError>>} | routes.filesCopyBatchCheckV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesCopyBatchCheck = function (arg) {
return this.request('files/copy_batch/check', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Returns the status of an asynchronous job for copy_batch. If success, it
returns list of results for each entry.
Route attributes:
scope: files.content.write
@function Dropbox#filesCopyBatchCheck
@deprecated
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesRelocationBatchJobStatus>, DropboxResponseError.<AsyncPollError>>} | routes.filesCopyBatchCheck ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesCopyReferenceGet = function (arg) {
return this.request('files/copy_reference/get', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | 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.
Route attributes:
scope: files.content.write
@function Dropbox#filesCopyReferenceGet
@arg {FilesGetCopyReferenceArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesGetCopyReferenceResult>, DropboxResponseError.<FilesGetCopyReferenceError>>} | routes.filesCopyReferenceGet ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesCopyReferenceSave = function (arg) {
return this.request('files/copy_reference/save', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Save a copy reference returned by copy_reference/get to the user's Dropbox.
Route attributes:
scope: files.content.write
@function Dropbox#filesCopyReferenceSave
@arg {FilesSaveCopyReferenceArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesSaveCopyReferenceResult>, DropboxResponseError.<FilesSaveCopyReferenceError>>} | routes.filesCopyReferenceSave ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesCreateFolderV2 = function (arg) {
return this.request('files/create_folder_v2', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Create a folder at a given path.
Route attributes:
scope: files.content.write
@function Dropbox#filesCreateFolderV2
@arg {FilesCreateFolderArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesCreateFolderResult>, DropboxResponseError.<FilesCreateFolderError>>} | routes.filesCreateFolderV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesCreateFolder = function (arg) {
return this.request('files/create_folder', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Create a folder at a given path.
Route attributes:
scope: files.content.write
@function Dropbox#filesCreateFolder
@deprecated
@arg {FilesCreateFolderArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesFolderMetadata>, DropboxResponseError.<FilesCreateFolderError>>} | routes.filesCreateFolder ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesCreateFolderBatch = function (arg) {
return this.request('files/create_folder_batch', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | 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 CreateFolderBatchArg.force_async flag. Use
create_folder_batch/check to check the job status.
Route attributes:
scope: files.content.write
@function Dropbox#filesCreateFolderBatch
@arg {FilesCreateFolderBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesCreateFolderBatchLaunch>, DropboxResponseError.<void>>} | routes.filesCreateFolderBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesCreateFolderBatchCheck = function (arg) {
return this.request('files/create_folder_batch/check', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Returns the status of an asynchronous job for create_folder_batch. If
success, it returns list of result for each entry.
Route attributes:
scope: files.content.write
@function Dropbox#filesCreateFolderBatchCheck
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesCreateFolderBatchJobStatus>, DropboxResponseError.<AsyncPollError>>} | routes.filesCreateFolderBatchCheck ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesDeleteV2 = function (arg) {
return this.request('files/delete_v2', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | 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
FileMetadata or FolderMetadata for the item at time of deletion, and not a
DeletedMetadata object.
Route attributes:
scope: files.content.write
@function Dropbox#filesDeleteV2
@arg {FilesDeleteArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesDeleteResult>, DropboxResponseError.<FilesDeleteError>>} | routes.filesDeleteV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesDelete = function (arg) {
return this.request('files/delete', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | 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
FileMetadata or FolderMetadata for the item at time of deletion, and not a
DeletedMetadata object.
Route attributes:
scope: files.content.write
@function Dropbox#filesDelete
@deprecated
@arg {FilesDeleteArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<(FilesFileMetadata|FilesFolderMetadata|FilesDeletedMetadata)>, DropboxResponseError.<FilesDeleteError>>} | routes.filesDelete ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesDeleteBatch = function (arg) {
return this.request('files/delete_batch', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | 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 to check the job status.
Route attributes:
scope: files.content.write
@function Dropbox#filesDeleteBatch
@arg {FilesDeleteBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesDeleteBatchLaunch>, DropboxResponseError.<void>>} | routes.filesDeleteBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesDeleteBatchCheck = function (arg) {
return this.request('files/delete_batch/check', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Returns the status of an asynchronous job for delete_batch. If success, it
returns list of result for each entry.
Route attributes:
scope: files.content.write
@function Dropbox#filesDeleteBatchCheck
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesDeleteBatchJobStatus>, DropboxResponseError.<AsyncPollError>>} | routes.filesDeleteBatchCheck ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesDownload = function (arg) {
return this.request('files/download', arg, 'user', 'content', 'download', 'files.content.read');
}; | Download a file from a user's Dropbox.
Route attributes:
scope: files.content.read
@function Dropbox#filesDownload
@arg {FilesDownloadArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesFileMetadata>, DropboxResponseError.<FilesDownloadError>>} | routes.filesDownload ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesDownloadZip = function (arg) {
return this.request('files/download_zip', arg, 'user', 'content', 'download', 'files.content.read');
}; | Download a folder from the user's Dropbox, as a zip file. The folder must be
less than 20 GB in size and any single file within must be less than 4 GB in
size. The resulting zip must have fewer than 10,000 total file and folder
entries, including the top level folder. The input cannot be a single file.
Note: this endpoint does not support HTTP range requests.
Route attributes:
scope: files.content.read
@function Dropbox#filesDownloadZip
@arg {FilesDownloadZipArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesDownloadZipResult>, DropboxResponseError.<FilesDownloadZipError>>} | routes.filesDownloadZip ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesExport = function (arg) {
return this.request('files/export', arg, 'user', 'content', 'download', 'files.content.read');
}; | Export a file from a user's Dropbox. This route only supports exporting files
that cannot be downloaded directly and whose ExportResult.file_metadata has
ExportInfo.export_as populated.
Route attributes:
scope: files.content.read
@function Dropbox#filesExport
@arg {FilesExportArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesExportResult>, DropboxResponseError.<FilesExportError>>} | routes.filesExport ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesGetFileLockBatch = function (arg) {
return this.request('files/get_file_lock_batch', arg, 'user', 'api', 'rpc', 'files.content.read');
}; | Return the lock metadata for the given list of paths.
Route attributes:
scope: files.content.read
@function Dropbox#filesGetFileLockBatch
@arg {FilesLockFileBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesLockFileBatchResult>, DropboxResponseError.<FilesLockFileError>>} | routes.filesGetFileLockBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesGetMetadata = function (arg) {
return this.request('files/get_metadata', arg, 'user', 'api', 'rpc', 'files.metadata.read');
}; | Returns the metadata for a file or folder. Note: Metadata for the root folder
is unsupported.
Route attributes:
scope: files.metadata.read
@function Dropbox#filesGetMetadata
@arg {FilesGetMetadataArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<(FilesFileMetadata|FilesFolderMetadata|FilesDeletedMetadata)>, DropboxResponseError.<FilesGetMetadataError>>} | routes.filesGetMetadata ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesGetPreview = function (arg) {
return this.request('files/get_preview', arg, 'user', 'content', 'download', 'files.content.read');
}; | 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.
Route attributes:
scope: files.content.read
@function Dropbox#filesGetPreview
@arg {FilesPreviewArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesFileMetadata>, DropboxResponseError.<FilesPreviewError>>} | routes.filesGetPreview ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesGetTemporaryLink = function (arg) {
return this.request('files/get_temporary_link', arg, 'user', 'api', 'rpc', 'files.content.read');
}; | 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.
Route attributes:
scope: files.content.read
@function Dropbox#filesGetTemporaryLink
@arg {FilesGetTemporaryLinkArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesGetTemporaryLinkResult>, DropboxResponseError.<FilesGetTemporaryLinkError>>} | routes.filesGetTemporaryLink ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesGetTemporaryUploadLink = function (arg) {
return this.request('files/get_temporary_upload_link', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Get a one-time use temporary upload link to upload a file to a Dropbox
location. This endpoint acts as a delayed upload. The returned temporary
upload link may be used to make a POST request with the data to be uploaded.
The upload will then be perfomed with the CommitInfo previously provided to
get_temporary_upload_link but evaluated only upon consumption. Hence, errors
stemming from invalid CommitInfo with respect to the state of the user's
Dropbox will only be communicated at consumption time. Additionally, these
errors are surfaced as generic HTTP 409 Conflict responses, potentially
hiding issue details. The maximum temporary upload link duration is 4 hours.
Upon consumption or expiration, a new link will have to be generated.
Multiple links may exist for a specific upload path at any given time. The
POST request on the temporary upload link must have its Content-Type set to
"application/octet-stream". Example temporary upload link consumption
request: curl -X POST
https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND --header
"Content-Type: application/octet-stream" --data-binary @local_file.txt A
successful temporary upload link consumption request returns the content hash
of the uploaded data in JSON format. Example successful temporary upload
link consumption response: {"content-hash":
"599d71033d700ac892a0e48fa61b125d2f5994"} An unsuccessful temporary upload
link consumption request returns any of the following status codes: HTTP 400
Bad Request: Content-Type is not one of application/octet-stream and
text/plain or request is invalid. HTTP 409 Conflict: The temporary upload
link does not exist or is currently unavailable, the upload failed, or
another error happened. HTTP 410 Gone: The temporary upload link is expired
or consumed. Example unsuccessful temporary upload link consumption
response: Temporary upload link has been recently consumed.
Route attributes:
scope: files.content.write
@function Dropbox#filesGetTemporaryUploadLink
@arg {FilesGetTemporaryUploadLinkArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesGetTemporaryUploadLinkResult>, DropboxResponseError.<void>>} | routes.filesGetTemporaryUploadLink ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesGetThumbnail = function (arg) {
return this.request('files/get_thumbnail', arg, 'user', 'content', 'download', 'files.content.read');
}; | Get a thumbnail for an image. This method currently supports files with the
following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp.
Photos that are larger than 20MB in size won't be converted to a thumbnail.
Route attributes:
scope: files.content.read
@function Dropbox#filesGetThumbnail
@arg {FilesThumbnailArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesFileMetadata>, DropboxResponseError.<FilesThumbnailError>>} | routes.filesGetThumbnail ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesGetThumbnailV2 = function (arg) {
return this.request('files/get_thumbnail_v2', arg, 'app, user', 'content', 'download', 'files.content.read');
}; | Get a thumbnail for an image. This method currently supports files with the
following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp.
Photos that are larger than 20MB in size won't be converted to a thumbnail.
Route attributes:
scope: files.content.read
@function Dropbox#filesGetThumbnailV2
@arg {FilesThumbnailV2Arg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesPreviewResult>, DropboxResponseError.<FilesThumbnailV2Error>>} | routes.filesGetThumbnailV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesGetThumbnailBatch = function (arg) {
return this.request('files/get_thumbnail_batch', arg, 'user', 'content', 'rpc', 'files.content.read');
}; | 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, webp, ppm and bmp. Photos that
are larger than 20MB in size won't be converted to a thumbnail.
Route attributes:
scope: files.content.read
@function Dropbox#filesGetThumbnailBatch
@arg {FilesGetThumbnailBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesGetThumbnailBatchResult>, DropboxResponseError.<FilesGetThumbnailBatchError>>} | routes.filesGetThumbnailBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesListFolder = function (arg) {
return this.request('files/list_folder', arg, 'app, user', 'api', 'rpc', 'files.metadata.read');
}; | Starts returning the contents of a folder. If the result's
ListFolderResult.has_more field is true, call list_folder/continue with the
returned ListFolderResult.cursor to retrieve more entries. If you're using
ListFolderArg.recursive 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.read_only 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:
auth.RateLimitError may be returned if multiple list_folder or
list_folder/continue 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.
Route attributes:
scope: files.metadata.read
@function Dropbox#filesListFolder
@arg {FilesListFolderArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesListFolderResult>, DropboxResponseError.<FilesListFolderError>>} | routes.filesListFolder ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesListFolderContinue = function (arg) {
return this.request('files/list_folder/continue', arg, 'app, user', 'api', 'rpc', 'files.metadata.read');
}; | Once a cursor has been retrieved from list_folder, use this to paginate
through all files and retrieve updates to the folder, following the same
rules as documented for list_folder.
Route attributes:
scope: files.metadata.read
@function Dropbox#filesListFolderContinue
@arg {FilesListFolderContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesListFolderResult>, DropboxResponseError.<FilesListFolderContinueError>>} | routes.filesListFolderContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesListFolderGetLatestCursor = function (arg) {
return this.request('files/list_folder/get_latest_cursor', arg, 'user', 'api', 'rpc', 'files.metadata.read');
}; | A way to quickly get a cursor for the folder's state. Unlike list_folder,
list_folder/get_latest_cursor 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.
Route attributes:
scope: files.metadata.read
@function Dropbox#filesListFolderGetLatestCursor
@arg {FilesListFolderArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesListFolderGetLatestCursorResult>, DropboxResponseError.<FilesListFolderError>>} | routes.filesListFolderGetLatestCursor ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesListFolderLongpoll = function (arg) {
return this.request('files/list_folder/longpoll', arg, 'noauth', 'notify', 'rpc', 'files.metadata.read');
}; | A longpoll endpoint to wait for changes on an account. In conjunction with
list_folder/continue, 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 https://www.dropbox.com/developers/reference/webhooks.
Route attributes:
scope: files.metadata.read
@function Dropbox#filesListFolderLongpoll
@arg {FilesListFolderLongpollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesListFolderLongpollResult>, DropboxResponseError.<FilesListFolderLongpollError>>} | routes.filesListFolderLongpoll ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesListRevisions = function (arg) {
return this.request('files/list_revisions', arg, 'user', 'api', 'rpc', 'files.metadata.read');
}; | 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 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.
Route attributes:
scope: files.metadata.read
@function Dropbox#filesListRevisions
@arg {FilesListRevisionsArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesListRevisionsResult>, DropboxResponseError.<FilesListRevisionsError>>} | routes.filesListRevisions ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesLockFileBatch = function (arg) {
return this.request('files/lock_file_batch', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Lock the files at the given paths. A locked file will be writable only by the
lock holder. A successful response indicates that the file has been locked.
Returns a list of the locked file paths and their metadata after this
operation.
Route attributes:
scope: files.content.write
@function Dropbox#filesLockFileBatch
@arg {FilesLockFileBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesLockFileBatchResult>, DropboxResponseError.<FilesLockFileError>>} | routes.filesLockFileBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesMoveV2 = function (arg) {
return this.request('files/move_v2', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | 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. Note that we do not
currently support case-only renaming.
Route attributes:
scope: files.content.write
@function Dropbox#filesMoveV2
@arg {FilesRelocationArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesRelocationResult>, DropboxResponseError.<FilesRelocationError>>} | routes.filesMoveV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesMove = function (arg) {
return this.request('files/move', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | 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.
Route attributes:
scope: files.content.write
@function Dropbox#filesMove
@deprecated
@arg {FilesRelocationArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<(FilesFileMetadata|FilesFolderMetadata|FilesDeletedMetadata)>, DropboxResponseError.<FilesRelocationError>>} | routes.filesMove ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesMoveBatchV2 = function (arg) {
return this.request('files/move_batch_v2', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Move multiple files or folders to different locations at once in the user's
Dropbox. Note that we do not currently support case-only renaming. This route
will replace move_batch. The main difference is this route will return status
for each entry, while move_batch raises failure if any entry fails. This
route will either finish synchronously, or return a job ID and do the async
move job in background. Please use move_batch/check_v2 to check the job
status.
Route attributes:
scope: files.content.write
@function Dropbox#filesMoveBatchV2
@arg {FilesMoveBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesRelocationBatchV2Launch>, DropboxResponseError.<void>>} | routes.filesMoveBatchV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesMoveBatch = function (arg) {
return this.request('files/move_batch', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Move multiple files or folders to different locations at once in the user's
Dropbox. This route will return job ID immediately and do the async moving
job in background. Please use move_batch/check to check the job status.
Route attributes:
scope: files.content.write
@function Dropbox#filesMoveBatch
@deprecated
@arg {FilesRelocationBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesRelocationBatchLaunch>, DropboxResponseError.<void>>} | routes.filesMoveBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesMoveBatchCheckV2 = function (arg) {
return this.request('files/move_batch/check_v2', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Returns the status of an asynchronous job for move_batch_v2. It returns list
of results for each entry.
Route attributes:
scope: files.content.write
@function Dropbox#filesMoveBatchCheckV2
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesRelocationBatchV2JobStatus>, DropboxResponseError.<AsyncPollError>>} | routes.filesMoveBatchCheckV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesMoveBatchCheck = function (arg) {
return this.request('files/move_batch/check', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Returns the status of an asynchronous job for move_batch. If success, it
returns list of results for each entry.
Route attributes:
scope: files.content.write
@function Dropbox#filesMoveBatchCheck
@deprecated
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesRelocationBatchJobStatus>, DropboxResponseError.<AsyncPollError>>} | routes.filesMoveBatchCheck ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesPaperCreate = function (arg) {
return this.request('files/paper/create', arg, 'user', 'api', 'upload', 'files.content.write');
}; | Creates a new Paper doc with the provided content.
Route attributes:
scope: files.content.write
@function Dropbox#filesPaperCreate
@arg {FilesPaperCreateArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesPaperCreateResult>, DropboxResponseError.<FilesPaperCreateError>>} | routes.filesPaperCreate ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesPaperUpdate = function (arg) {
return this.request('files/paper/update', arg, 'user', 'api', 'upload', 'files.content.write');
}; | Updates an existing Paper doc with the provided content.
Route attributes:
scope: files.content.write
@function Dropbox#filesPaperUpdate
@arg {FilesPaperUpdateArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesPaperUpdateResult>, DropboxResponseError.<FilesPaperUpdateError>>} | routes.filesPaperUpdate ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesPermanentlyDelete = function (arg) {
return this.request('files/permanently_delete', arg, 'user', 'api', 'rpc', 'files.permanent_delete');
}; | Permanently delete the file or folder at a given path (see
https://www.dropbox.com/en/help/40). If the given file or folder is not yet
deleted, this route will first delete it. It is possible for this route to
successfully delete, then fail to permanently delete. Note: This endpoint is
only available for Dropbox Business apps.
Route attributes:
scope: files.permanent_delete
@function Dropbox#filesPermanentlyDelete
@arg {FilesDeleteArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<FilesDeleteError>>} | routes.filesPermanentlyDelete ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesPropertiesAdd = function (arg) {
return this.request('files/properties/add', arg, 'user', 'api', 'rpc', 'files.metadata.write');
}; | Route attributes:
scope: files.metadata.write
@function Dropbox#filesPropertiesAdd
@deprecated
@arg {FilePropertiesAddPropertiesArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<FilePropertiesAddPropertiesError>>} | routes.filesPropertiesAdd ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesPropertiesOverwrite = function (arg) {
return this.request('files/properties/overwrite', arg, 'user', 'api', 'rpc', 'files.metadata.write');
}; | Route attributes:
scope: files.metadata.write
@function Dropbox#filesPropertiesOverwrite
@deprecated
@arg {FilePropertiesOverwritePropertyGroupArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<FilePropertiesInvalidPropertyGroupError>>} | routes.filesPropertiesOverwrite ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesPropertiesRemove = function (arg) {
return this.request('files/properties/remove', arg, 'user', 'api', 'rpc', 'files.metadata.write');
}; | Route attributes:
scope: files.metadata.write
@function Dropbox#filesPropertiesRemove
@deprecated
@arg {FilePropertiesRemovePropertiesArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<FilePropertiesRemovePropertiesError>>} | routes.filesPropertiesRemove ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesPropertiesTemplateGet = function (arg) {
return this.request('files/properties/template/get', arg, 'user', 'api', 'rpc', 'files.metadata.read');
}; | Route attributes:
scope: files.metadata.read
@function Dropbox#filesPropertiesTemplateGet
@deprecated
@arg {FilePropertiesGetTemplateArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilePropertiesGetTemplateResult>, DropboxResponseError.<FilePropertiesTemplateError>>} | routes.filesPropertiesTemplateGet ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesPropertiesTemplateList = function () {
return this.request('files/properties/template/list', null, 'user', 'api', 'rpc', 'files.metadata.read');
}; | Route attributes:
scope: files.metadata.read
@function Dropbox#filesPropertiesTemplateList
@deprecated
@returns {Promise.<DropboxResponse<FilePropertiesListTemplateResult>, DropboxResponseError.<FilePropertiesTemplateError>>} | routes.filesPropertiesTemplateList ( ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesPropertiesUpdate = function (arg) {
return this.request('files/properties/update', arg, 'user', 'api', 'rpc', 'files.metadata.write');
}; | Route attributes:
scope: files.metadata.write
@function Dropbox#filesPropertiesUpdate
@deprecated
@arg {FilePropertiesUpdatePropertiesArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<FilePropertiesUpdatePropertiesError>>} | routes.filesPropertiesUpdate ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesRestore = function (arg) {
return this.request('files/restore', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Restore a specific revision of a file to the given path.
Route attributes:
scope: files.content.write
@function Dropbox#filesRestore
@arg {FilesRestoreArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesFileMetadata>, DropboxResponseError.<FilesRestoreError>>} | routes.filesRestore ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesSaveUrl = function (arg) {
return this.request('files/save_url', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | 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).
Route attributes:
scope: files.content.write
@function Dropbox#filesSaveUrl
@arg {FilesSaveUrlArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesSaveUrlResult>, DropboxResponseError.<FilesSaveUrlError>>} | routes.filesSaveUrl ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesSaveUrlCheckJobStatus = function (arg) {
return this.request('files/save_url/check_job_status', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Check the status of a save_url job.
Route attributes:
scope: files.content.write
@function Dropbox#filesSaveUrlCheckJobStatus
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesSaveUrlJobStatus>, DropboxResponseError.<AsyncPollError>>} | routes.filesSaveUrlCheckJobStatus ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesSearch = function (arg) {
return this.request('files/search', arg, 'user', 'api', 'rpc', 'files.metadata.read');
}; | Searches for files and folders. Note: Recent changes will be reflected in
search results within a few seconds and older revisions of existing files may
still match your query for up to a few days.
Route attributes:
scope: files.metadata.read
@function Dropbox#filesSearch
@deprecated
@arg {FilesSearchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesSearchResult>, DropboxResponseError.<FilesSearchError>>} | routes.filesSearch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesSearchV2 = function (arg) {
return this.request('files/search_v2', arg, 'user', 'api', 'rpc', 'files.metadata.read');
}; | Searches for files and folders. Note: search_v2 along with search/continue_v2
can only be used to retrieve a maximum of 10,000 matches. Recent changes may
not immediately be reflected in search results due to a short delay in
indexing. Duplicate results may be returned across pages. Some results may
not be returned.
Route attributes:
scope: files.metadata.read
@function Dropbox#filesSearchV2
@arg {FilesSearchV2Arg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesSearchV2Result>, DropboxResponseError.<FilesSearchError>>} | routes.filesSearchV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesSearchContinueV2 = function (arg) {
return this.request('files/search/continue_v2', arg, 'user', 'api', 'rpc', 'files.metadata.read');
}; | Fetches the next page of search results returned from search_v2. Note:
search_v2 along with search/continue_v2 can only be used to retrieve a
maximum of 10,000 matches. Recent changes may not immediately be reflected in
search results due to a short delay in indexing. Duplicate results may be
returned across pages. Some results may not be returned.
Route attributes:
scope: files.metadata.read
@function Dropbox#filesSearchContinueV2
@arg {FilesSearchV2ContinueArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesSearchV2Result>, DropboxResponseError.<FilesSearchError>>} | routes.filesSearchContinueV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesTagsAdd = function (arg) {
return this.request('files/tags/add', arg, 'user', 'api', 'rpc', 'files.metadata.write');
}; | Add a tag to an item. A tag is a string. The strings are automatically
converted to lowercase letters. No more than 20 tags can be added to a given
item.
Route attributes:
scope: files.metadata.write
@function Dropbox#filesTagsAdd
@arg {FilesAddTagArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<FilesAddTagError>>} | routes.filesTagsAdd ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesTagsGet = function (arg) {
return this.request('files/tags/get', arg, 'user', 'api', 'rpc', 'files.metadata.read');
}; | Get list of tags assigned to items.
Route attributes:
scope: files.metadata.read
@function Dropbox#filesTagsGet
@arg {FilesGetTagsArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesGetTagsResult>, DropboxResponseError.<FilesBaseTagError>>} | routes.filesTagsGet ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesTagsRemove = function (arg) {
return this.request('files/tags/remove', arg, 'user', 'api', 'rpc', 'files.metadata.write');
}; | Remove a tag from an item.
Route attributes:
scope: files.metadata.write
@function Dropbox#filesTagsRemove
@arg {FilesRemoveTagArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<FilesRemoveTagError>>} | routes.filesTagsRemove ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesUnlockFileBatch = function (arg) {
return this.request('files/unlock_file_batch', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Unlock the files at the given paths. A locked file can only be unlocked by
the lock holder or, if a business account, a team admin. A successful
response indicates that the file has been unlocked. Returns a list of the
unlocked file paths and their metadata after this operation.
Route attributes:
scope: files.content.write
@function Dropbox#filesUnlockFileBatch
@arg {FilesUnlockFileBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesLockFileBatchResult>, DropboxResponseError.<FilesLockFileError>>} | routes.filesUnlockFileBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesUpload = function (arg) {
return this.request('files/upload', arg, 'user', 'content', 'upload', 'files.content.write');
}; | 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/start. 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
https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
@function Dropbox#filesUpload
@arg {FilesUploadArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesFileMetadata>, DropboxResponseError.<FilesUploadError>>} | routes.filesUpload ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesUploadSessionAppendV2 = function (arg) {
return this.request('files/upload_session/append_v2', arg, 'user', 'content', 'upload', 'files.content.write');
}; | 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
https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
@function Dropbox#filesUploadSessionAppendV2
@arg {FilesUploadSessionAppendArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<FilesUploadSessionAppendError>>} | routes.filesUploadSessionAppendV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesUploadSessionAppend = function (arg) {
return this.request('files/upload_session/append', arg, 'user', 'content', 'upload', 'files.content.write');
}; | 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 https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
@function Dropbox#filesUploadSessionAppend
@deprecated
@arg {FilesUploadSessionCursor} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<FilesUploadSessionAppendError>>} | routes.filesUploadSessionAppend ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesUploadSessionFinish = function (arg) {
return this.request('files/upload_session/finish', arg, 'user', 'content', 'upload', 'files.content.write');
}; | 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
https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
@function Dropbox#filesUploadSessionFinish
@arg {FilesUploadSessionFinishArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesFileMetadata>, DropboxResponseError.<FilesUploadSessionFinishError>>} | routes.filesUploadSessionFinish ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesUploadSessionFinishBatch = function (arg) {
return this.request('files/upload_session/finish_batch', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | This route helps you commit many files at once into a user's Dropbox. Use
upload_session/start and upload_session/append_v2 to upload file contents. We
recommend uploading many files in parallel to increase throughput. Once the
file contents have been uploaded, rather than calling upload_session/finish,
use this route to finish all your upload sessions in a single request.
UploadSessionStartArg.close or UploadSessionAppendArg.close needs to be true
for the last upload_session/start or upload_session/append_v2 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 upload_session/finish_batch/check 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. 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
https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
@function Dropbox#filesUploadSessionFinishBatch
@deprecated
@arg {FilesUploadSessionFinishBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesUploadSessionFinishBatchLaunch>, DropboxResponseError.<void>>} | routes.filesUploadSessionFinishBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesUploadSessionFinishBatchV2 = function (arg) {
return this.request('files/upload_session/finish_batch_v2', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | This route helps you commit many files at once into a user's Dropbox. Use
upload_session/start and upload_session/append_v2 to upload file contents. We
recommend uploading many files in parallel to increase throughput. Once the
file contents have been uploaded, rather than calling upload_session/finish,
use this route to finish all your upload sessions in a single request.
UploadSessionStartArg.close or UploadSessionAppendArg.close needs to be true
for the last upload_session/start or upload_session/append_v2 call of each
upload session. The maximum size of a file one can upload to an upload
session is 350 GB. We allow up to 1000 entries in a single request. 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
https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
@function Dropbox#filesUploadSessionFinishBatchV2
@arg {FilesUploadSessionFinishBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesUploadSessionFinishBatchResult>, DropboxResponseError.<void>>} | routes.filesUploadSessionFinishBatchV2 ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesUploadSessionFinishBatchCheck = function (arg) {
return this.request('files/upload_session/finish_batch/check', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Returns the status of an asynchronous job for upload_session/finish_batch. If
success, it returns list of result for each entry.
Route attributes:
scope: files.content.write
@function Dropbox#filesUploadSessionFinishBatchCheck
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesUploadSessionFinishBatchJobStatus>, DropboxResponseError.<AsyncPollError>>} | routes.filesUploadSessionFinishBatchCheck ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesUploadSessionStart = function (arg) {
return this.request('files/upload_session/start', arg, 'user', 'content', 'upload', 'files.content.write');
}; | 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
upload_session/append_v2 to add more data and upload_session/finish 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 7 days. Attempting
to use an UploadSessionStartResult.session_id with upload_session/append_v2
or upload_session/finish more than 7 days after its creation will return a
UploadSessionLookupError.not_found. 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
https://www.dropbox.com/developers/reference/data-transport-limit. By
default, upload sessions require you to send content of the file in
sequential order via consecutive upload_session/start,
upload_session/append_v2, upload_session/finish calls. For better
performance, you can instead optionally use a UploadSessionType.concurrent
upload session. To start a new concurrent session, set
UploadSessionStartArg.session_type to UploadSessionType.concurrent. After
that, you can send file data in concurrent upload_session/append_v2 requests.
Finally finish the session with upload_session/finish. There are couple of
constraints with concurrent sessions to make them work. You can not send data
with upload_session/start or upload_session/finish call, only with
upload_session/append_v2 call. Also data uploaded in upload_session/append_v2
call must be multiple of 4194304 bytes (except for last
upload_session/append_v2 with UploadSessionStartArg.close to true, that may
contain any remaining data).
Route attributes:
scope: files.content.write
@function Dropbox#filesUploadSessionStart
@arg {FilesUploadSessionStartArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesUploadSessionStartResult>, DropboxResponseError.<FilesUploadSessionStartError>>} | routes.filesUploadSessionStart ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.filesUploadSessionStartBatch = function (arg) {
return this.request('files/upload_session/start_batch', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | This route starts batch of upload_sessions. Please refer to
`upload_session/start` usage. 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
https://www.dropbox.com/developers/reference/data-transport-limit.
Route attributes:
scope: files.content.write
@function Dropbox#filesUploadSessionStartBatch
@arg {FilesUploadSessionStartBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<FilesUploadSessionStartBatchResult>, DropboxResponseError.<void>>} | routes.filesUploadSessionStartBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.openidUserinfo = function (arg) {
return this.request('openid/userinfo', arg, 'user', 'api', 'rpc', 'openid');
}; | This route is used for refreshing the info that is found in the id_token
during the OIDC flow. This route doesn't require any arguments and will use
the scopes approved for the given access token.
Route attributes:
scope: openid
@function Dropbox#openidUserinfo
@arg {OpenidUserInfoArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<OpenidUserInfoResult>, DropboxResponseError.<OpenidUserInfoError>>} | routes.openidUserinfo ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsArchive = function (arg) {
return this.request('paper/docs/archive', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Marks the given Paper doc as archived. This action can be performed or undone
by anyone with edit permissions to the doc. Note that this endpoint will
continue to work for content created by users on the older version of Paper.
To check which version of Paper a user is on, use /users/features/get_values.
If the paper_as_files feature is enabled, then the user is running the new
version of Paper. This endpoint will be retired in September 2020. Refer to
the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
more information.
Route attributes:
scope: files.content.write
@function Dropbox#paperDocsArchive
@deprecated
@arg {PaperRefPaperDoc} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<PaperDocLookupError>>} | routes.paperDocsArchive ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsCreate = function (arg) {
return this.request('paper/docs/create', arg, 'user', 'api', 'upload', 'files.content.write');
}; | Creates a new Paper doc with the provided content. Note that this endpoint
will continue to work for content created by users on the older version of
Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. This endpoint will be retired
in September 2020. Refer to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
more information.
Route attributes:
scope: files.content.write
@function Dropbox#paperDocsCreate
@deprecated
@arg {PaperPaperDocCreateArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<PaperPaperDocCreateUpdateResult>, DropboxResponseError.<PaperPaperDocCreateError>>} | routes.paperDocsCreate ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsDownload = function (arg) {
return this.request('paper/docs/download', arg, 'user', 'api', 'download', 'files.content.read');
}; | Exports and downloads Paper doc either as HTML or markdown. Note that this
endpoint will continue to work for content created by users on the older
version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. Refer to the Paper Migration
Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide
for migration information.
Route attributes:
scope: files.content.read
@function Dropbox#paperDocsDownload
@deprecated
@arg {PaperPaperDocExport} arg - The request parameters.
@returns {Promise.<DropboxResponse<PaperPaperDocExportResult>, DropboxResponseError.<PaperDocLookupError>>} | routes.paperDocsDownload ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsFolderUsersList = function (arg) {
return this.request('paper/docs/folder_users/list', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Lists the users who are explicitly invited to the Paper folder in which the
Paper doc is contained. For private folders all users (including owner)
shared on the folder are listed and for team folders all non-team users
shared on the folder are returned. Note that this endpoint will continue to
work for content created by users on the older version of Paper. To check
which version of Paper a user is on, use /users/features/get_values. If the
paper_as_files feature is enabled, then the user is running the new version
of Paper. Refer to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: sharing.read
@function Dropbox#paperDocsFolderUsersList
@deprecated
@arg {PaperListUsersOnFolderArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<PaperListUsersOnFolderResponse>, DropboxResponseError.<PaperDocLookupError>>} | routes.paperDocsFolderUsersList ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsFolderUsersListContinue = function (arg) {
return this.request('paper/docs/folder_users/list/continue', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Once a cursor has been retrieved from docs/folder_users/list, use this to
paginate through all users on the Paper folder. Note that this endpoint will
continue to work for content created by users on the older version of Paper.
To check which version of Paper a user is on, use /users/features/get_values.
If the paper_as_files feature is enabled, then the user is running the new
version of Paper. Refer to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: sharing.read
@function Dropbox#paperDocsFolderUsersListContinue
@deprecated
@arg {PaperListUsersOnFolderContinueArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<PaperListUsersOnFolderResponse>, DropboxResponseError.<PaperListUsersCursorError>>} | routes.paperDocsFolderUsersListContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsGetFolderInfo = function (arg) {
return this.request('paper/docs/get_folder_info', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Retrieves folder information for the given Paper doc. This includes: -
folder sharing policy; permissions for subfolders are set by the top-level
folder. - full 'filepath', i.e. the list of folders (both folderId and
folderName) from the root folder to the folder directly containing the
Paper doc. If the Paper doc is not in any folder (aka unfiled) the response
will be empty. Note that this endpoint will continue to work for content
created by users on the older version of Paper. To check which version of
Paper a user is on, use /users/features/get_values. If the paper_as_files
feature is enabled, then the user is running the new version of Paper. Refer
to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: sharing.read
@function Dropbox#paperDocsGetFolderInfo
@deprecated
@arg {PaperRefPaperDoc} arg - The request parameters.
@returns {Promise.<DropboxResponse<PaperFoldersContainingPaperDoc>, DropboxResponseError.<PaperDocLookupError>>} | routes.paperDocsGetFolderInfo ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsList = function (arg) {
return this.request('paper/docs/list', arg, 'user', 'api', 'rpc', 'files.metadata.read');
}; | Return the list of all Paper docs according to the argument specifications.
To iterate over through the full pagination, pass the cursor to
docs/list/continue. Note that this endpoint will continue to work for content
created by users on the older version of Paper. To check which version of
Paper a user is on, use /users/features/get_values. If the paper_as_files
feature is enabled, then the user is running the new version of Paper. Refer
to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: files.metadata.read
@function Dropbox#paperDocsList
@deprecated
@arg {PaperListPaperDocsArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<PaperListPaperDocsResponse>, DropboxResponseError.<void>>} | routes.paperDocsList ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsListContinue = function (arg) {
return this.request('paper/docs/list/continue', arg, 'user', 'api', 'rpc', 'files.metadata.read');
}; | Once a cursor has been retrieved from docs/list, use this to paginate through
all Paper doc. Note that this endpoint will continue to work for content
created by users on the older version of Paper. To check which version of
Paper a user is on, use /users/features/get_values. If the paper_as_files
feature is enabled, then the user is running the new version of Paper. Refer
to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: files.metadata.read
@function Dropbox#paperDocsListContinue
@deprecated
@arg {PaperListPaperDocsContinueArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<PaperListPaperDocsResponse>, DropboxResponseError.<PaperListDocsCursorError>>} | routes.paperDocsListContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsPermanentlyDelete = function (arg) {
return this.request('paper/docs/permanently_delete', arg, 'user', 'api', 'rpc', 'files.permanent_delete');
}; | Permanently deletes the given Paper doc. This operation is final as the doc
cannot be recovered. This action can be performed only by the doc owner. Note
that this endpoint will continue to work for content created by users on the
older version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. Refer to the Paper Migration
Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide
for migration information.
Route attributes:
scope: files.permanent_delete
@function Dropbox#paperDocsPermanentlyDelete
@deprecated
@arg {PaperRefPaperDoc} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<PaperDocLookupError>>} | routes.paperDocsPermanentlyDelete ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsSharingPolicyGet = function (arg) {
return this.request('paper/docs/sharing_policy/get', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Gets the default sharing policy for the given Paper doc. Note that this
endpoint will continue to work for content created by users on the older
version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. Refer to the Paper Migration
Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide
for migration information.
Route attributes:
scope: sharing.read
@function Dropbox#paperDocsSharingPolicyGet
@deprecated
@arg {PaperRefPaperDoc} arg - The request parameters.
@returns {Promise.<DropboxResponse<PaperSharingPolicy>, DropboxResponseError.<PaperDocLookupError>>} | routes.paperDocsSharingPolicyGet ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsSharingPolicySet = function (arg) {
return this.request('paper/docs/sharing_policy/set', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Sets the default sharing policy for the given Paper doc. The default
'team_sharing_policy' can be changed only by teams, omit this field for
personal accounts. The 'public_sharing_policy' policy can't be set to the
value 'disabled' because this setting can be changed only via the team admin
console. Note that this endpoint will continue to work for content created by
users on the older version of Paper. To check which version of Paper a user
is on, use /users/features/get_values. If the paper_as_files feature is
enabled, then the user is running the new version of Paper. Refer to the
Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: sharing.write
@function Dropbox#paperDocsSharingPolicySet
@deprecated
@arg {PaperPaperDocSharingPolicy} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<PaperDocLookupError>>} | routes.paperDocsSharingPolicySet ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsUpdate = function (arg) {
return this.request('paper/docs/update', arg, 'user', 'api', 'upload', 'files.content.write');
}; | Updates an existing Paper doc with the provided content. Note that this
endpoint will continue to work for content created by users on the older
version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. This endpoint will be retired
in September 2020. Refer to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
more information.
Route attributes:
scope: files.content.write
@function Dropbox#paperDocsUpdate
@deprecated
@arg {PaperPaperDocUpdateArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<PaperPaperDocCreateUpdateResult>, DropboxResponseError.<PaperPaperDocUpdateError>>} | routes.paperDocsUpdate ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsUsersAdd = function (arg) {
return this.request('paper/docs/users/add', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Allows an owner or editor to add users to a Paper doc or change their
permissions using their email address or Dropbox account ID. The doc owner's
permissions cannot be changed. Note that this endpoint will continue to work
for content created by users on the older version of Paper. To check which
version of Paper a user is on, use /users/features/get_values. If the
paper_as_files feature is enabled, then the user is running the new version
of Paper. Refer to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: sharing.write
@function Dropbox#paperDocsUsersAdd
@deprecated
@arg {PaperAddPaperDocUser} arg - The request parameters.
@returns {Promise.<DropboxResponse<Array.<PaperAddPaperDocUserMemberResult>>, DropboxResponseError.<PaperDocLookupError>>} | routes.paperDocsUsersAdd ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsUsersList = function (arg) {
return this.request('paper/docs/users/list', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Lists all users who visited the Paper doc or users with explicit access. This
call excludes users who have been removed. The list is sorted by the date of
the visit or the share date. The list will include both users, the explicitly
shared ones as well as those who came in using the Paper url link. Note that
this endpoint will continue to work for content created by users on the older
version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. Refer to the Paper Migration
Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide
for migration information.
Route attributes:
scope: sharing.read
@function Dropbox#paperDocsUsersList
@deprecated
@arg {PaperListUsersOnPaperDocArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<PaperListUsersOnPaperDocResponse>, DropboxResponseError.<PaperDocLookupError>>} | routes.paperDocsUsersList ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsUsersListContinue = function (arg) {
return this.request('paper/docs/users/list/continue', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Once a cursor has been retrieved from docs/users/list, use this to paginate
through all users on the Paper doc. Note that this endpoint will continue to
work for content created by users on the older version of Paper. To check
which version of Paper a user is on, use /users/features/get_values. If the
paper_as_files feature is enabled, then the user is running the new version
of Paper. Refer to the Paper Migration Guide
https://www.dropbox.com/lp/developers/reference/paper-migration-guide for
migration information.
Route attributes:
scope: sharing.read
@function Dropbox#paperDocsUsersListContinue
@deprecated
@arg {PaperListUsersOnPaperDocContinueArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<PaperListUsersOnPaperDocResponse>, DropboxResponseError.<PaperListUsersCursorError>>} | routes.paperDocsUsersListContinue ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperDocsUsersRemove = function (arg) {
return this.request('paper/docs/users/remove', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Allows an owner or editor to remove users from a Paper doc using their email
address or Dropbox account ID. The doc owner cannot be removed. Note that
this endpoint will continue to work for content created by users on the older
version of Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. Refer to the Paper Migration
Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide
for migration information.
Route attributes:
scope: sharing.write
@function Dropbox#paperDocsUsersRemove
@deprecated
@arg {PaperRemovePaperDocUser} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<PaperDocLookupError>>} | routes.paperDocsUsersRemove ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.paperFoldersCreate = function (arg) {
return this.request('paper/folders/create', arg, 'user', 'api', 'rpc', 'files.content.write');
}; | Create a new Paper folder with the provided info. Note that this endpoint
will continue to work for content created by users on the older version of
Paper. To check which version of Paper a user is on, use
/users/features/get_values. If the paper_as_files feature is enabled, then
the user is running the new version of Paper. Refer to the Paper Migration
Guide https://www.dropbox.com/lp/developers/reference/paper-migration-guide
for migration information.
Route attributes:
scope: files.content.write
@function Dropbox#paperFoldersCreate
@deprecated
@arg {PaperPaperFolderCreateArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<PaperPaperFolderCreateResult>, DropboxResponseError.<PaperPaperFolderCreateError>>} | routes.paperFoldersCreate ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingAddFileMember = function (arg) {
return this.request('sharing/add_file_member', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Adds specified members to a file.
Route attributes:
scope: sharing.write
@function Dropbox#sharingAddFileMember
@arg {SharingAddFileMemberArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<Array.<SharingFileMemberActionResult>>, DropboxResponseError.<SharingAddFileMemberError>>} | routes.sharingAddFileMember ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingAddFolderMember = function (arg) {
return this.request('sharing/add_folder_member', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Allows an owner or editor (if the ACL update policy allows) of a shared
folder to add another member. For the new member to get access to all the
functionality for this folder, you will need to call mount_folder on their
behalf.
Route attributes:
scope: sharing.write
@function Dropbox#sharingAddFolderMember
@arg {SharingAddFolderMemberArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<void>, DropboxResponseError.<SharingAddFolderMemberError>>} | routes.sharingAddFolderMember ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingCheckJobStatus = function (arg) {
return this.request('sharing/check_job_status', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Returns the status of an asynchronous job.
Route attributes:
scope: sharing.write
@function Dropbox#sharingCheckJobStatus
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingJobStatus>, DropboxResponseError.<AsyncPollError>>} | routes.sharingCheckJobStatus ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingCheckRemoveMemberJobStatus = function (arg) {
return this.request('sharing/check_remove_member_job_status', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Returns the status of an asynchronous job for sharing a folder.
Route attributes:
scope: sharing.write
@function Dropbox#sharingCheckRemoveMemberJobStatus
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingRemoveMemberJobStatus>, DropboxResponseError.<AsyncPollError>>} | routes.sharingCheckRemoveMemberJobStatus ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingCheckShareJobStatus = function (arg) {
return this.request('sharing/check_share_job_status', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Returns the status of an asynchronous job for sharing a folder.
Route attributes:
scope: sharing.write
@function Dropbox#sharingCheckShareJobStatus
@arg {AsyncPollArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingShareFolderJobStatus>, DropboxResponseError.<AsyncPollError>>} | routes.sharingCheckShareJobStatus ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingCreateSharedLink = function (arg) {
return this.request('sharing/create_shared_link', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Create a shared link. If a shared link already exists for the given path,
that link is returned. Previously, it was technically possible to break a
shared link by moving or renaming the corresponding file or folder. In the
future, this will no longer be the case, so your app shouldn't rely on this
behavior. Instead, if your app needs to revoke a shared link, use
revoke_shared_link.
Route attributes:
scope: sharing.write
@function Dropbox#sharingCreateSharedLink
@deprecated
@arg {SharingCreateSharedLinkArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingPathLinkMetadata>, DropboxResponseError.<SharingCreateSharedLinkError>>} | routes.sharingCreateSharedLink ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingCreateSharedLinkWithSettings = function (arg) {
return this.request('sharing/create_shared_link_with_settings', arg, 'user', 'api', 'rpc', 'sharing.write');
}; | Create a shared link with custom settings. If no settings are given then the
default visibility is RequestedVisibility.public (The resolved visibility,
though, may depend on other aspects such as team and shared folder settings).
Route attributes:
scope: sharing.write
@function Dropbox#sharingCreateSharedLinkWithSettings
@arg {SharingCreateSharedLinkWithSettingsArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<(SharingFileLinkMetadata|SharingFolderLinkMetadata|SharingSharedLinkMetadata)>, DropboxResponseError.<SharingCreateSharedLinkWithSettingsError>>} | routes.sharingCreateSharedLinkWithSettings ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingGetFileMetadata = function (arg) {
return this.request('sharing/get_file_metadata', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Returns shared file metadata.
Route attributes:
scope: sharing.read
@function Dropbox#sharingGetFileMetadata
@arg {SharingGetFileMetadataArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingSharedFileMetadata>, DropboxResponseError.<SharingGetFileMetadataError>>} | routes.sharingGetFileMetadata ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingGetFileMetadataBatch = function (arg) {
return this.request('sharing/get_file_metadata/batch', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Returns shared file metadata.
Route attributes:
scope: sharing.read
@function Dropbox#sharingGetFileMetadataBatch
@arg {SharingGetFileMetadataBatchArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<Array.<SharingGetFileMetadataBatchResult>>, DropboxResponseError.<SharingSharingUserError>>} | routes.sharingGetFileMetadataBatch ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingGetFolderMetadata = function (arg) {
return this.request('sharing/get_folder_metadata', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Returns shared folder metadata by its folder ID.
Route attributes:
scope: sharing.read
@function Dropbox#sharingGetFolderMetadata
@arg {SharingGetMetadataArgs} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingSharedFolderMetadata>, DropboxResponseError.<SharingSharedFolderAccessError>>} | routes.sharingGetFolderMetadata ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingGetSharedLinkFile = function (arg) {
return this.request('sharing/get_shared_link_file', arg, 'user', 'content', 'download', 'sharing.read');
}; | Download the shared link's file from a user's Dropbox.
Route attributes:
scope: sharing.read
@function Dropbox#sharingGetSharedLinkFile
@arg {Object} arg - The request parameters.
@returns {Promise.<DropboxResponse<(SharingFileLinkMetadata|SharingFolderLinkMetadata|SharingSharedLinkMetadata)>, DropboxResponseError.<SharingGetSharedLinkFileError>>} | routes.sharingGetSharedLinkFile ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingGetSharedLinkMetadata = function (arg) {
return this.request('sharing/get_shared_link_metadata', arg, 'app, user', 'api', 'rpc', 'sharing.read');
}; | Get the shared link's metadata.
Route attributes:
scope: sharing.read
@function Dropbox#sharingGetSharedLinkMetadata
@arg {SharingGetSharedLinkMetadataArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<(SharingFileLinkMetadata|SharingFolderLinkMetadata|SharingSharedLinkMetadata)>, DropboxResponseError.<SharingSharedLinkError>>} | routes.sharingGetSharedLinkMetadata ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
routes.sharingGetSharedLinks = function (arg) {
return this.request('sharing/get_shared_links', arg, 'user', 'api', 'rpc', 'sharing.read');
}; | Returns a list of LinkMetadata objects for this user, including collection
links. If no path is given, returns a list of all shared links for the
current user, including collection links, up to a maximum of 1000 links. If a
non-empty path is given, returns a list of all shared links that allow access
to the given path. Collection links are never returned in this case.
Route attributes:
scope: sharing.read
@function Dropbox#sharingGetSharedLinks
@deprecated
@arg {SharingGetSharedLinksArg} arg - The request parameters.
@returns {Promise.<DropboxResponse<SharingGetSharedLinksResult>, DropboxResponseError.<SharingGetSharedLinksError>>} | routes.sharingGetSharedLinks ( arg ) | javascript | dropbox/dropbox-sdk-js | lib/routes.js | https://github.com/dropbox/dropbox-sdk-js/blob/master/lib/routes.js | MIT |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.