Available on crate feature
dbx_files only.Expand description
This namespace contains endpoints and data types for basic file operations.
Structs§
- AddTag
Arg - Alpha
GetMetadata Arg - Commit
Info - Content
Sync Setting - Content
Sync Setting Arg - Create
Folder Arg - Create
Folder Batch Arg - Create
Folder Batch Result - Create
Folder Entry Result - Create
Folder Result - Delete
Arg - Delete
Batch Arg - Delete
Batch Result - Delete
Batch Result Data - Delete
Result - Deleted
Metadata - Indicates that there used to be a file or folder at this path, but it no longer exists.
- Dimensions
- Dimensions for a photo or video.
- Download
Arg - Download
ZipArg - Download
ZipResult - Export
Arg - Export
Info - Export information for a file.
- Export
Metadata - Export
Result - File
Lock - File
Lock Metadata - File
Metadata - File
OpsResult - File
Sharing Info - Sharing info for a file which is contained by a shared folder.
- Folder
Metadata - Folder
Sharing Info - Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.
- GetCopy
Reference Arg - GetCopy
Reference Result - GetMetadata
Arg - GetTags
Arg - GetTags
Result - GetTemporary
Link Arg - GetTemporary
Link Result - GetTemporary
Upload Link Arg - GetTemporary
Upload Link Result - GetThumbnail
Batch Arg - Arguments for
get_thumbnail_batch(). - GetThumbnail
Batch Result - GetThumbnail
Batch Result Data - GpsCoordinates
- GPS coordinates for a photo or video.
- Highlight
Span - List
Folder Arg - List
Folder Continue Arg - List
Folder GetLatest Cursor Result - List
Folder Longpoll Arg - List
Folder Longpoll Result - List
Folder Result - List
Revisions Arg - List
Revisions Result - Lock
Conflict Error - Lock
File Arg - Lock
File Batch Arg - Lock
File Batch Result - Lock
File Result - Minimal
File Link Metadata - Move
Batch Arg - Paper
Create Arg - Paper
Create Result - Paper
Update Arg - Paper
Update Result - Path
ToTags - Photo
Metadata - Metadata for a photo.
- Preview
Arg - Preview
Result - Relocation
Arg - Relocation
Batch Arg - Relocation
Batch ArgBase - Relocation
Batch Result - Relocation
Batch Result Data - Relocation
Batch V2Result - Relocation
Path - Relocation
Result - Remove
TagArg - Restore
Arg - Save
Copy Reference Arg - Save
Copy Reference Result - Save
UrlArg - Search
Arg - Search
Match - Search
Match Field Options - Search
Match V2 - Search
Options - Search
Result - Search
V2Arg - Search
V2Continue Arg - Search
V2Result - Shared
Link - Shared
Link File Info - Sharing
Info - Sharing info for a file or folder.
- Single
User Lock - Symlink
Info - Thumbnail
Arg - Thumbnail
V2Arg - Unlock
File Arg - Unlock
File Batch Arg - Upload
Arg - Upload
Session Append Arg - Upload
Session Cursor - Upload
Session Finish Arg - Upload
Session Finish Batch Arg - Upload
Session Finish Batch Result - Upload
Session Offset Error - Upload
Session Start Arg - Upload
Session Start Batch Arg - Upload
Session Start Batch Result - Upload
Session Start Result - Upload
Write Failed - User
Generated Tag - Video
Metadata - Metadata for a video.
Enums§
- AddTag
Error - Alpha
GetMetadata Error - Base
TagError - Create
Folder Batch Error - Create
Folder Batch JobStatus - Create
Folder Batch Launch - Result returned by
create_folder_batch()that may either launch an asynchronous job or complete synchronously. - Create
Folder Batch Result Entry - Create
Folder Entry Error - Create
Folder Error - Delete
Batch Error - Delete
Batch JobStatus - Delete
Batch Launch - Result returned by
delete_batch()that may either launch an asynchronous job or complete synchronously. - Delete
Batch Result Entry - Delete
Error - Download
Error - Download
ZipError - Export
Error - File
Category - File
Lock Content - File
Status - GetCopy
Reference Error - GetMetadata
Error - GetTemporary
Link Error - GetThumbnail
Batch Error - GetThumbnail
Batch Result Entry - Import
Format - The import format of the incoming Paper doc content.
- List
Folder Continue Error - List
Folder Error - List
Folder Longpoll Error - List
Revisions Error - List
Revisions Mode - Lock
File Error - Lock
File Result Entry - Lookup
Error - Media
Info - Media
Metadata - Metadata for a photo or video.
- Metadata
- Metadata for a file or folder.
- Metadata
V2 - Metadata for a file, folder or other resource types.
- Move
Into Family Error - Move
Into Vault Error - Paper
Content Error - Paper
Create Error - Paper
DocUpdate Policy - Paper
Update Error - Path
OrLink - Preview
Error - Relocation
Batch Error - Relocation
Batch Error Entry - Relocation
Batch JobStatus - Relocation
Batch Launch - Result returned by
copy_batch()ormove_batch()that may either launch an asynchronous job or complete synchronously. - Relocation
Batch Result Entry - Relocation
Batch V2Job Status - Result returned by
copy_batch_check_v2()ormove_batch_check_v2()that may either be in progress or completed with result for each entry. - Relocation
Batch V2Launch - Result returned by
copy_batch_v2()ormove_batch_v2()that may either launch an asynchronous job or complete synchronously. - Relocation
Error - Remove
TagError - Restore
Error - Save
Copy Reference Error - Save
UrlError - Save
UrlJob Status - Save
UrlResult - Search
Error - Search
Match Type - Indicates what type of match was found for a given item.
- Search
Match Type V2 - Indicates what type of match was found for a given item.
- Search
Mode - Search
Order By - Sync
Setting - Sync
Setting Arg - Sync
Settings Error - Tag
- Tag that can be added in multiple ways.
- Thumbnail
Error - Thumbnail
Format - Thumbnail
Mode - Thumbnail
Size - Thumbnail
V2Error - Upload
Error - Upload
Session Append Error - Upload
Session Finish Batch JobStatus - Upload
Session Finish Batch Launch - Result returned by
upload_session_finish_batch()that may either launch an asynchronous job or complete synchronously. - Upload
Session Finish Batch Result Entry - Upload
Session Finish Error - Upload
Session Lookup Error - Upload
Session Start Error - Upload
Session Type - Write
Conflict Error - Write
Error - Write
Mode - Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is. In some situations, the conflict behavior is identical: (a) If the target path doesn’t refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it’s always a conflict. (c) If the target path refers to a file with identical contents, nothing gets written; no conflict. The conflict checking differs in the case where there’s a file at the target path with contents different from the contents you’re trying to write.