dropbox.files – Files

This namespace contains endpoints and data types for basic file operations.

class dropbox.files.AddTagArg(path=None, tag_text=None)

Bases: Struct

Variables:

• files.AddTagArg.path – Path to the item to be tagged.

• files.AddTagArg.tag_text – The value of the tag to add. Will be automatically converted to lowercase letters.

__init__(path=None, tag_text=None)

path

tag_text

class dropbox.files.AddTagError(tag, value=None)

Bases: BaseTagError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

files.AddTagError.too_many_tags – The item already has the maximum supported number of tags.

is_too_many_tags()

Check if the union tag is too_many_tags.

Return type:

bool

too_many_tags = AddTagError('too_many_tags', None)

class dropbox.files.AlphaGetMetadataArg(path=None, include_media_info=None, include_deleted=None, include_has_explicit_shared_members=None, include_property_groups=None, include_property_templates=None)

Bases: GetMetadataArg

Variables:

files.AlphaGetMetadataArg.include_property_templates – If set to a valid list of template IDs, FileMetadata.property_groups is set for files with custom properties.

__init__(path=None, include_media_info=None, include_deleted=None, include_has_explicit_shared_members=None, include_property_groups=None, include_property_templates=None)

include_property_templates

class dropbox.files.AlphaGetMetadataError(tag, value=None)

Bases: GetMetadataError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_properties_error()

Only call this if is_properties_error() is true.

Return type:

file_properties.LookUpPropertiesError

is_properties_error()

Check if the union tag is properties_error.

Return type:

bool

classmethod properties_error(val)

Create an instance of this class set to the properties_error tag with value val.

Parameters:

val (file_properties.LookUpPropertiesError) –

Return type:

AlphaGetMetadataError

class dropbox.files.BaseTagError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_path()

Only call this if is_path() is true.

Return type:

LookupError

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

other = BaseTagError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

BaseTagError

class dropbox.files.CommitInfo(path=None, mode=None, autorename=None, client_modified=None, mute=None, property_groups=None, strict_conflict=None)

Bases: Struct

Variables:

• files.CommitInfo.path – Path in the user’s Dropbox to save the file.

• files.CommitInfo.mode – Selects what to do if the file already exists.

• files.CommitInfo.autorename – If there’s a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.

• files.CommitInfo.client_modified – The value to store as the client_modified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.

• files.CommitInfo.mute – Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If True, this tells the clients that this modification shouldn’t result in a user notification.

• files.CommitInfo.property_groups – List of custom properties to add to file.

• files.CommitInfo.strict_conflict – Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.update and the given “rev” doesn’t match the existing file’s “rev”, even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.

__init__(path=None, mode=None, autorename=None, client_modified=None, mute=None, property_groups=None, strict_conflict=None)

autorename

client_modified

mode

mute

path

property_groups

strict_conflict

class dropbox.files.ContentSyncSetting(id=None, sync_setting=None)

Bases: Struct

Variables:

• files.ContentSyncSetting.id – Id of the item this setting is applied to.

• files.ContentSyncSetting.sync_setting – Setting for this item.

__init__(id=None, sync_setting=None)

id

sync_setting

class dropbox.files.ContentSyncSettingArg(id=None, sync_setting=None)

Bases: Struct

Variables:

• files.ContentSyncSettingArg.id – Id of the item this setting is applied to.

• files.ContentSyncSettingArg.sync_setting – Setting for this item.

__init__(id=None, sync_setting=None)

id

sync_setting

dropbox.files.CopyBatchArg

alias of RelocationBatchArgBase

class dropbox.files.CreateFolderArg(path=None, autorename=None)

Bases: Struct

Variables:

• files.CreateFolderArg.path – Path in the user’s Dropbox to create.

• files.CreateFolderArg.autorename – If there’s a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.

__init__(path=None, autorename=None)

autorename

path

class dropbox.files.CreateFolderBatchArg(paths=None, autorename=None, force_async=None)

Bases: Struct

Variables:

• files.CreateFolderBatchArg.paths – List of paths to be created in the user’s Dropbox. Duplicate path arguments in the batch are considered only once.

• files.CreateFolderBatchArg.autorename – If there’s a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.

• files.CreateFolderBatchArg.force_async – Whether to force the create to happen asynchronously.

__init__(paths=None, autorename=None, force_async=None)

autorename

force_async

paths

class dropbox.files.CreateFolderBatchError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

files.CreateFolderBatchError.too_many_files – The operation would involve too many files or folders.

is_other()

Check if the union tag is other.

Return type:

bool

is_too_many_files()

Check if the union tag is too_many_files.

Return type:

bool

other = CreateFolderBatchError('other', None)

too_many_files = CreateFolderBatchError('too_many_files', None)

class dropbox.files.CreateFolderBatchJobStatus(tag, value=None)

Bases: PollResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• CreateFolderBatchJobStatus.complete (CreateFolderBatchResult) – The batch create folder has finished.

• CreateFolderBatchJobStatus.failed (CreateFolderBatchError) – The batch create folder has failed.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:

val (CreateFolderBatchResult) –

Return type:

CreateFolderBatchJobStatus

classmethod failed(val)

Create an instance of this class set to the failed tag with value val.

Parameters:

val (CreateFolderBatchError) –

Return type:

CreateFolderBatchJobStatus

get_complete()

The batch create folder has finished.

Only call this if is_complete() is true.

Return type:

CreateFolderBatchResult

get_failed()

The batch create folder has failed.

Only call this if is_failed() is true.

Return type:

CreateFolderBatchError

is_complete()

Check if the union tag is complete.

Return type:

bool

is_failed()

Check if the union tag is failed.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

other = CreateFolderBatchJobStatus('other', None)

class dropbox.files.CreateFolderBatchLaunch(tag, value=None)

Bases: LaunchResultBase

Result returned by dropbox.dropbox_client.Dropbox.files_create_folder_batch() that may either launch an asynchronous job or complete synchronously.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:

val (CreateFolderBatchResult) –

Return type:

CreateFolderBatchLaunch

get_complete()

Only call this if is_complete() is true.

Return type:

CreateFolderBatchResult

is_complete()

Check if the union tag is complete.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

other = CreateFolderBatchLaunch('other', None)

class dropbox.files.CreateFolderBatchResult(entries=None)

Bases: FileOpsResult

Variables:

files.CreateFolderBatchResult.entries – Each entry in CreateFolderBatchArg.paths will appear at the same position inside CreateFolderBatchResult.entries.

__init__(entries=None)

entries

class dropbox.files.CreateFolderBatchResultEntry(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod failure(val)

Create an instance of this class set to the failure tag with value val.

Parameters:

val (CreateFolderEntryError) –

Return type:

CreateFolderBatchResultEntry

get_failure()

Only call this if is_failure() is true.

Return type:

CreateFolderEntryError

get_success()

Only call this if is_success() is true.

Return type:

CreateFolderEntryResult

is_failure()

Check if the union tag is failure.

Return type:

bool

is_success()

Check if the union tag is success.

Return type:

bool

classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:

val (CreateFolderEntryResult) –

Return type:

CreateFolderBatchResultEntry

class dropbox.files.CreateFolderEntryError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_path()

Only call this if is_path() is true.

Return type:

WriteError

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

other = CreateFolderEntryError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (WriteError) –

Return type:

CreateFolderEntryError

class dropbox.files.CreateFolderEntryResult(metadata=None)

Bases: Struct

Variables:

files.CreateFolderEntryResult.metadata – Metadata of the created folder.

__init__(metadata=None)

metadata

class dropbox.files.CreateFolderError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_path()

Only call this if is_path() is true.

Return type:

WriteError

is_path()

Check if the union tag is path.

Return type:

bool

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (WriteError) –

Return type:

CreateFolderError

class dropbox.files.CreateFolderResult(metadata=None)

Bases: FileOpsResult

Variables:

files.CreateFolderResult.metadata – Metadata of the created folder.

__init__(metadata=None)

metadata

class dropbox.files.DeleteArg(path=None, parent_rev=None)

Bases: Struct

Variables:

• files.DeleteArg.path – Path in the user’s Dropbox to delete.

• files.DeleteArg.parent_rev – Perform delete if given “rev” matches the existing file’s latest “rev”. This field does not support deleting a folder.

__init__(path=None, parent_rev=None)

parent_rev

path

class dropbox.files.DeleteBatchArg(entries=None)

Bases: Struct

__init__(entries=None)

entries

class dropbox.files.DeleteBatchError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

files.DeleteBatchError.too_many_write_operations – Use DeleteError.too_many_write_operations. dropbox.dropbox_client.Dropbox.files_delete_batch() now provides smaller granularity about which entry has failed because of this.

is_other()

Check if the union tag is other.

Return type:

bool

is_too_many_write_operations()

Check if the union tag is too_many_write_operations.

Return type:

bool

other = DeleteBatchError('other', None)

too_many_write_operations = DeleteBatchError('too_many_write_operations', None)

class dropbox.files.DeleteBatchJobStatus(tag, value=None)

Bases: PollResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• DeleteBatchJobStatus.complete (DeleteBatchResult) – The batch delete has finished.

• DeleteBatchJobStatus.failed (DeleteBatchError) – The batch delete has failed.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:

val (DeleteBatchResult) –

Return type:

DeleteBatchJobStatus

classmethod failed(val)

Create an instance of this class set to the failed tag with value val.

Parameters:

val (DeleteBatchError) –

Return type:

DeleteBatchJobStatus

get_complete()

The batch delete has finished.

Only call this if is_complete() is true.

Return type:

DeleteBatchResult

get_failed()

The batch delete has failed.

Only call this if is_failed() is true.

Return type:

DeleteBatchError

is_complete()

Check if the union tag is complete.

Return type:

bool

is_failed()

Check if the union tag is failed.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

other = DeleteBatchJobStatus('other', None)

class dropbox.files.DeleteBatchLaunch(tag, value=None)

Bases: LaunchResultBase

Result returned by dropbox.dropbox_client.Dropbox.files_delete_batch() that may either launch an asynchronous job or complete synchronously.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:

val (DeleteBatchResult) –

Return type:

DeleteBatchLaunch

get_complete()

Only call this if is_complete() is true.

Return type:

DeleteBatchResult

is_complete()

Check if the union tag is complete.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

other = DeleteBatchLaunch('other', None)

class dropbox.files.DeleteBatchResult(entries=None)

Bases: FileOpsResult

Variables:

files.DeleteBatchResult.entries – Each entry in DeleteBatchArg.entries will appear at the same position inside DeleteBatchResult.entries.

__init__(entries=None)

entries

class dropbox.files.DeleteBatchResultData(metadata=None)

Bases: Struct

Variables:

files.DeleteBatchResultData.metadata – Metadata of the deleted object.

__init__(metadata=None)

metadata

class dropbox.files.DeleteBatchResultEntry(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod failure(val)

Create an instance of this class set to the failure tag with value val.

Parameters:

val (DeleteError) –

Return type:

DeleteBatchResultEntry

get_failure()

Only call this if is_failure() is true.

Return type:

DeleteError

get_success()

Only call this if is_success() is true.

Return type:

DeleteBatchResultData

is_failure()

Check if the union tag is failure.

Return type:

bool

is_success()

Check if the union tag is success.

Return type:

bool

classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:

val (DeleteBatchResultData) –

Return type:

DeleteBatchResultEntry

class dropbox.files.DeleteError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.DeleteError.too_many_write_operations – There are too many write operations in user’s Dropbox. Please retry this request.

• files.DeleteError.too_many_files – There are too many files in one request. Please retry with fewer files.

get_path_lookup()

Only call this if is_path_lookup() is true.

Return type:

LookupError

get_path_write()

Only call this if is_path_write() is true.

Return type:

WriteError

is_other()

Check if the union tag is other.

Return type:

bool

is_path_lookup()

Check if the union tag is path_lookup.

Return type:

bool

is_path_write()

Check if the union tag is path_write.

Return type:

bool

is_too_many_files()

Check if the union tag is too_many_files.

Return type:

bool

is_too_many_write_operations()

Check if the union tag is too_many_write_operations.

Return type:

bool

other = DeleteError('other', None)

classmethod path_lookup(val)

Create an instance of this class set to the path_lookup tag with value val.

Parameters:

val (LookupError) –

Return type:

DeleteError

classmethod path_write(val)

Create an instance of this class set to the path_write tag with value val.

Parameters:

val (WriteError) –

Return type:

DeleteError

too_many_files = DeleteError('too_many_files', None)

too_many_write_operations = DeleteError('too_many_write_operations', None)

class dropbox.files.DeleteResult(metadata=None)

Bases: FileOpsResult

Variables:

files.DeleteResult.metadata – Metadata of the deleted object.

__init__(metadata=None)

metadata

class dropbox.files.DeletedMetadata(name=None, path_lower=None, path_display=None, parent_shared_folder_id=None, preview_url=None)

Bases: Metadata

Indicates that there used to be a file or folder at this path, but it no longer exists.

__init__(name=None, path_lower=None, path_display=None, parent_shared_folder_id=None, preview_url=None)

class dropbox.files.Dimensions(height=None, width=None)

Bases: Struct

Dimensions for a photo or video.

Variables:

• files.Dimensions.height – Height of the photo/video.

• files.Dimensions.width – Width of the photo/video.

__init__(height=None, width=None)

height

width

class dropbox.files.DownloadArg(path=None, rev=None)

Bases: Struct

Variables:

• files.DownloadArg.path – The path of the file to download.

• files.DownloadArg.rev – Please specify revision in path instead.

__init__(path=None, rev=None)

path

rev

class dropbox.files.DownloadError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

files.DownloadError.unsupported_file – This file type cannot be downloaded directly; use dropbox.dropbox_client.Dropbox.files_export() instead.

get_path()

Only call this if is_path() is true.

Return type:

LookupError

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

is_unsupported_file()

Check if the union tag is unsupported_file.

Return type:

bool

other = DownloadError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

DownloadError

unsupported_file = DownloadError('unsupported_file', None)

class dropbox.files.DownloadZipArg(path=None)

Bases: Struct

Variables:

files.DownloadZipArg.path – The path of the folder to download.

__init__(path=None)

path

class dropbox.files.DownloadZipError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.DownloadZipError.too_large – The folder or a file is too large to download.

• files.DownloadZipError.too_many_files – The folder has too many files to download.

get_path()

Only call this if is_path() is true.

Return type:

LookupError

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

is_too_large()

Check if the union tag is too_large.

Return type:

bool

is_too_many_files()

Check if the union tag is too_many_files.

Return type:

bool

other = DownloadZipError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

DownloadZipError

too_large = DownloadZipError('too_large', None)

too_many_files = DownloadZipError('too_many_files', None)

class dropbox.files.DownloadZipResult(metadata=None)

Bases: Struct

__init__(metadata=None)

metadata

class dropbox.files.ExportArg(path=None, export_format=None)

Bases: Struct

Variables:

• files.ExportArg.path – The path of the file to be exported.

• files.ExportArg.export_format – The file format to which the file should be exported. This must be one of the formats listed in the file’s export_options returned by dropbox.dropbox_client.Dropbox.files_get_metadata(). If none is specified, the default format (specified in export_as in file metadata) will be used.

__init__(path=None, export_format=None)

export_format

path

class dropbox.files.ExportError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.ExportError.non_exportable – This file type cannot be exported. Use dropbox.dropbox_client.Dropbox.files_download() instead.

• files.ExportError.invalid_export_format – The specified export format is not a valid option for this file type.

• files.ExportError.retry_error – The exportable content is not yet available. Please retry later.

get_path()

Only call this if is_path() is true.

Return type:

LookupError

invalid_export_format = ExportError('invalid_export_format', None)

is_invalid_export_format()

Check if the union tag is invalid_export_format.

Return type:

bool

is_non_exportable()

Check if the union tag is non_exportable.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

is_retry_error()

Check if the union tag is retry_error.

Return type:

bool

non_exportable = ExportError('non_exportable', None)

other = ExportError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

ExportError

retry_error = ExportError('retry_error', None)

class dropbox.files.ExportInfo(export_as=None, export_options=None)

Bases: Struct

Export information for a file.

Variables:

• files.ExportInfo.export_as – Format to which the file can be exported to.

• files.ExportInfo.export_options – Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export.

__init__(export_as=None, export_options=None)

export_as

export_options

class dropbox.files.ExportMetadata(name=None, size=None, export_hash=None, paper_revision=None)

Bases: Struct

Variables:

• files.ExportMetadata.name – The last component of the path (including extension). This never contains a slash.

• files.ExportMetadata.size – The file size in bytes.

• files.ExportMetadata.export_hash – A hash based on the exported file content. This field can be used to verify data integrity. Similar to content hash. For more information see our Content hash page.

• files.ExportMetadata.paper_revision – If the file is a Paper doc, this gives the latest doc revision which can be used in dropbox.dropbox_client.Dropbox.files_paper_update().

__init__(name=None, size=None, export_hash=None, paper_revision=None)

export_hash

name

paper_revision

size

class dropbox.files.ExportResult(export_metadata=None, file_metadata=None)

Bases: Struct

Variables:

• files.ExportResult.export_metadata – Metadata for the exported version of the file.

• files.ExportResult.file_metadata – Metadata for the original file.

__init__(export_metadata=None, file_metadata=None)

export_metadata

file_metadata

class dropbox.files.FileCategory(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.FileCategory.image – jpg, png, gif, and more.

• files.FileCategory.document – doc, docx, txt, and more.

• files.FileCategory.pdf – pdf.

• files.FileCategory.spreadsheet – xlsx, xls, csv, and more.

• files.FileCategory.presentation – ppt, pptx, key, and more.

• files.FileCategory.audio – mp3, wav, mid, and more.

• files.FileCategory.video – mov, wmv, mp4, and more.

• files.FileCategory.folder – dropbox folder.

• files.FileCategory.paper – dropbox paper doc.

• files.FileCategory.others – any file not in one of the categories above.

audio = FileCategory('audio', None)

document = FileCategory('document', None)

folder = FileCategory('folder', None)

image = FileCategory('image', None)

is_audio()

Check if the union tag is audio.

Return type:

bool

is_document()

Check if the union tag is document.

Return type:

bool

is_folder()

Check if the union tag is folder.

Return type:

bool

is_image()

Check if the union tag is image.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_others()

Check if the union tag is others.

Return type:

bool

is_paper()

Check if the union tag is paper.

Return type:

bool

is_pdf()

Check if the union tag is pdf.

Return type:

bool

is_presentation()

Check if the union tag is presentation.

Return type:

bool

is_spreadsheet()

Check if the union tag is spreadsheet.

Return type:

bool

is_video()

Check if the union tag is video.

Return type:

bool

other = FileCategory('other', None)

others = FileCategory('others', None)

paper = FileCategory('paper', None)

pdf = FileCategory('pdf', None)

presentation = FileCategory('presentation', None)

spreadsheet = FileCategory('spreadsheet', None)

video = FileCategory('video', None)

class dropbox.files.FileLock(content=None)

Bases: Struct

Variables:

files.FileLock.content – The lock description.

__init__(content=None)

content

class dropbox.files.FileLockContent(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.FileLockContent.unlocked – Empty type to indicate no lock.

• FileLockContent.single_user (SingleUserLock) – A lock held by a single user.

get_single_user()

A lock held by a single user.

Only call this if is_single_user() is true.

Return type:

SingleUserLock

is_other()

Check if the union tag is other.

Return type:

bool

is_single_user()

Check if the union tag is single_user.

Return type:

bool

is_unlocked()

Check if the union tag is unlocked.

Return type:

bool

other = FileLockContent('other', None)

classmethod single_user(val)

Create an instance of this class set to the single_user tag with value val.

Parameters:

val (SingleUserLock) –

Return type:

FileLockContent

unlocked = FileLockContent('unlocked', None)

class dropbox.files.FileLockMetadata(is_lockholder=None, lockholder_name=None, lockholder_account_id=None, created=None)

Bases: Struct

Variables:

• files.FileLockMetadata.is_lockholder – True if caller holds the file lock.

• files.FileLockMetadata.lockholder_name – The display name of the lock holder.

• files.FileLockMetadata.lockholder_account_id – The account ID of the lock holder if known.

• files.FileLockMetadata.created – The timestamp of the lock was created.

__init__(is_lockholder=None, lockholder_name=None, lockholder_account_id=None, created=None)

created

is_lockholder

lockholder_account_id

lockholder_name

class dropbox.files.FileMetadata(name=None, id=None, client_modified=None, server_modified=None, rev=None, size=None, path_lower=None, path_display=None, parent_shared_folder_id=None, preview_url=None, media_info=None, symlink_info=None, sharing_info=None, is_downloadable=None, export_info=None, property_groups=None, has_explicit_shared_members=None, content_hash=None, file_lock_info=None)

Bases: Metadata

Variables:

• files.FileMetadata.id – A unique identifier for the file.

• files.FileMetadata.client_modified – For files, this is the modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not.

• files.FileMetadata.server_modified – The last time the file was modified on Dropbox.

• files.FileMetadata.rev – A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts.

• files.FileMetadata.size – The file size in bytes.

• files.FileMetadata.media_info – Additional information if the file is a photo or video. This field will not be set on entries returned by dropbox.dropbox_client.Dropbox.files_list_folder(), dropbox.dropbox_client.Dropbox.files_list_folder_continue(), or dropbox.dropbox_client.Dropbox.files_get_thumbnail_batch(), starting December 2, 2019.

• files.FileMetadata.symlink_info – Set if this file is a symlink.

• files.FileMetadata.sharing_info – Set if this file is contained in a shared folder.

• files.FileMetadata.is_downloadable – If true, file can be downloaded directly; else the file must be exported.

• files.FileMetadata.export_info – Information about format this file can be exported to. This filed must be set if is_downloadable is set to false.

• files.FileMetadata.property_groups – Additional information if the file has custom properties with the property template specified.

• files.FileMetadata.has_explicit_shared_members – This flag will only be present if include_has_explicit_shared_members is true in dropbox.dropbox_client.Dropbox.files_list_folder() or dropbox.dropbox_client.Dropbox.files_get_metadata(). If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder.

• files.FileMetadata.content_hash –

  A hash of the file content. This field can be used to verify data integrity. For more information see our Content hash page.

• files.FileMetadata.file_lock_info – If present, the metadata associated with the file’s current lock.

__init__(name=None, id=None, client_modified=None, server_modified=None, rev=None, size=None, path_lower=None, path_display=None, parent_shared_folder_id=None, preview_url=None, media_info=None, symlink_info=None, sharing_info=None, is_downloadable=None, export_info=None, property_groups=None, has_explicit_shared_members=None, content_hash=None, file_lock_info=None)

client_modified

content_hash

export_info

file_lock_info

has_explicit_shared_members

id

is_downloadable

media_info

property_groups

rev

server_modified

sharing_info

size

symlink_info

class dropbox.files.FileOpsResult

Bases: Struct

__init__()

class dropbox.files.FileSharingInfo(read_only=None, parent_shared_folder_id=None, modified_by=None)

Bases: SharingInfo

Sharing info for a file which is contained by a shared folder.

Variables:

• files.FileSharingInfo.parent_shared_folder_id – ID of shared folder that holds this file.

• files.FileSharingInfo.modified_by – The last user who modified the file. This field will be null if the user’s account has been deleted.

__init__(read_only=None, parent_shared_folder_id=None, modified_by=None)

modified_by

parent_shared_folder_id

class dropbox.files.FileStatus(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

active = FileStatus('active', None)

deleted = FileStatus('deleted', None)

is_active()

Check if the union tag is active.

Return type:

bool

is_deleted()

Check if the union tag is deleted.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

other = FileStatus('other', None)

class dropbox.files.FolderMetadata(name=None, id=None, path_lower=None, path_display=None, parent_shared_folder_id=None, preview_url=None, shared_folder_id=None, sharing_info=None, property_groups=None)

Bases: Metadata

Variables:

• files.FolderMetadata.id – A unique identifier for the folder.

• files.FolderMetadata.shared_folder_id – Please use sharing_info instead.

• files.FolderMetadata.sharing_info – Set if the folder is contained in a shared folder or is a shared folder mount point.

• files.FolderMetadata.property_groups – Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders.

__init__(name=None, id=None, path_lower=None, path_display=None, parent_shared_folder_id=None, preview_url=None, shared_folder_id=None, sharing_info=None, property_groups=None)

id

property_groups

shared_folder_id

sharing_info

class dropbox.files.FolderSharingInfo(read_only=None, parent_shared_folder_id=None, shared_folder_id=None, traverse_only=None, no_access=None)

Bases: SharingInfo

Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.

Variables:

• files.FolderSharingInfo.parent_shared_folder_id – Set if the folder is contained by a shared folder.

• files.FolderSharingInfo.shared_folder_id – If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.

• files.FolderSharingInfo.traverse_only – Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don’t have read access to this folder. They do, however, have access to some sub folder.

• files.FolderSharingInfo.no_access – Specifies that the folder cannot be accessed by the user.

__init__(read_only=None, parent_shared_folder_id=None, shared_folder_id=None, traverse_only=None, no_access=None)

no_access

parent_shared_folder_id

shared_folder_id

traverse_only

class dropbox.files.GetCopyReferenceArg(path=None)

Bases: Struct

Variables:

files.GetCopyReferenceArg.path – The path to the file or folder you want to get a copy reference to.

__init__(path=None)

path

class dropbox.files.GetCopyReferenceError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_path()

Only call this if is_path() is true.

Return type:

LookupError

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

other = GetCopyReferenceError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

GetCopyReferenceError

class dropbox.files.GetCopyReferenceResult(metadata=None, copy_reference=None, expires=None)

Bases: Struct

Variables:

• files.GetCopyReferenceResult.metadata – Metadata of the file or folder.

• files.GetCopyReferenceResult.copy_reference – A copy reference to the file or folder.

• files.GetCopyReferenceResult.expires – The expiration date of the copy reference. This value is currently set to be far enough in the future so that expiration is effectively not an issue.

__init__(metadata=None, copy_reference=None, expires=None)

copy_reference

expires

metadata

class dropbox.files.GetMetadataArg(path=None, include_media_info=None, include_deleted=None, include_has_explicit_shared_members=None, include_property_groups=None)

Bases: Struct

Variables:

• files.GetMetadataArg.path – The path of a file or folder on Dropbox.

• files.GetMetadataArg.include_media_info – If true, FileMetadata.media_info is set for photo and video.

• files.GetMetadataArg.include_deleted – If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be returned.

• files.GetMetadataArg.include_has_explicit_shared_members – If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

• files.GetMetadataArg.include_property_groups – If set to a valid list of template IDs, FileMetadata.property_groups is set if there exists property data associated with the file and each of the listed templates.

__init__(path=None, include_media_info=None, include_deleted=None, include_has_explicit_shared_members=None, include_property_groups=None)

include_deleted

include_has_explicit_shared_members

include_media_info

include_property_groups

path

class dropbox.files.GetMetadataError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_path()

Only call this if is_path() is true.

Return type:

LookupError

is_path()

Check if the union tag is path.

Return type:

bool

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

GetMetadataError

class dropbox.files.GetTagsArg(paths=None)

Bases: Struct

Variables:

files.GetTagsArg.paths – Path to the items.

__init__(paths=None)

paths

class dropbox.files.GetTagsResult(paths_to_tags=None)

Bases: Struct

Variables:

files.GetTagsResult.paths_to_tags – List of paths and their corresponding tags.

__init__(paths_to_tags=None)

paths_to_tags

class dropbox.files.GetTemporaryLinkArg(path=None)

Bases: Struct

Variables:

files.GetTemporaryLinkArg.path – The path to the file you want a temporary link to.

__init__(path=None)

path

class dropbox.files.GetTemporaryLinkError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.GetTemporaryLinkError.email_not_verified – This user’s email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here.

• files.GetTemporaryLinkError.unsupported_file – Cannot get temporary link to this file type; use dropbox.dropbox_client.Dropbox.files_export() instead.

• files.GetTemporaryLinkError.not_allowed – The user is not allowed to request a temporary link to the specified file. For example, this can occur if the file is restricted or if the user’s links are banned.

email_not_verified = GetTemporaryLinkError('email_not_verified', None)

get_path()

Only call this if is_path() is true.

Return type:

LookupError

is_email_not_verified()

Check if the union tag is email_not_verified.

Return type:

bool

is_not_allowed()

Check if the union tag is not_allowed.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

is_unsupported_file()

Check if the union tag is unsupported_file.

Return type:

bool

not_allowed = GetTemporaryLinkError('not_allowed', None)

other = GetTemporaryLinkError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

GetTemporaryLinkError

unsupported_file = GetTemporaryLinkError('unsupported_file', None)

class dropbox.files.GetTemporaryLinkResult(metadata=None, link=None)

Bases: Struct

Variables:

• files.GetTemporaryLinkResult.metadata – Metadata of the file.

• files.GetTemporaryLinkResult.link – The temporary link which can be used to stream content the file.

__init__(metadata=None, link=None)

link

metadata

class dropbox.files.GetTemporaryUploadLinkArg(commit_info=None, duration=None)

Bases: Struct

Variables:

• files.GetTemporaryUploadLinkArg.commit_info – Contains the path and other optional modifiers for the future upload commit. Equivalent to the parameters provided to dropbox.dropbox_client.Dropbox.files_upload().

• files.GetTemporaryUploadLinkArg.duration – How long before this link expires, in seconds. Attempting to start an upload with this link longer than this period of time after link creation will result in an error.

__init__(commit_info=None, duration=None)

commit_info

duration

class dropbox.files.GetTemporaryUploadLinkResult(link=None)

Bases: Struct

Variables:

files.GetTemporaryUploadLinkResult.link – The temporary link which can be used to stream a file to a Dropbox location.

__init__(link=None)

link

class dropbox.files.GetThumbnailBatchArg(entries=None)

Bases: Struct

Arguments for dropbox.dropbox_client.Dropbox.files_get_thumbnail_batch().

Variables:

files.GetThumbnailBatchArg.entries – List of files to get thumbnails.

__init__(entries=None)

entries

class dropbox.files.GetThumbnailBatchError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

files.GetThumbnailBatchError.too_many_files – The operation involves more than 25 files.

is_other()

Check if the union tag is other.

Return type:

bool

is_too_many_files()

Check if the union tag is too_many_files.

Return type:

bool

other = GetThumbnailBatchError('other', None)

too_many_files = GetThumbnailBatchError('too_many_files', None)

class dropbox.files.GetThumbnailBatchResult(entries=None)

Bases: Struct

Variables:

files.GetThumbnailBatchResult.entries – List of files and their thumbnails.

__init__(entries=None)

entries

class dropbox.files.GetThumbnailBatchResultData(metadata=None, thumbnail=None)

Bases: Struct

Variables:

files.GetThumbnailBatchResultData.thumbnail – A string containing the base64-encoded thumbnail data for this file.

__init__(metadata=None, thumbnail=None)

metadata

thumbnail

class dropbox.files.GetThumbnailBatchResultEntry(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

GetThumbnailBatchResultEntry.failure (ThumbnailError) – The result for this file if it was an error.

classmethod failure(val)

Create an instance of this class set to the failure tag with value val.

Parameters:

val (ThumbnailError) –

Return type:

GetThumbnailBatchResultEntry

get_failure()

The result for this file if it was an error.

Only call this if is_failure() is true.

Return type:

ThumbnailError

get_success()

Only call this if is_success() is true.

Return type:

GetThumbnailBatchResultData

is_failure()

Check if the union tag is failure.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_success()

Check if the union tag is success.

Return type:

bool

other = GetThumbnailBatchResultEntry('other', None)

classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:

val (GetThumbnailBatchResultData) –

Return type:

GetThumbnailBatchResultEntry

class dropbox.files.GpsCoordinates(latitude=None, longitude=None)

Bases: Struct

GPS coordinates for a photo or video.

Variables:

• files.GpsCoordinates.latitude – Latitude of the GPS coordinates.

• files.GpsCoordinates.longitude – Longitude of the GPS coordinates.

__init__(latitude=None, longitude=None)

latitude

longitude

class dropbox.files.HighlightSpan(highlight_str=None, is_highlighted=None)

Bases: Struct

Variables:

• files.HighlightSpan.highlight_str – String to be determined whether it should be highlighted or not.

• files.HighlightSpan.is_highlighted – The string should be highlighted or not.

__init__(highlight_str=None, is_highlighted=None)

highlight_str

is_highlighted

class dropbox.files.ImportFormat(tag, value=None)

Bases: Union

The import format of the incoming Paper doc content.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.ImportFormat.html – The provided data is interpreted as standard HTML.

• files.ImportFormat.markdown – The provided data is interpreted as markdown.

• files.ImportFormat.plain_text – The provided data is interpreted as plain text.

html = ImportFormat('html', None)

is_html()

Check if the union tag is html.

Return type:

bool

is_markdown()

Check if the union tag is markdown.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_plain_text()

Check if the union tag is plain_text.

Return type:

bool

markdown = ImportFormat('markdown', None)

other = ImportFormat('other', None)

plain_text = ImportFormat('plain_text', None)

class dropbox.files.ListFolderArg(path=None, recursive=None, include_media_info=None, include_deleted=None, include_has_explicit_shared_members=None, include_mounted_folders=None, limit=None, shared_link=None, include_property_groups=None, include_non_downloadable_files=None)

Bases: Struct

Variables:

• files.ListFolderArg.path – A unique identifier for the file.

• files.ListFolderArg.recursive – If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.

• files.ListFolderArg.include_media_info – If true, FileMetadata.media_info is set for photo and video. This parameter will no longer have an effect starting December 2, 2019.

• files.ListFolderArg.include_deleted – If true, the results will include entries for files and folders that used to exist but were deleted.

• files.ListFolderArg.include_has_explicit_shared_members – If true, the results will include a flag for each file indicating whether or not that file has any explicit members.

• files.ListFolderArg.include_mounted_folders – If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.

• files.ListFolderArg.limit – The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.

• files.ListFolderArg.shared_link – A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, ListFolderArg.path will be relative to root of the shared link. Only non-recursive mode is supported for shared link.

• files.ListFolderArg.include_property_groups – If set to a valid list of template IDs, FileMetadata.property_groups is set if there exists property data associated with the file and each of the listed templates.

• files.ListFolderArg.include_non_downloadable_files – If true, include files that are not downloadable, i.e. Google Docs.

__init__(path=None, recursive=None, include_media_info=None, include_deleted=None, include_has_explicit_shared_members=None, include_mounted_folders=None, limit=None, shared_link=None, include_property_groups=None, include_non_downloadable_files=None)

include_deleted

include_has_explicit_shared_members

include_media_info

include_mounted_folders

include_non_downloadable_files

include_property_groups

limit

path

recursive

shared_link

class dropbox.files.ListFolderContinueArg(cursor=None)

Bases: Struct

Variables:

files.ListFolderContinueArg.cursor – The cursor returned by your last call to dropbox.dropbox_client.Dropbox.files_list_folder() or dropbox.dropbox_client.Dropbox.files_list_folder_continue().

__init__(cursor=None)

cursor

class dropbox.files.ListFolderContinueError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

files.ListFolderContinueError.reset – Indicates that the cursor has been invalidated. Call dropbox.dropbox_client.Dropbox.files_list_folder() to obtain a new cursor.

get_path()

Only call this if is_path() is true.

Return type:

LookupError

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

is_reset()

Check if the union tag is reset.

Return type:

bool

other = ListFolderContinueError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

ListFolderContinueError

reset = ListFolderContinueError('reset', None)

class dropbox.files.ListFolderError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_path()

Only call this if is_path() is true.

Return type:

LookupError

get_template_error()

Only call this if is_template_error() is true.

Return type:

file_properties.TemplateError

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

is_template_error()

Check if the union tag is template_error.

Return type:

bool

other = ListFolderError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

ListFolderError

classmethod template_error(val)

Create an instance of this class set to the template_error tag with value val.

Parameters:

val (file_properties.TemplateError) –

Return type:

ListFolderError

class dropbox.files.ListFolderGetLatestCursorResult(cursor=None)

Bases: Struct

Variables:

files.ListFolderGetLatestCursorResult.cursor – Pass the cursor into dropbox.dropbox_client.Dropbox.files_list_folder_continue() to see what’s changed in the folder since your previous query.

__init__(cursor=None)

cursor

class dropbox.files.ListFolderLongpollArg(cursor=None, timeout=None)

Bases: Struct

Variables:

• files.ListFolderLongpollArg.cursor – A cursor as returned by dropbox.dropbox_client.Dropbox.files_list_folder() or dropbox.dropbox_client.Dropbox.files_list_folder_continue(). Cursors retrieved by setting ListFolderArg.include_media_info to True are not supported.

• files.ListFolderLongpollArg.timeout – A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts.

__init__(cursor=None, timeout=None)

cursor

timeout

class dropbox.files.ListFolderLongpollError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

files.ListFolderLongpollError.reset – Indicates that the cursor has been invalidated. Call dropbox.dropbox_client.Dropbox.files_list_folder() to obtain a new cursor.

is_other()

Check if the union tag is other.

Return type:

bool

is_reset()

Check if the union tag is reset.

Return type:

bool

other = ListFolderLongpollError('other', None)

reset = ListFolderLongpollError('reset', None)

class dropbox.files.ListFolderLongpollResult(changes=None, backoff=None)

Bases: Struct

Variables:

• files.ListFolderLongpollResult.changes – Indicates whether new changes are available. If true, call dropbox.dropbox_client.Dropbox.files_list_folder_continue() to retrieve the changes.

• files.ListFolderLongpollResult.backoff – If present, backoff for at least this many seconds before calling dropbox.dropbox_client.Dropbox.files_list_folder_longpoll() again.

__init__(changes=None, backoff=None)

backoff

changes

class dropbox.files.ListFolderResult(entries=None, cursor=None, has_more=None)

Bases: Struct

Variables:

• files.ListFolderResult.entries – The files and (direct) subfolders in the folder.

• files.ListFolderResult.cursor – Pass the cursor into dropbox.dropbox_client.Dropbox.files_list_folder_continue() to see what’s changed in the folder since your previous query.

• files.ListFolderResult.has_more – If true, then there are more entries available. Pass the cursor to dropbox.dropbox_client.Dropbox.files_list_folder_continue() to retrieve the rest.

__init__(entries=None, cursor=None, has_more=None)

cursor

entries

has_more

class dropbox.files.ListRevisionsArg(path=None, mode=None, limit=None)

Bases: Struct

Variables:

• files.ListRevisionsArg.path – The path to the file you want to see the revisions of.

• files.ListRevisionsArg.mode – Determines the behavior of the API in listing the revisions for a given file path or id.

• files.ListRevisionsArg.limit – The maximum number of revision entries returned.

__init__(path=None, mode=None, limit=None)

limit

mode

path

class dropbox.files.ListRevisionsError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_path()

Only call this if is_path() is true.

Return type:

LookupError

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

other = ListRevisionsError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

ListRevisionsError

class dropbox.files.ListRevisionsMode(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.ListRevisionsMode.path – Returns revisions with the same file path as identified by the latest file entry at the given file path or id.

• files.ListRevisionsMode.id – Returns revisions with the same file id as identified by the latest file entry at the given file path or id.

id = ListRevisionsMode('id', None)

is_id()

Check if the union tag is id.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

other = ListRevisionsMode('other', None)

path = ListRevisionsMode('path', None)

class dropbox.files.ListRevisionsResult(is_deleted=None, entries=None, server_deleted=None)

Bases: Struct

Variables:

• files.ListRevisionsResult.is_deleted – If the file identified by the latest revision in the response is either deleted or moved.

• files.ListRevisionsResult.server_deleted – The time of deletion if the file was deleted.

• files.ListRevisionsResult.entries – The revisions for the file. Only revisions that are not deleted will show up here.

__init__(is_deleted=None, entries=None, server_deleted=None)

entries

is_deleted

server_deleted

class dropbox.files.LockConflictError(lock=None)

Bases: Struct

Variables:

files.LockConflictError.lock – The lock that caused the conflict.

__init__(lock=None)

lock

class dropbox.files.LockFileArg(path=None)

Bases: Struct

Variables:

files.LockFileArg.path – Path in the user’s Dropbox to a file.

__init__(path=None)

path

class dropbox.files.LockFileBatchArg(entries=None)

Bases: Struct

Variables:

files.LockFileBatchArg.entries – List of ‘entries’. Each ‘entry’ contains a path of the file which will be locked or queried. Duplicate path arguments in the batch are considered only once.

__init__(entries=None)

entries

class dropbox.files.LockFileBatchResult(entries=None)

Bases: FileOpsResult

Variables:

files.LockFileBatchResult.entries – Each Entry in the ‘entries’ will have ‘.tag’ with the operation status (e.g. success), the metadata for the file and the lock state after the operation.

__init__(entries=None)

entries

class dropbox.files.LockFileError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• LockFileError.path_lookup (LookupError) – Could not find the specified resource.

• files.LockFileError.too_many_write_operations – There are too many write operations in user’s Dropbox. Please retry this request.

• files.LockFileError.too_many_files – There are too many files in one request. Please retry with fewer files.

• files.LockFileError.no_write_permission – The user does not have permissions to change the lock state or access the file.

• files.LockFileError.cannot_be_locked – Item is a type that cannot be locked.

• files.LockFileError.file_not_shared – Requested file is not currently shared.

• LockFileError.lock_conflict (LockConflictError) – The user action conflicts with an existing lock on the file.

• files.LockFileError.internal_error – Something went wrong with the job on Dropbox’s end. You’ll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

cannot_be_locked = LockFileError('cannot_be_locked', None)

file_not_shared = LockFileError('file_not_shared', None)

get_lock_conflict()

The user action conflicts with an existing lock on the file.

Only call this if is_lock_conflict() is true.

Return type:

LockConflictError

get_path_lookup()

Could not find the specified resource.

Only call this if is_path_lookup() is true.

Return type:

LookupError

internal_error = LockFileError('internal_error', None)

is_cannot_be_locked()

Check if the union tag is cannot_be_locked.

Return type:

bool

is_file_not_shared()

Check if the union tag is file_not_shared.

Return type:

bool

is_internal_error()

Check if the union tag is internal_error.

Return type:

bool

is_lock_conflict()

Check if the union tag is lock_conflict.

Return type:

bool

is_no_write_permission()

Check if the union tag is no_write_permission.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_path_lookup()

Check if the union tag is path_lookup.

Return type:

bool

is_too_many_files()

Check if the union tag is too_many_files.

Return type:

bool

is_too_many_write_operations()

Check if the union tag is too_many_write_operations.

Return type:

bool

classmethod lock_conflict(val)

Create an instance of this class set to the lock_conflict tag with value val.

Parameters:

val (LockConflictError) –

Return type:

LockFileError

no_write_permission = LockFileError('no_write_permission', None)

other = LockFileError('other', None)

classmethod path_lookup(val)

Create an instance of this class set to the path_lookup tag with value val.

Parameters:

val (LookupError) –

Return type:

LockFileError

too_many_files = LockFileError('too_many_files', None)

too_many_write_operations = LockFileError('too_many_write_operations', None)

class dropbox.files.LockFileResult(metadata=None, lock=None)

Bases: Struct

Variables:

• files.LockFileResult.metadata – Metadata of the file.

• files.LockFileResult.lock – The file lock state after the operation.

__init__(metadata=None, lock=None)

lock

metadata

class dropbox.files.LockFileResultEntry(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod failure(val)

Create an instance of this class set to the failure tag with value val.

Parameters:

val (LockFileError) –

Return type:

LockFileResultEntry

get_failure()

Only call this if is_failure() is true.

Return type:

LockFileError

get_success()

Only call this if is_success() is true.

Return type:

LockFileResult

is_failure()

Check if the union tag is failure.

Return type:

bool

is_success()

Check if the union tag is success.

Return type:

bool

classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:

val (LockFileResult) –

Return type:

LockFileResultEntry

class dropbox.files.LookupError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.LookupError.malformed_path (Optional[str]) – The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information.

• files.LookupError.not_found – There is nothing at the given path.

• files.LookupError.not_file – We were expecting a file, but the given path refers to something that isn’t a file.

• files.LookupError.not_folder – We were expecting a folder, but the given path refers to something that isn’t a folder.

• files.LookupError.restricted_content – The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements.

• files.LookupError.unsupported_content_type – This operation is not supported for this content type.

• files.LookupError.locked – The given path is locked.

get_malformed_path()

The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.

Only call this if is_malformed_path() is true.

Return type:

Optional[str]

is_locked()

Check if the union tag is locked.

Return type:

bool

is_malformed_path()

Check if the union tag is malformed_path.

Return type:

bool

is_not_file()

Check if the union tag is not_file.

Return type:

bool

is_not_folder()

Check if the union tag is not_folder.

Return type:

bool

is_not_found()

Check if the union tag is not_found.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_restricted_content()

Check if the union tag is restricted_content.

Return type:

bool

is_unsupported_content_type()

Check if the union tag is unsupported_content_type.

Return type:

bool

locked = LookupError('locked', None)

classmethod malformed_path(val)

Create an instance of this class set to the malformed_path tag with value val.

Parameters:

val (Optional[str]) –

Return type:

LookupError

not_file = LookupError('not_file', None)

not_folder = LookupError('not_folder', None)

not_found = LookupError('not_found', None)

other = LookupError('other', None)

restricted_content = LookupError('restricted_content', None)

unsupported_content_type = LookupError('unsupported_content_type', None)

class dropbox.files.MediaInfo(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.MediaInfo.pending – Indicate the photo/video is still under processing and metadata is not available yet.

• MediaInfo.metadata (MediaMetadata) – The metadata for the photo/video.

get_metadata()

The metadata for the photo/video.

Only call this if is_metadata() is true.

Return type:

MediaMetadata

is_metadata()

Check if the union tag is metadata.

Return type:

bool

is_pending()

Check if the union tag is pending.

Return type:

bool

classmethod metadata(val)

Create an instance of this class set to the metadata tag with value val.

Parameters:

val (MediaMetadata) –

Return type:

MediaInfo

pending = MediaInfo('pending', None)

class dropbox.files.MediaMetadata(dimensions=None, location=None, time_taken=None)

Bases: Struct

Metadata for a photo or video.

Variables:

• files.MediaMetadata.dimensions – Dimension of the photo/video.

• files.MediaMetadata.location – The GPS coordinate of the photo/video.

• files.MediaMetadata.time_taken – The timestamp when the photo/video is taken.

__init__(dimensions=None, location=None, time_taken=None)

dimensions

location

time_taken

class dropbox.files.Metadata(name=None, path_lower=None, path_display=None, parent_shared_folder_id=None, preview_url=None)

Bases: Struct

Metadata for a file or folder.

Variables:

• files.Metadata.name – The last component of the path (including extension). This never contains a slash.

• files.Metadata.path_lower – The lowercased full path in the user’s Dropbox. This always starts with a slash. This field will be null if the file or folder is not mounted.

• files.Metadata.path_display – The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user’s filesystem, but this behavior will match the path provided in the Core API v1, and at least the last path component will have the correct casing. Changes to only the casing of paths won’t be returned by dropbox.dropbox_client.Dropbox.files_list_folder_continue(). This field will be null if the file or folder is not mounted.

• files.Metadata.parent_shared_folder_id – Please use FileSharingInfo.parent_shared_folder_id or FolderSharingInfo.parent_shared_folder_id instead.

• files.Metadata.preview_url – The preview URL of the file.

__init__(name=None, path_lower=None, path_display=None, parent_shared_folder_id=None, preview_url=None)

name

parent_shared_folder_id

path_display

path_lower

preview_url

class dropbox.files.MetadataV2(tag, value=None)

Bases: Union

Metadata for a file, folder or other resource types.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_metadata()

Only call this if is_metadata() is true.

Return type:

Metadata

is_metadata()

Check if the union tag is metadata.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

classmethod metadata(val)

Create an instance of this class set to the metadata tag with value val.

Parameters:

val (Metadata) –

Return type:

MetadataV2

other = MetadataV2('other', None)

class dropbox.files.MinimalFileLinkMetadata(url=None, rev=None, id=None, path=None)

Bases: Struct

Variables:

• files.MinimalFileLinkMetadata.url – URL of the shared link.

• files.MinimalFileLinkMetadata.id – Unique identifier for the linked file.

• files.MinimalFileLinkMetadata.path – Full path in the user’s Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user’s Dropbox.

• files.MinimalFileLinkMetadata.rev – A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts.

__init__(url=None, rev=None, id=None, path=None)

id

path

rev

url

class dropbox.files.MoveBatchArg(entries=None, autorename=None, allow_ownership_transfer=None)

Bases: RelocationBatchArgBase

Variables:

files.MoveBatchArg.allow_ownership_transfer – Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

__init__(entries=None, autorename=None, allow_ownership_transfer=None)

allow_ownership_transfer

class dropbox.files.MoveIntoFamilyError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

files.MoveIntoFamilyError.is_shared_folder – Moving shared folder into Family Room folder is not allowed.

is_is_shared_folder()

Check if the union tag is is_shared_folder.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_shared_folder = MoveIntoFamilyError('is_shared_folder', None)

other = MoveIntoFamilyError('other', None)

class dropbox.files.MoveIntoVaultError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

files.MoveIntoVaultError.is_shared_folder – Moving shared folder into Vault is not allowed.

is_is_shared_folder()

Check if the union tag is is_shared_folder.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_shared_folder = MoveIntoVaultError('is_shared_folder', None)

other = MoveIntoVaultError('other', None)

class dropbox.files.PaperContentError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.PaperContentError.insufficient_permissions – Your account does not have permissions to edit Paper docs.

• files.PaperContentError.content_malformed – The provided content was malformed and cannot be imported to Paper.

• files.PaperContentError.doc_length_exceeded – The Paper doc would be too large, split the content into multiple docs.

• files.PaperContentError.image_size_exceeded – The imported document contains an image that is too large. The current limit is 1MB. This only applies to HTML with data URI.

content_malformed = PaperContentError('content_malformed', None)

doc_length_exceeded = PaperContentError('doc_length_exceeded', None)

image_size_exceeded = PaperContentError('image_size_exceeded', None)

insufficient_permissions = PaperContentError('insufficient_permissions', None)

is_content_malformed()

Check if the union tag is content_malformed.

Return type:

bool

is_doc_length_exceeded()

Check if the union tag is doc_length_exceeded.

Return type:

bool

is_image_size_exceeded()

Check if the union tag is image_size_exceeded.

Return type:

bool

is_insufficient_permissions()

Check if the union tag is insufficient_permissions.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

other = PaperContentError('other', None)

class dropbox.files.PaperCreateArg(path=None, import_format=None)

Bases: Struct

Variables:

• files.PaperCreateArg.path – The fully qualified path to the location in the user’s Dropbox where the Paper Doc should be created. This should include the document’s title and end with .paper.

• files.PaperCreateArg.import_format – The format of the provided data.

__init__(path=None, import_format=None)

import_format

path

class dropbox.files.PaperCreateError(tag, value=None)

Bases: PaperContentError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.PaperCreateError.invalid_path – The file could not be saved to the specified location.

• files.PaperCreateError.email_unverified – The user’s email must be verified to create Paper docs.

• files.PaperCreateError.invalid_file_extension – The file path must end in .paper.

• files.PaperCreateError.paper_disabled – Paper is disabled for your team.

email_unverified = PaperCreateError('email_unverified', None)

invalid_file_extension = PaperCreateError('invalid_file_extension', None)

invalid_path = PaperCreateError('invalid_path', None)

is_email_unverified()

Check if the union tag is email_unverified.

Return type:

bool

is_invalid_file_extension()

Check if the union tag is invalid_file_extension.

Return type:

bool

is_invalid_path()

Check if the union tag is invalid_path.

Return type:

bool

is_paper_disabled()

Check if the union tag is paper_disabled.

Return type:

bool

paper_disabled = PaperCreateError('paper_disabled', None)

class dropbox.files.PaperCreateResult(url=None, result_path=None, file_id=None, paper_revision=None)

Bases: Struct

Variables:

• files.PaperCreateResult.url – URL to open the Paper Doc.

• files.PaperCreateResult.result_path – The fully qualified path the Paper Doc was actually created at.

• files.PaperCreateResult.file_id – The id to use in Dropbox APIs when referencing the Paper Doc.

• files.PaperCreateResult.paper_revision – The current doc revision.

__init__(url=None, result_path=None, file_id=None, paper_revision=None)

file_id

paper_revision

result_path

url

class dropbox.files.PaperDocUpdatePolicy(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.PaperDocUpdatePolicy.update – Sets the doc content to the provided content if the provided paper_revision matches the latest doc revision. Otherwise, returns an error.

• files.PaperDocUpdatePolicy.overwrite – Sets the doc content to the provided content without checking paper_revision.

• files.PaperDocUpdatePolicy.prepend – Adds the provided content to the beginning of the doc without checking paper_revision.

• files.PaperDocUpdatePolicy.append – Adds the provided content to the end of the doc without checking paper_revision.

append = PaperDocUpdatePolicy('append', None)

is_append()

Check if the union tag is append.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_overwrite()

Check if the union tag is overwrite.

Return type:

bool

is_prepend()

Check if the union tag is prepend.

Return type:

bool

is_update()

Check if the union tag is update.

Return type:

bool

other = PaperDocUpdatePolicy('other', None)

overwrite = PaperDocUpdatePolicy('overwrite', None)

prepend = PaperDocUpdatePolicy('prepend', None)

update = PaperDocUpdatePolicy('update', None)

class dropbox.files.PaperUpdateArg(path=None, import_format=None, doc_update_policy=None, paper_revision=None)

Bases: Struct

Variables:

• files.PaperUpdateArg.path – Path in the user’s Dropbox to update. The path must correspond to a Paper doc or an error will be returned.

• files.PaperUpdateArg.import_format – The format of the provided data.

• files.PaperUpdateArg.doc_update_policy – How the provided content should be applied to the doc.

• files.PaperUpdateArg.paper_revision – The latest doc revision. Required when doc_update_policy is update. This value must match the current revision of the doc or error revision_mismatch will be returned.

__init__(path=None, import_format=None, doc_update_policy=None, paper_revision=None)

doc_update_policy

import_format

paper_revision

path

class dropbox.files.PaperUpdateError(tag, value=None)

Bases: PaperContentError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.PaperUpdateError.revision_mismatch – The provided revision does not match the document head.

• files.PaperUpdateError.doc_archived – This operation is not allowed on archived Paper docs.

• files.PaperUpdateError.doc_deleted – This operation is not allowed on deleted Paper docs.

doc_archived = PaperUpdateError('doc_archived', None)

doc_deleted = PaperUpdateError('doc_deleted', None)

get_path()

Only call this if is_path() is true.

Return type:

LookupError

is_doc_archived()

Check if the union tag is doc_archived.

Return type:

bool

is_doc_deleted()

Check if the union tag is doc_deleted.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

is_revision_mismatch()

Check if the union tag is revision_mismatch.

Return type:

bool

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

PaperUpdateError

revision_mismatch = PaperUpdateError('revision_mismatch', None)

class dropbox.files.PaperUpdateResult(paper_revision=None)

Bases: Struct

Variables:

files.PaperUpdateResult.paper_revision – The current doc revision.

__init__(paper_revision=None)

paper_revision

class dropbox.files.PathOrLink(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

get_link()

Only call this if is_link() is true.

Return type:

SharedLinkFileInfo

get_path()

Only call this if is_path() is true.

Return type:

str

is_link()

Check if the union tag is link.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

classmethod link(val)

Create an instance of this class set to the link tag with value val.

Parameters:

val (SharedLinkFileInfo) –

Return type:

PathOrLink

other = PathOrLink('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (str) –

Return type:

PathOrLink

class dropbox.files.PathToTags(path=None, tags=None)

Bases: Struct

Variables:

• files.PathToTags.path – Path of the item.

• files.PathToTags.tags – Tags assigned to this item.

__init__(path=None, tags=None)

path

tags

class dropbox.files.PhotoMetadata(dimensions=None, location=None, time_taken=None)

Bases: MediaMetadata

Metadata for a photo.

__init__(dimensions=None, location=None, time_taken=None)

class dropbox.files.PreviewArg(path=None, rev=None)

Bases: Struct

Variables:

• files.PreviewArg.path – The path of the file to preview.

• files.PreviewArg.rev – Please specify revision in path instead.

__init__(path=None, rev=None)

path

rev

class dropbox.files.PreviewError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• PreviewError.path (LookupError) – An error occurs when downloading metadata for the file.

• files.PreviewError.in_progress – This preview generation is still in progress and the file is not ready for preview yet.

• files.PreviewError.unsupported_extension – The file extension is not supported preview generation.

• files.PreviewError.unsupported_content – The file content is not supported for preview generation.

get_path()

An error occurs when downloading metadata for the file.

Only call this if is_path() is true.

Return type:

LookupError

in_progress = PreviewError('in_progress', None)

is_in_progress()

Check if the union tag is in_progress.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

is_unsupported_content()

Check if the union tag is unsupported_content.

Return type:

bool

is_unsupported_extension()

Check if the union tag is unsupported_extension.

Return type:

bool

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

PreviewError

unsupported_content = PreviewError('unsupported_content', None)

unsupported_extension = PreviewError('unsupported_extension', None)

class dropbox.files.PreviewResult(file_metadata=None, link_metadata=None)

Bases: Struct

Variables:

• files.PreviewResult.file_metadata – Metadata corresponding to the file received as an argument. Will be populated if the endpoint is called with a path (ReadPath).

• files.PreviewResult.link_metadata – Minimal metadata corresponding to the file received as an argument. Will be populated if the endpoint is called using a shared link (SharedLinkFileInfo).

__init__(file_metadata=None, link_metadata=None)

file_metadata

link_metadata

class dropbox.files.RelocationArg(from_path=None, to_path=None, allow_shared_folder=None, autorename=None, allow_ownership_transfer=None)

Bases: RelocationPath

Variables:

• files.RelocationArg.allow_shared_folder – This flag has no effect.

• files.RelocationArg.autorename – If there’s a conflict, have the Dropbox server try to autorename the file to avoid the conflict.

• files.RelocationArg.allow_ownership_transfer – Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

__init__(from_path=None, to_path=None, allow_shared_folder=None, autorename=None, allow_ownership_transfer=None)

allow_ownership_transfer

allow_shared_folder

autorename

class dropbox.files.RelocationBatchArg(entries=None, autorename=None, allow_shared_folder=None, allow_ownership_transfer=None)

Bases: RelocationBatchArgBase

Variables:

• files.RelocationBatchArg.allow_shared_folder – This flag has no effect.

• files.RelocationBatchArg.allow_ownership_transfer – Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

__init__(entries=None, autorename=None, allow_shared_folder=None, allow_ownership_transfer=None)

allow_ownership_transfer

allow_shared_folder

class dropbox.files.RelocationBatchArgBase(entries=None, autorename=None)

Bases: Struct

Variables:

• files.RelocationBatchArgBase.entries – List of entries to be moved or copied. Each entry is RelocationPath.

• files.RelocationBatchArgBase.autorename – If there’s a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.

__init__(entries=None, autorename=None)

autorename

entries

class dropbox.files.RelocationBatchError(tag, value=None)

Bases: RelocationError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

files.RelocationBatchError.too_many_write_operations – There are too many write operations in user’s Dropbox. Please retry this request.

is_too_many_write_operations()

Check if the union tag is too_many_write_operations.

Return type:

bool

too_many_write_operations = RelocationBatchError('too_many_write_operations', None)

class dropbox.files.RelocationBatchErrorEntry(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• RelocationBatchErrorEntry.relocation_error (RelocationError) – User errors that retry won’t help.

• files.RelocationBatchErrorEntry.internal_error – Something went wrong with the job on Dropbox’s end. You’ll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

• files.RelocationBatchErrorEntry.too_many_write_operations – There are too many write operations in user’s Dropbox. Please retry this request.

get_relocation_error()

User errors that retry won’t help.

Only call this if is_relocation_error() is true.

Return type:

RelocationError

internal_error = RelocationBatchErrorEntry('internal_error', None)

is_internal_error()

Check if the union tag is internal_error.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_relocation_error()

Check if the union tag is relocation_error.

Return type:

bool

is_too_many_write_operations()

Check if the union tag is too_many_write_operations.

Return type:

bool

other = RelocationBatchErrorEntry('other', None)

classmethod relocation_error(val)

Create an instance of this class set to the relocation_error tag with value val.

Parameters:

val (RelocationError) –

Return type:

RelocationBatchErrorEntry

too_many_write_operations = RelocationBatchErrorEntry('too_many_write_operations', None)

class dropbox.files.RelocationBatchJobStatus(tag, value=None)

Bases: PollResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• RelocationBatchJobStatus.complete (RelocationBatchResult) – The copy or move batch job has finished.

• RelocationBatchJobStatus.failed (RelocationBatchError) – The copy or move batch job has failed with exception.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:

val (RelocationBatchResult) –

Return type:

RelocationBatchJobStatus

classmethod failed(val)

Create an instance of this class set to the failed tag with value val.

Parameters:

val (RelocationBatchError) –

Return type:

RelocationBatchJobStatus

get_complete()

The copy or move batch job has finished.

Only call this if is_complete() is true.

Return type:

RelocationBatchResult

get_failed()

The copy or move batch job has failed with exception.

Only call this if is_failed() is true.

Return type:

RelocationBatchError

is_complete()

Check if the union tag is complete.

Return type:

bool

is_failed()

Check if the union tag is failed.

Return type:

bool

class dropbox.files.RelocationBatchLaunch(tag, value=None)

Bases: LaunchResultBase

Result returned by dropbox.dropbox_client.Dropbox.files_copy_batch() or dropbox.dropbox_client.Dropbox.files_move_batch() that may either launch an asynchronous job or complete synchronously.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:

val (RelocationBatchResult) –

Return type:

RelocationBatchLaunch

get_complete()

Only call this if is_complete() is true.

Return type:

RelocationBatchResult

is_complete()

Check if the union tag is complete.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

other = RelocationBatchLaunch('other', None)

class dropbox.files.RelocationBatchResult(entries=None)

Bases: FileOpsResult

__init__(entries=None)

entries

class dropbox.files.RelocationBatchResultData(metadata=None)

Bases: Struct

Variables:

files.RelocationBatchResultData.metadata – Metadata of the relocated object.

__init__(metadata=None)

metadata

class dropbox.files.RelocationBatchResultEntry(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod failure(val)

Create an instance of this class set to the failure tag with value val.

Parameters:

val (RelocationBatchErrorEntry) –

Return type:

RelocationBatchResultEntry

get_failure()

Only call this if is_failure() is true.

Return type:

RelocationBatchErrorEntry

get_success()

Only call this if is_success() is true.

Return type:

Metadata

is_failure()

Check if the union tag is failure.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_success()

Check if the union tag is success.

Return type:

bool

other = RelocationBatchResultEntry('other', None)

classmethod success(val)

Create an instance of this class set to the success tag with value val.

Parameters:

val (Metadata) –

Return type:

RelocationBatchResultEntry

class dropbox.files.RelocationBatchV2JobStatus(tag, value=None)

Bases: PollResultBase

Result returned by dropbox.dropbox_client.Dropbox.files_copy_batch_check() or dropbox.dropbox_client.Dropbox.files_move_batch_check() that may either be in progress or completed with result for each entry.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

RelocationBatchV2JobStatus.complete (RelocationBatchV2Result) – The copy or move batch job has finished.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:

val (RelocationBatchV2Result) –

Return type:

RelocationBatchV2JobStatus

get_complete()

The copy or move batch job has finished.

Only call this if is_complete() is true.

Return type:

RelocationBatchV2Result

is_complete()

Check if the union tag is complete.

Return type:

bool

class dropbox.files.RelocationBatchV2Launch(tag, value=None)

Bases: LaunchResultBase

Result returned by dropbox.dropbox_client.Dropbox.files_copy_batch() or dropbox.dropbox_client.Dropbox.files_move_batch() that may either launch an asynchronous job or complete synchronously.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:

val (RelocationBatchV2Result) –

Return type:

RelocationBatchV2Launch

get_complete()

Only call this if is_complete() is true.

Return type:

RelocationBatchV2Result

is_complete()

Check if the union tag is complete.

Return type:

bool

class dropbox.files.RelocationBatchV2Result(entries=None)

Bases: FileOpsResult

Variables:

files.RelocationBatchV2Result.entries – Each entry in CopyBatchArg.entries or MoveBatchArg.entries will appear at the same position inside RelocationBatchV2Result.entries.

__init__(entries=None)

entries

class dropbox.files.RelocationError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.RelocationError.cant_copy_shared_folder – Shared folders can’t be copied.

• files.RelocationError.cant_nest_shared_folder – Your move operation would result in nested shared folders. This is not allowed.

• files.RelocationError.cant_move_folder_into_itself – You cannot move a folder into itself.

• files.RelocationError.too_many_files – The operation would involve more than 10,000 files and folders.

• files.RelocationError.duplicated_or_nested_paths – There are duplicated/nested paths among RelocationArg.from_path and RelocationArg.to_path.

• files.RelocationError.cant_transfer_ownership – Your move operation would result in an ownership transfer. You may reissue the request with the field RelocationArg.allow_ownership_transfer to true.

• files.RelocationError.insufficient_quota – The current user does not have enough space to move or copy the files.

• files.RelocationError.internal_error – Something went wrong with the job on Dropbox’s end. You’ll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

• files.RelocationError.cant_move_shared_folder – Can’t move the shared folder to the given destination.

• RelocationError.cant_move_into_vault (MoveIntoVaultError) – Some content cannot be moved into Vault under certain circumstances, see detailed error.

• RelocationError.cant_move_into_family (MoveIntoFamilyError) – Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.

cant_copy_shared_folder = RelocationError('cant_copy_shared_folder', None)

cant_move_folder_into_itself = RelocationError('cant_move_folder_into_itself', None)

classmethod cant_move_into_family(val)

Create an instance of this class set to the cant_move_into_family tag with value val.

Parameters:

val (MoveIntoFamilyError) –

Return type:

RelocationError

classmethod cant_move_into_vault(val)

Create an instance of this class set to the cant_move_into_vault tag with value val.

Parameters:

val (MoveIntoVaultError) –

Return type:

RelocationError

cant_move_shared_folder = RelocationError('cant_move_shared_folder', None)

cant_nest_shared_folder = RelocationError('cant_nest_shared_folder', None)

cant_transfer_ownership = RelocationError('cant_transfer_ownership', None)

duplicated_or_nested_paths = RelocationError('duplicated_or_nested_paths', None)

classmethod from_lookup(val)

Create an instance of this class set to the from_lookup tag with value val.

Parameters:

val (LookupError) –

Return type:

RelocationError

classmethod from_write(val)

Create an instance of this class set to the from_write tag with value val.

Parameters:

val (WriteError) –

Return type:

RelocationError

get_cant_move_into_family()

Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.

Only call this if is_cant_move_into_family() is true.

Return type:

MoveIntoFamilyError

get_cant_move_into_vault()

Some content cannot be moved into Vault under certain circumstances, see detailed error.

Only call this if is_cant_move_into_vault() is true.

Return type:

MoveIntoVaultError

get_from_lookup()

Only call this if is_from_lookup() is true.

Return type:

LookupError

get_from_write()

Only call this if is_from_write() is true.

Return type:

WriteError

get_to()

Only call this if is_to() is true.

Return type:

WriteError

insufficient_quota = RelocationError('insufficient_quota', None)

internal_error = RelocationError('internal_error', None)

is_cant_copy_shared_folder()

Check if the union tag is cant_copy_shared_folder.

Return type:

bool

is_cant_move_folder_into_itself()

Check if the union tag is cant_move_folder_into_itself.

Return type:

bool

is_cant_move_into_family()

Check if the union tag is cant_move_into_family.

Return type:

bool

is_cant_move_into_vault()

Check if the union tag is cant_move_into_vault.

Return type:

bool

is_cant_move_shared_folder()

Check if the union tag is cant_move_shared_folder.

Return type:

bool

is_cant_nest_shared_folder()

Check if the union tag is cant_nest_shared_folder.

Return type:

bool

is_cant_transfer_ownership()

Check if the union tag is cant_transfer_ownership.

Return type:

bool

is_duplicated_or_nested_paths()

Check if the union tag is duplicated_or_nested_paths.

Return type:

bool

is_from_lookup()

Check if the union tag is from_lookup.

Return type:

bool

is_from_write()

Check if the union tag is from_write.

Return type:

bool

is_insufficient_quota()

Check if the union tag is insufficient_quota.

Return type:

bool

is_internal_error()

Check if the union tag is internal_error.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_to()

Check if the union tag is to.

Return type:

bool

is_too_many_files()

Check if the union tag is too_many_files.

Return type:

bool

other = RelocationError('other', None)

classmethod to(val)

Create an instance of this class set to the to tag with value val.

Parameters:

val (WriteError) –

Return type:

RelocationError

too_many_files = RelocationError('too_many_files', None)

class dropbox.files.RelocationPath(from_path=None, to_path=None)

Bases: Struct

Variables:

• files.RelocationPath.from_path – Path in the user’s Dropbox to be copied or moved.

• files.RelocationPath.to_path – Path in the user’s Dropbox that is the destination.

__init__(from_path=None, to_path=None)

from_path

to_path

class dropbox.files.RelocationResult(metadata=None)

Bases: FileOpsResult

Variables:

files.RelocationResult.metadata – Metadata of the relocated object.

__init__(metadata=None)

metadata

class dropbox.files.RemoveTagArg(path=None, tag_text=None)

Bases: Struct

Variables:

• files.RemoveTagArg.path – Path to the item to tag.

• files.RemoveTagArg.tag_text – The tag to remove. Will be automatically converted to lowercase letters.

__init__(path=None, tag_text=None)

path

tag_text

class dropbox.files.RemoveTagError(tag, value=None)

Bases: BaseTagError

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

files.RemoveTagError.tag_not_present – That tag doesn’t exist at this path.

is_tag_not_present()

Check if the union tag is tag_not_present.

Return type:

bool

tag_not_present = RemoveTagError('tag_not_present', None)

class dropbox.files.RestoreArg(path=None, rev=None)

Bases: Struct

Variables:

• files.RestoreArg.path – The path to save the restored file.

• files.RestoreArg.rev – The revision to restore.

__init__(path=None, rev=None)

path

rev

class dropbox.files.RestoreError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• RestoreError.path_lookup (LookupError) – An error occurs when downloading metadata for the file.

• RestoreError.path_write (WriteError) – An error occurs when trying to restore the file to that path.

• files.RestoreError.invalid_revision – The revision is invalid. It may not exist or may point to a deleted file.

• files.RestoreError.in_progress – The restore is currently executing, but has not yet completed.

get_path_lookup()

An error occurs when downloading metadata for the file.

Only call this if is_path_lookup() is true.

Return type:

LookupError

get_path_write()

An error occurs when trying to restore the file to that path.

Only call this if is_path_write() is true.

Return type:

WriteError

in_progress = RestoreError('in_progress', None)

invalid_revision = RestoreError('invalid_revision', None)

is_in_progress()

Check if the union tag is in_progress.

Return type:

bool

is_invalid_revision()

Check if the union tag is invalid_revision.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_path_lookup()

Check if the union tag is path_lookup.

Return type:

bool

is_path_write()

Check if the union tag is path_write.

Return type:

bool

other = RestoreError('other', None)

classmethod path_lookup(val)

Create an instance of this class set to the path_lookup tag with value val.

Parameters:

val (LookupError) –

Return type:

RestoreError

classmethod path_write(val)

Create an instance of this class set to the path_write tag with value val.

Parameters:

val (WriteError) –

Return type:

RestoreError

class dropbox.files.SaveCopyReferenceArg(copy_reference=None, path=None)

Bases: Struct

Variables:

• files.SaveCopyReferenceArg.copy_reference – A copy reference returned by dropbox.dropbox_client.Dropbox.files_copy_reference_get().

• files.SaveCopyReferenceArg.path – Path in the user’s Dropbox that is the destination.

__init__(copy_reference=None, path=None)

copy_reference

path

class dropbox.files.SaveCopyReferenceError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.SaveCopyReferenceError.invalid_copy_reference – The copy reference is invalid.

• files.SaveCopyReferenceError.no_permission – You don’t have permission to save the given copy reference. Please make sure this app is same app which created the copy reference and the source user is still linked to the app.

• files.SaveCopyReferenceError.not_found – The file referenced by the copy reference cannot be found.

• files.SaveCopyReferenceError.too_many_files – The operation would involve more than 10,000 files and folders.

get_path()

Only call this if is_path() is true.

Return type:

WriteError

invalid_copy_reference = SaveCopyReferenceError('invalid_copy_reference', None)

is_invalid_copy_reference()

Check if the union tag is invalid_copy_reference.

Return type:

bool

is_no_permission()

Check if the union tag is no_permission.

Return type:

bool

is_not_found()

Check if the union tag is not_found.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

is_too_many_files()

Check if the union tag is too_many_files.

Return type:

bool

no_permission = SaveCopyReferenceError('no_permission', None)

not_found = SaveCopyReferenceError('not_found', None)

other = SaveCopyReferenceError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (WriteError) –

Return type:

SaveCopyReferenceError

too_many_files = SaveCopyReferenceError('too_many_files', None)

class dropbox.files.SaveCopyReferenceResult(metadata=None)

Bases: Struct

Variables:

files.SaveCopyReferenceResult.metadata – The metadata of the saved file or folder in the user’s Dropbox.

__init__(metadata=None)

metadata

class dropbox.files.SaveUrlArg(path=None, url=None)

Bases: Struct

Variables:

• files.SaveUrlArg.path – The path in Dropbox where the URL will be saved to.

• files.SaveUrlArg.url – The URL to be saved.

__init__(path=None, url=None)

path

url

class dropbox.files.SaveUrlError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.SaveUrlError.download_failed – Failed downloading the given URL. The URL may be password-protected and the password provided was incorrect, or the link may be disabled.

• files.SaveUrlError.invalid_url – The given URL is invalid.

• files.SaveUrlError.not_found – The file where the URL is saved to no longer exists.

download_failed = SaveUrlError('download_failed', None)

get_path()

Only call this if is_path() is true.

Return type:

WriteError

invalid_url = SaveUrlError('invalid_url', None)

is_download_failed()

Check if the union tag is download_failed.

Return type:

bool

is_invalid_url()

Check if the union tag is invalid_url.

Return type:

bool

is_not_found()

Check if the union tag is not_found.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

not_found = SaveUrlError('not_found', None)

other = SaveUrlError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (WriteError) –

Return type:

SaveUrlError

class dropbox.files.SaveUrlJobStatus(tag, value=None)

Bases: PollResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

SaveUrlJobStatus.complete (FileMetadata) – Metadata of the file where the URL is saved to.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:

val (FileMetadata) –

Return type:

SaveUrlJobStatus

classmethod failed(val)

Create an instance of this class set to the failed tag with value val.

Parameters:

val (SaveUrlError) –

Return type:

SaveUrlJobStatus

get_complete()

Metadata of the file where the URL is saved to.

Only call this if is_complete() is true.

Return type:

FileMetadata

get_failed()

Only call this if is_failed() is true.

Return type:

SaveUrlError

is_complete()

Check if the union tag is complete.

Return type:

bool

is_failed()

Check if the union tag is failed.

Return type:

bool

class dropbox.files.SaveUrlResult(tag, value=None)

Bases: LaunchResultBase

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

SaveUrlResult.complete (FileMetadata) – Metadata of the file where the URL is saved to.

classmethod complete(val)

Create an instance of this class set to the complete tag with value val.

Parameters:

val (FileMetadata) –

Return type:

SaveUrlResult

get_complete()

Metadata of the file where the URL is saved to.

Only call this if is_complete() is true.

Return type:

FileMetadata

is_complete()

Check if the union tag is complete.

Return type:

bool

class dropbox.files.SearchArg(path=None, query=None, start=None, max_results=None, mode=None)

Bases: Struct

Variables:

• files.SearchArg.path – The path in the user’s Dropbox to search. Should probably be a folder.

• files.SearchArg.query – The string to search for. Query string may be rewritten to improve relevance of results. The string is split on spaces into multiple tokens. For file name searching, the last token is used for prefix matching (i.e. “bat c” matches “bat cave” but not “batman car”).

• files.SearchArg.start – The starting index within the search results (used for paging).

• files.SearchArg.max_results – The maximum number of search results to return.

• files.SearchArg.mode – The search mode (filename, filename_and_content, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts.

__init__(path=None, query=None, start=None, max_results=None, mode=None)

max_results

mode

path

query

start

class dropbox.files.SearchError(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

files.SearchError.internal_error – Something went wrong, please try again.

get_invalid_argument()

Only call this if is_invalid_argument() is true.

Return type:

str

get_path()

Only call this if is_path() is true.

Return type:

LookupError

internal_error = SearchError('internal_error', None)

classmethod invalid_argument(val)

Create an instance of this class set to the invalid_argument tag with value val.

Parameters:

val (str) –

Return type:

SearchError

is_internal_error()

Check if the union tag is internal_error.

Return type:

bool

is_invalid_argument()

Check if the union tag is invalid_argument.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_path()

Check if the union tag is path.

Return type:

bool

other = SearchError('other', None)

classmethod path(val)

Create an instance of this class set to the path tag with value val.

Parameters:

val (LookupError) –

Return type:

SearchError

class dropbox.files.SearchMatch(match_type=None, metadata=None)

Bases: Struct

Variables:

• files.SearchMatch.match_type – The type of the match.

• files.SearchMatch.metadata – The metadata for the matched file or folder.

__init__(match_type=None, metadata=None)

match_type

metadata

class dropbox.files.SearchMatchFieldOptions(include_highlights=None)

Bases: Struct

Variables:

files.SearchMatchFieldOptions.include_highlights – Whether to include highlight span from file title.

__init__(include_highlights=None)

include_highlights

class dropbox.files.SearchMatchType(tag, value=None)

Bases: Union

Indicates what type of match was found for a given item.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.SearchMatchType.filename – This item was matched on its file or folder name.

• files.SearchMatchType.content – This item was matched based on its file contents.

• files.SearchMatchType.both – This item was matched based on both its contents and its file name.

both = SearchMatchType('both', None)

content = SearchMatchType('content', None)

filename = SearchMatchType('filename', None)

is_both()

Check if the union tag is both.

Return type:

bool

is_content()

Check if the union tag is content.

Return type:

bool

is_filename()

Check if the union tag is filename.

Return type:

bool

class dropbox.files.SearchMatchTypeV2(tag, value=None)

Bases: Union

Indicates what type of match was found for a given item.

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.SearchMatchTypeV2.filename – This item was matched on its file or folder name.

• files.SearchMatchTypeV2.file_content – This item was matched based on its file contents.

• files.SearchMatchTypeV2.filename_and_content – This item was matched based on both its contents and its file name.

• files.SearchMatchTypeV2.image_content – This item was matched on image content.

file_content = SearchMatchTypeV2('file_content', None)

filename = SearchMatchTypeV2('filename', None)

filename_and_content = SearchMatchTypeV2('filename_and_content', None)

image_content = SearchMatchTypeV2('image_content', None)

is_file_content()

Check if the union tag is file_content.

Return type:

bool

is_filename()

Check if the union tag is filename.

Return type:

bool

is_filename_and_content()

Check if the union tag is filename_and_content.

Return type:

bool

is_image_content()

Check if the union tag is image_content.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

other = SearchMatchTypeV2('other', None)

class dropbox.files.SearchMatchV2(metadata=None, match_type=None, highlight_spans=None)

Bases: Struct

Variables:

• files.SearchMatchV2.metadata – The metadata for the matched file or folder.

• files.SearchMatchV2.match_type – The type of the match.

• files.SearchMatchV2.highlight_spans – The list of HighlightSpan determines which parts of the file title should be highlighted.

__init__(metadata=None, match_type=None, highlight_spans=None)

highlight_spans

match_type

metadata

class dropbox.files.SearchMode(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

Variables:

• files.SearchMode.filename – Search file and folder names.

• files.SearchMode.filename_and_content – Search file and folder names as well as file contents.

• files.SearchMode.deleted_filename – Search for deleted file and folder names.

deleted_filename = SearchMode('deleted_filename', None)

filename = SearchMode('filename', None)

filename_and_content = SearchMode('filename_and_content', None)

is_deleted_filename()

Check if the union tag is deleted_filename.

Return type:

bool

is_filename()

Check if the union tag is filename.

Return type:

bool

is_filename_and_content()

Check if the union tag is filename_and_content.

Return type:

bool

class dropbox.files.SearchOptions(path=None, max_results=None, order_by=None, file_status=None, filename_only=None, file_extensions=None, file_categories=None, account_id=None)

Bases: Struct

Variables:

• files.SearchOptions.path – Scopes the search to a path in the user’s Dropbox. Searches the entire Dropbox if not specified.

• files.SearchOptions.max_results – The maximum number of search results to return.

• files.SearchOptions.order_by – Specified property of the order of search results. By default, results are sorted by relevance.

• files.SearchOptions.file_status – Restricts search to the given file status.

• files.SearchOptions.filename_only – Restricts search to only match on filenames.

• files.SearchOptions.file_extensions – Restricts search to only the extensions specified. Only supported for active file search.

• files.SearchOptions.file_categories – Restricts search to only the file categories specified. Only supported for active file search.

• files.SearchOptions.account_id – Restricts results to the given account id.

__init__(path=None, max_results=None, order_by=None, file_status=None, filename_only=None, file_extensions=None, file_categories=None, account_id=None)

account_id

file_categories

file_extensions

file_status

filename_only

max_results

order_by

path

class dropbox.files.SearchOrderBy(tag, value=None)

Bases: Union

This class acts as a tagged union. Only one of the is_* methods will return true. To get the associated value of a tag (if one exists), use the corresponding get_* method.

is_last_modified_time()

Check if the union tag is last_modified_time.

Return type:

bool

is_other()

Check if the union tag is other.

Return type:

bool

is_relevance()

Check if the union tag is relevance.

Return type:

bool

last_modified_time = SearchOrderBy('last_modified_time', None)

other = SearchOrderBy('other', None)

relevance = SearchOrderBy('relevance', None)

class dropbox.files.SearchResult(matches=None, more=None, start=None)

Bases: Struct

Variables:

• files.SearchResult.matches – A list (possibly empty) of matches for the query.

• files.SearchResult.more – Used for paging. If true, indicates there is another page of results available that can be fetched by calling dropbox.dropbox_client.Dropbox.files_search() again.

• files.SearchResult.start – Used for paging. Value to set the start argument to when calling dropbox.dropbox_client.Dropbox.files_search() to fetch the next page of results.

__init__(matches=None, more=None, start=None)

matches

more

start

class dropbox.files.SearchV2Arg(query=None, options=None, match_field_options=None, include_highlights=None)

Bases: Struct

Variables:

• files.SearchV2Arg.query – The string to search for. May match across multiple fields based on the request arguments.

• files.SearchV2Arg.options – Options for more targeted search results.

• files.SearchV2Arg.match_field_options – Options for search results match fields.

• files.SearchV2Arg.include_highlights – Deprecated and moved this option to SearchMatchFieldOptions.

__init__(query=None, options=None, match_field_options=None, include_highlights=None)

include_highlights

match_field_options