dropbox.files – Files

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

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: dropbox.files.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: dropbox.files.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.CommitInfo(path=None, mode=None, autorename=None, client_modified=None, mute=None, property_groups=None, strict_conflict=None)

Bases: stone.backends.python_rsrc.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: dropbox.files.CommitInfo

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

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(id=None, sync_setting=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(id=None, sync_setting=None)

x.__init__(…) initializes x; see help(type(x)) for signature

id
sync_setting
dropbox.files.CopyBatchArg

alias of dropbox.files.RelocationBatchArgBase

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(path=None, autorename=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

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

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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(u'other', None)
too_many_files = CreateFolderBatchError(u'too_many_files', None)
class dropbox.files.CreateFolderBatchJobStatus(tag, value=None)

Bases: dropbox.async_.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:
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(u'other', None)
class dropbox.files.CreateFolderBatchLaunch(tag, value=None)

Bases: dropbox.async_.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(u'other', None)
class dropbox.files.CreateFolderBatchResult(entries=None)

Bases: dropbox.files.FileOpsResult

Variables:files.CreateFolderBatchResult.entries – Each entry in CreateFolderBatchArg.paths will appear at the same position inside CreateFolderBatchResult.entries.
__init__(entries=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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: stone.backends.python_rsrc.stone_base.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(u'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: stone.backends.python_rsrc.stone_base.Struct

Variables:files.CreateFolderEntryResult.metadata – Metadata of the created folder.
__init__(metadata=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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: dropbox.files.FileOpsResult

Variables:files.CreateFolderResult.metadata – Metadata of the created folder.
__init__(metadata=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(path=None, parent_rev=None)

x.__init__(…) initializes x; see help(type(x)) for signature

parent_rev
path
class dropbox.files.DeleteBatchArg(entries=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(entries=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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(u'other', None)
too_many_write_operations = DeleteBatchError(u'too_many_write_operations', None)
class dropbox.files.DeleteBatchJobStatus(tag, value=None)

Bases: dropbox.async_.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:
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(u'other', None)
class dropbox.files.DeleteBatchLaunch(tag, value=None)

Bases: dropbox.async_.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(u'other', None)
class dropbox.files.DeleteBatchResult(entries=None)

Bases: dropbox.files.FileOpsResult

Variables:files.DeleteBatchResult.entries – Each entry in DeleteBatchArg.entries will appear at the same position inside DeleteBatchResult.entries.
__init__(entries=None)

x.__init__(…) initializes x; see help(type(x)) for signature

entries
class dropbox.files.DeleteBatchResultData(metadata=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.DeleteBatchResultData.metadata – Metadata of the deleted object.
__init__(metadata=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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: stone.backends.python_rsrc.stone_base.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:
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(u'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(u'too_many_files', None)
too_many_write_operations = DeleteError(u'too_many_write_operations', None)
class dropbox.files.DeleteResult(metadata=None)

Bases: dropbox.files.FileOpsResult

Variables:files.DeleteResult.metadata – Metadata of the deleted object.
__init__(metadata=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: dropbox.files.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Dimensions for a photo or video.

Variables:
__init__(height=None, width=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(path=None, rev=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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(u'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(u'unsupported_file', None)
class dropbox.files.DownloadZipArg(path=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.DownloadZipArg.path – The path of the folder to download.
__init__(path=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
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(u'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(u'too_large', None)
too_many_files = DownloadZipError(u'too_many_files', None)
class dropbox.files.DownloadZipResult(metadata=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__(metadata=None)

x.__init__(…) initializes x; see help(type(x)) for signature

metadata
class dropbox.files.ExportArg(path=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.ExportArg.path – The path of the file to be exported.
__init__(path=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
get_path()

Only call this if is_path() is true.

Return type:LookupError
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(u'non_exportable', None)
other = ExportError(u'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(u'retry_error', None)
class dropbox.files.ExportInfo(export_as=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Export information for a file.

Variables:files.ExportInfo.export_as – Format to which the file can be exported to.
__init__(export_as=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(name=None, size=None, export_hash=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(export_metadata=None, file_metadata=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
audio = FileCategory(u'audio', None)
document = FileCategory(u'document', None)
folder = FileCategory(u'folder', None)
image = FileCategory(u'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(u'other', None)
others = FileCategory(u'others', None)
paper = FileCategory(u'paper', None)
pdf = FileCategory(u'pdf', None)
presentation = FileCategory(u'presentation', None)
spreadsheet = FileCategory(u'spreadsheet', None)
video = FileCategory(u'video', None)
class dropbox.files.FileLock(content=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.FileLock.content – The lock description.
__init__(content=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
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(u'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(u'unlocked', None)
class dropbox.files.FileLockMetadata(is_lockholder=None, lockholder_name=None, lockholder_account_id=None, created=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

x.__init__(…) initializes x; see help(type(x)) for signature

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, 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: dropbox.files.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, 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)

x.__init__(…) initializes x; see help(type(x)) for signature

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
class dropbox.files.FileOpsResult

Bases: stone.backends.python_rsrc.stone_base.Struct

__init__()

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: dropbox.files.SharingInfo

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

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

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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(u'active', None)
deleted = FileStatus(u'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(u'other', None)
class dropbox.files.FolderMetadata(name=None, id=None, path_lower=None, path_display=None, parent_shared_folder_id=None, shared_folder_id=None, sharing_info=None, property_groups=None)

Bases: dropbox.files.Metadata

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

x.__init__(…) initializes x; see help(type(x)) for signature

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: dropbox.files.SharingInfo

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

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

x.__init__(…) initializes x; see help(type(x)) for signature

no_access
parent_shared_folder_id
shared_folder_id
traverse_only
class dropbox.files.GetCopyReferenceArg(path=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.GetCopyReferenceArg.path – The path to the file or folder you want to get a copy reference to.
__init__(path=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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(u'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: stone.backends.python_rsrc.stone_base.Struct

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

x.__init__(…) initializes x; see help(type(x)) for signature

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: stone.backends.python_rsrc.stone_base.Struct

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

x.__init__(…) initializes x; see help(type(x)) for signature

include_deleted
include_has_explicit_shared_members
include_media_info
include_property_groups
path
class dropbox.files.GetMetadataError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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.GetTemporaryLinkArg(path=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.GetTemporaryLinkArg.path – The path to the file you want a temporary link to.
__init__(path=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
email_not_verified = GetTemporaryLinkError(u'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_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 = GetTemporaryLinkError(u'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(u'unsupported_file', None)
class dropbox.files.GetTemporaryLinkResult(metadata=None, link=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(metadata=None, link=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

commit_info
duration
class dropbox.files.GetTemporaryUploadLinkResult(link=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.GetTemporaryUploadLinkResult.link – The temporary link which can be used to stream a file to a Dropbox location.
__init__(link=None)

x.__init__(…) initializes x; see help(type(x)) for signature

class dropbox.files.GetThumbnailBatchArg(entries=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

Variables:files.GetThumbnailBatchArg.entries – List of files to get thumbnails.
__init__(entries=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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(u'other', None)
too_many_files = GetThumbnailBatchError(u'too_many_files', None)
class dropbox.files.GetThumbnailBatchResult(entries=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.GetThumbnailBatchResult.entries – List of files and their thumbnails.
__init__(entries=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.GetThumbnailBatchResultData.thumbnail – A string containing the base64-encoded thumbnail data for this file.
__init__(metadata=None, thumbnail=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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(u'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: stone.backends.python_rsrc.stone_base.Struct

GPS coordinates for a photo or video.

Variables:
__init__(latitude=None, longitude=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(highlight_str=None, is_highlighted=None)

x.__init__(…) initializes x; see help(type(x)) for signature

highlight_str
is_highlighted
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: stone.backends.python_rsrc.stone_base.Struct

Variables:
__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)

x.__init__(…) initializes x; see help(type(x)) for signature

include_deleted
include_has_explicit_shared_members
include_media_info
include_mounted_folders
include_non_downloadable_files
include_property_groups
limit
path
recursive
class dropbox.files.ListFolderContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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(u'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(u'reset', None)
class dropbox.files.ListFolderError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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(u'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: stone.backends.python_rsrc.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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(u'other', None)
reset = ListFolderLongpollError(u'reset', None)
class dropbox.files.ListFolderLongpollResult(changes=None, backoff=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(changes=None, backoff=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

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

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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(u'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: stone.backends.python_rsrc.stone_base.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(u'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(u'other', None)
path = ListRevisionsMode(u'path', None)
class dropbox.files.ListRevisionsResult(is_deleted=None, entries=None, server_deleted=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

x.__init__(…) initializes x; see help(type(x)) for signature

entries
is_deleted
server_deleted
class dropbox.files.LockConflictError(lock=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.LockConflictError.lock – The lock that caused the conflict.
__init__(lock=None)

x.__init__(…) initializes x; see help(type(x)) for signature

lock
class dropbox.files.LockFileArg(path=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.LockFileArg.path – Path in the user’s Dropbox to a file.
__init__(path=None)

x.__init__(…) initializes x; see help(type(x)) for signature

path
class dropbox.files.LockFileBatchArg(entries=None)

Bases: stone.backends.python_rsrc.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

entries
class dropbox.files.LockFileBatchResult(entries=None)

Bases: dropbox.files.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
cannot_be_locked = LockFileError(u'cannot_be_locked', None)
file_not_shared = LockFileError(u'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(u'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(u'no_write_permission', None)
other = LockFileError(u'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(u'too_many_files', None)
too_many_write_operations = LockFileError(u'too_many_write_operations', None)
class dropbox.files.LockFileResult(metadata=None, lock=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(metadata=None, lock=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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: stone.backends.python_rsrc.stone_base.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:
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(u'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(u'not_file', None)
not_folder = LookupError(u'not_folder', None)
not_found = LookupError(u'not_found', None)
other = LookupError(u'other', None)
restricted_content = LookupError(u'restricted_content', None)
unsupported_content_type = LookupError(u'unsupported_content_type', None)
class dropbox.files.MediaInfo(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
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(u'pending', None)
class dropbox.files.MediaMetadata(dimensions=None, location=None, time_taken=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Metadata for a photo or video.

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

x.__init__(…) initializes x; see help(type(x)) for signature

dimensions
location
time_taken
class dropbox.files.Metadata(name=None, path_lower=None, path_display=None, parent_shared_folder_id=None)

Bases: stone.backends.python_rsrc.stone_base.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.
__init__(name=None, path_lower=None, path_display=None, parent_shared_folder_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

name
parent_shared_folder_id
path_display
path_lower
class dropbox.files.MetadataV2(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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(u'other', None)
class dropbox.files.MinimalFileLinkMetadata(url=None, rev=None, id=None, path=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

x.__init__(…) initializes x; see help(type(x)) for signature

id
path
rev
url
class dropbox.files.MoveBatchArg(entries=None, autorename=None, allow_ownership_transfer=None)

Bases: dropbox.files.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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(u'is_shared_folder', None)
other = MoveIntoVaultError(u'other', None)

Bases: stone.backends.python_rsrc.stone_base.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.

Only call this if is_link() is true.

Return type:SharedLinkFileInfo
get_path()

Only call this if is_path() is true.

Return type:str

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

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

Parameters:val (SharedLinkFileInfo) –
Return type:PathOrLink
other = PathOrLink(u'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.PhotoMetadata(dimensions=None, location=None, time_taken=None)

Bases: dropbox.files.MediaMetadata

Metadata for a photo.

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

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(path=None, rev=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
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(u'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(u'unsupported_content', None)
unsupported_extension = PreviewError(u'unsupported_extension', None)
class dropbox.files.PreviewResult(file_metadata=None, link_metadata=None)

Bases: stone.backends.python_rsrc.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: dropbox.files.RelocationPath

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

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: dropbox.files.RelocationBatchArgBase

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

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(entries=None, autorename=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: dropbox.files.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(u'too_many_write_operations', None)
class dropbox.files.RelocationBatchErrorEntry(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
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(u'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(u'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(u'too_many_write_operations', None)
class dropbox.files.RelocationBatchJobStatus(tag, value=None)

Bases: dropbox.async_.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:
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: dropbox.async_.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(u'other', None)
class dropbox.files.RelocationBatchResult(entries=None)

Bases: dropbox.files.FileOpsResult

__init__(entries=None)

x.__init__(…) initializes x; see help(type(x)) for signature

entries
class dropbox.files.RelocationBatchResultData(metadata=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.RelocationBatchResultData.metadata – Metadata of the relocated object.
__init__(metadata=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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(u'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: dropbox.async_.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: dropbox.async_.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: dropbox.files.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
cant_copy_shared_folder = RelocationError(u'cant_copy_shared_folder', None)
cant_move_folder_into_itself = RelocationError(u'cant_move_folder_into_itself', None)
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(u'cant_move_shared_folder', None)
cant_nest_shared_folder = RelocationError(u'cant_nest_shared_folder', None)
cant_transfer_ownership = RelocationError(u'cant_transfer_ownership', None)
duplicated_or_nested_paths = RelocationError(u'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_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(u'insufficient_quota', None)
internal_error = RelocationError(u'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_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(u'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(u'too_many_files', None)
class dropbox.files.RelocationPath(from_path=None, to_path=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(from_path=None, to_path=None)

x.__init__(…) initializes x; see help(type(x)) for signature

from_path
to_path
class dropbox.files.RelocationResult(metadata=None)

Bases: dropbox.files.FileOpsResult

Variables:files.RelocationResult.metadata – Metadata of the relocated object.
__init__(metadata=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(path=None, rev=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
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(u'in_progress', None)
invalid_revision = RestoreError(u'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(u'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: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(copy_reference=None, path=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
get_path()

Only call this if is_path() is true.

Return type:WriteError
invalid_copy_reference = SaveCopyReferenceError(u'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(u'no_permission', None)
not_found = SaveCopyReferenceError(u'not_found', None)
other = SaveCopyReferenceError(u'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(u'too_many_files', None)
class dropbox.files.SaveCopyReferenceResult(metadata=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.SaveCopyReferenceResult.metadata – The metadata of the saved file or folder in the user’s Dropbox.
__init__(metadata=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(path=None, url=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
download_failed = SaveUrlError(u'download_failed', None)
get_path()

Only call this if is_path() is true.

Return type:WriteError
invalid_url = SaveUrlError(u'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(u'not_found', None)
other = SaveUrlError(u'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: dropbox.async_.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: dropbox.async_.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: stone.backends.python_rsrc.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

max_results
mode
path
query
start
class dropbox.files.SearchError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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(u'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(u'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: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(match_type=None, metadata=None)

x.__init__(…) initializes x; see help(type(x)) for signature

match_type
metadata
class dropbox.files.SearchMatchFieldOptions(include_highlights=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.SearchMatchFieldOptions.include_highlights – Whether to include highlight span from file title.
__init__(include_highlights=None)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
both = SearchMatchType(u'both', None)
content = SearchMatchType(u'content', None)
filename = SearchMatchType(u'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: stone.backends.python_rsrc.stone_base.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:
file_content = SearchMatchTypeV2(u'file_content', None)
filename = SearchMatchTypeV2(u'filename', None)
filename_and_content = SearchMatchTypeV2(u'filename_and_content', None)
image_content = SearchMatchTypeV2(u'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(u'other', None)
class dropbox.files.SearchMatchV2(metadata=None, match_type=None, highlight_spans=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.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:
deleted_filename = SearchMode(u'deleted_filename', None)
filename = SearchMode(u'filename', None)
filename_and_content = SearchMode(u'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)

Bases: stone.backends.python_rsrc.stone_base.Struct

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

x.__init__(…) initializes x; see help(type(x)) for signature

file_categories
file_extensions
file_status
filename_only
max_results
order_by
path
class dropbox.files.SearchOrderBy(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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(u'last_modified_time', None)
other = SearchOrderBy(u'other', None)
relevance = SearchOrderBy(u'relevance', None)
class dropbox.files.SearchResult(matches=None, more=None, start=None)

Bases: stone.backends.python_rsrc.stone_base.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)

x.__init__(…) initializes x; see help(type(x)) for signature

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

Bases: stone.backends.python_rsrc.stone_base.Struct

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

x.__init__(…) initializes x; see help(type(x)) for signature

include_highlights
match_field_options
options
query
class dropbox.files.SearchV2ContinueArg(cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.SearchV2ContinueArg.cursor – The cursor returned by your last call to dropbox.dropbox_client.Dropbox.files_search(). Used to fetch the next page of results.
__init__(cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
class dropbox.files.SearchV2Result(matches=None, has_more=None, cursor=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
  • files.SearchV2Result.matches – A list (possibly empty) of matches for the query.
  • files.SearchV2Result.has_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_continue() with the cursor.
  • files.SearchV2Result.cursor – Pass the cursor into dropbox.dropbox_client.Dropbox.files_search_continue() to fetch the next page of results.
__init__(matches=None, has_more=None, cursor=None)

x.__init__(…) initializes x; see help(type(x)) for signature

cursor
has_more
matches

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(url=None, password=None)

x.__init__(…) initializes x; see help(type(x)) for signature

password
url
class dropbox.files.SharedLinkFileInfo(url=None, path=None, password=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
  • files.SharedLinkFileInfo.url – The shared link corresponding to either a file or shared link to a folder. If it is for a folder shared link, we use the path param to determine for which file in the folder the view is for.
  • files.SharedLinkFileInfo.path – The path corresponding to a file in a shared link to a folder. Required for shared links to folders.
  • files.SharedLinkFileInfo.password – Password for the shared link. Required for password-protected shared links to files unless it can be read from a cookie.
__init__(url=None, path=None, password=None)

x.__init__(…) initializes x; see help(type(x)) for signature

password
path
url
class dropbox.files.SharingInfo(read_only=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Sharing info for a file or folder.

Variables:files.SharingInfo.read_only – True if the file or folder is inside a read-only shared folder.
__init__(read_only=None)

x.__init__(…) initializes x; see help(type(x)) for signature

read_only
class dropbox.files.SingleUserLock(created=None, lock_holder_account_id=None, lock_holder_team_id=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(created=None, lock_holder_account_id=None, lock_holder_team_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

created
lock_holder_account_id
lock_holder_team_id
class dropbox.files.SymlinkInfo(target=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.SymlinkInfo.target – The target this symlink points to.
__init__(target=None)

x.__init__(…) initializes x; see help(type(x)) for signature

target
class dropbox.files.SyncSetting(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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.SyncSetting.default – On first sync to members’ computers, the specified folder will follow its parent folder’s setting or otherwise follow default sync behavior.
  • files.SyncSetting.not_synced – On first sync to members’ computers, the specified folder will be set to not sync with selective sync.
  • files.SyncSetting.not_synced_inactive – The specified folder’s not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder’s setting.
default = SyncSetting(u'default', None)
is_default()

Check if the union tag is default.

Return type:bool
is_not_synced()

Check if the union tag is not_synced.

Return type:bool
is_not_synced_inactive()

Check if the union tag is not_synced_inactive.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
not_synced = SyncSetting(u'not_synced', None)
not_synced_inactive = SyncSetting(u'not_synced_inactive', None)
other = SyncSetting(u'other', None)
class dropbox.files.SyncSettingArg(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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.SyncSettingArg.default – On first sync to members’ computers, the specified folder will follow its parent folder’s setting or otherwise follow default sync behavior.
  • files.SyncSettingArg.not_synced – On first sync to members’ computers, the specified folder will be set to not sync with selective sync.
default = SyncSettingArg(u'default', None)
is_default()

Check if the union tag is default.

Return type:bool
is_not_synced()

Check if the union tag is not_synced.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
not_synced = SyncSettingArg(u'not_synced', None)
other = SyncSettingArg(u'other', None)
class dropbox.files.SyncSettingsError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
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_combination()

Check if the union tag is unsupported_combination.

Return type:bool
is_unsupported_configuration()

Check if the union tag is unsupported_configuration.

Return type:bool
other = SyncSettingsError(u'other', None)
classmethod path(val)

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

Parameters:val (LookupError) –
Return type:SyncSettingsError
unsupported_combination = SyncSettingsError(u'unsupported_combination', None)
unsupported_configuration = SyncSettingsError(u'unsupported_configuration', None)
class dropbox.files.ThumbnailArg(path=None, format=None, size=None, mode=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(path=None, format=None, size=None, mode=None)

x.__init__(…) initializes x; see help(type(x)) for signature

format
mode
path
size
class dropbox.files.ThumbnailError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
conversion_error = ThumbnailError(u'conversion_error', None)
get_path()

An error occurs when downloading metadata for the image.

Only call this if is_path() is true.

Return type:LookupError
is_conversion_error()

Check if the union tag is conversion_error.

Return type:bool
is_path()

Check if the union tag is path.

Return type:bool
is_unsupported_extension()

Check if the union tag is unsupported_extension.

Return type:bool
is_unsupported_image()

Check if the union tag is unsupported_image.

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:ThumbnailError
unsupported_extension = ThumbnailError(u'unsupported_extension', None)
unsupported_image = ThumbnailError(u'unsupported_image', None)
class dropbox.files.ThumbnailFormat(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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_jpeg()

Check if the union tag is jpeg.

Return type:bool
is_png()

Check if the union tag is png.

Return type:bool
jpeg = ThumbnailFormat(u'jpeg', None)
png = ThumbnailFormat(u'png', None)
class dropbox.files.ThumbnailMode(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
bestfit = ThumbnailMode(u'bestfit', None)
fitone_bestfit = ThumbnailMode(u'fitone_bestfit', None)
is_bestfit()

Check if the union tag is bestfit.

Return type:bool
is_fitone_bestfit()

Check if the union tag is fitone_bestfit.

Return type:bool
is_strict()

Check if the union tag is strict.

Return type:bool
strict = ThumbnailMode(u'strict', None)
class dropbox.files.ThumbnailSize(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
is_w1024h768()

Check if the union tag is w1024h768.

Return type:bool
is_w128h128()

Check if the union tag is w128h128.

Return type:bool
is_w2048h1536()

Check if the union tag is w2048h1536.

Return type:bool
is_w256h256()

Check if the union tag is w256h256.

Return type:bool
is_w32h32()

Check if the union tag is w32h32.

Return type:bool
is_w480h320()

Check if the union tag is w480h320.

Return type:bool
is_w640h480()

Check if the union tag is w640h480.

Return type:bool
is_w64h64()

Check if the union tag is w64h64.

Return type:bool
is_w960h640()

Check if the union tag is w960h640.

Return type:bool
w1024h768 = ThumbnailSize(u'w1024h768', None)
w128h128 = ThumbnailSize(u'w128h128', None)
w2048h1536 = ThumbnailSize(u'w2048h1536', None)
w256h256 = ThumbnailSize(u'w256h256', None)
w32h32 = ThumbnailSize(u'w32h32', None)
w480h320 = ThumbnailSize(u'w480h320', None)
w640h480 = ThumbnailSize(u'w640h480', None)
w64h64 = ThumbnailSize(u'w64h64', None)
w960h640 = ThumbnailSize(u'w960h640', None)
class dropbox.files.ThumbnailV2Arg(resource=None, format=None, size=None, mode=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
  • files.ThumbnailV2Arg.resource – Information specifying which file to preview. This could be a path to a file, a shared link pointing to a file, or a shared link pointing to a folder, with a relative path.
  • files.ThumbnailV2Arg.format – The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts.
  • files.ThumbnailV2Arg.size – The size for the thumbnail image.
  • files.ThumbnailV2Arg.mode – How to resize and crop the image to achieve the desired size.
__init__(resource=None, format=None, size=None, mode=None)

x.__init__(…) initializes x; see help(type(x)) for signature

format
mode
resource
size
class dropbox.files.ThumbnailV2Error(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
access_denied = ThumbnailV2Error(u'access_denied', None)
conversion_error = ThumbnailV2Error(u'conversion_error', None)
get_path()

An error occurred when downloading metadata for the image.

Only call this if is_path() is true.

Return type:LookupError
is_access_denied()

Check if the union tag is access_denied.

Return type:bool
is_conversion_error()

Check if the union tag is conversion_error.

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_unsupported_extension()

Check if the union tag is unsupported_extension.

Return type:bool
is_unsupported_image()

Check if the union tag is unsupported_image.

Return type:bool
not_found = ThumbnailV2Error(u'not_found', None)
other = ThumbnailV2Error(u'other', None)
classmethod path(val)

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

Parameters:val (LookupError) –
Return type:ThumbnailV2Error
unsupported_extension = ThumbnailV2Error(u'unsupported_extension', None)
unsupported_image = ThumbnailV2Error(u'unsupported_image', None)
class dropbox.files.UnlockFileArg(path=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.UnlockFileArg.path – Path in the user’s Dropbox to a file.
__init__(path=None)

x.__init__(…) initializes x; see help(type(x)) for signature

path
class dropbox.files.UnlockFileBatchArg(entries=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.UnlockFileBatchArg.entries – List of ‘entries’. Each ‘entry’ contains a path of the file which will be unlocked. Duplicate path arguments in the batch are considered only once.
__init__(entries=None)

x.__init__(…) initializes x; see help(type(x)) for signature

entries
class dropbox.files.UploadError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
get_path()

Unable to save the uploaded contents to a file.

Only call this if is_path() is true.

Return type:UploadWriteFailed
get_properties_error()

The supplied property group is invalid. The file has uploaded without property groups.

Only call this if is_properties_error() is true.

Return type:file_properties.InvalidPropertyGroupError
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_properties_error()

Check if the union tag is properties_error.

Return type:bool
other = UploadError(u'other', None)
classmethod path(val)

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

Parameters:val (UploadWriteFailed) –
Return type:UploadError
classmethod properties_error(val)

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

Parameters:val (file_properties.InvalidPropertyGroupError) –
Return type:UploadError
class dropbox.files.UploadErrorWithProperties(tag, value=None)

Bases: dropbox.files.UploadError

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.

class dropbox.files.UploadSessionAppendArg(cursor=None, close=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(cursor=None, close=None)

x.__init__(…) initializes x; see help(type(x)) for signature

close
cursor
class dropbox.files.UploadSessionCursor(session_id=None, offset=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(session_id=None, offset=None)

x.__init__(…) initializes x; see help(type(x)) for signature

offset
session_id
class dropbox.files.UploadSessionFinishArg(cursor=None, commit=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(cursor=None, commit=None)

x.__init__(…) initializes x; see help(type(x)) for signature

commit
cursor
class dropbox.files.UploadSessionFinishBatchArg(entries=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.UploadSessionFinishBatchArg.entries – Commit information for each file in the batch.
__init__(entries=None)

x.__init__(…) initializes x; see help(type(x)) for signature

entries
class dropbox.files.UploadSessionFinishBatchJobStatus(tag, value=None)

Bases: dropbox.async_.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.

:ivar UploadSessionFinishBatchResult
UploadSessionFinishBatchJobStatus.complete: The dropbox.dropbox_client.Dropbox.files_upload_session_finish_batch() has finished.
classmethod complete(val)

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

Parameters:val (UploadSessionFinishBatchResult) –
Return type:UploadSessionFinishBatchJobStatus
get_complete()

The dropbox.dropbox_client.Dropbox.files_upload_session_finish_batch() has finished.

Only call this if is_complete() is true.

Return type:UploadSessionFinishBatchResult
is_complete()

Check if the union tag is complete.

Return type:bool
class dropbox.files.UploadSessionFinishBatchLaunch(tag, value=None)

Bases: dropbox.async_.LaunchResultBase

Result returned by dropbox.dropbox_client.Dropbox.files_upload_session_finish_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 (UploadSessionFinishBatchResult) –
Return type:UploadSessionFinishBatchLaunch
get_complete()

Only call this if is_complete() is true.

Return type:UploadSessionFinishBatchResult
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 = UploadSessionFinishBatchLaunch(u'other', None)
class dropbox.files.UploadSessionFinishBatchResult(entries=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.UploadSessionFinishBatchResult.entries – Each entry in UploadSessionFinishBatchArg.entries will appear at the same position inside UploadSessionFinishBatchResult.entries.
__init__(entries=None)

x.__init__(…) initializes x; see help(type(x)) for signature

entries
class dropbox.files.UploadSessionFinishBatchResultEntry(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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 (UploadSessionFinishError) –
Return type:UploadSessionFinishBatchResultEntry
get_failure()

Only call this if is_failure() is true.

Return type:UploadSessionFinishError
get_success()

Only call this if is_success() is true.

Return type:FileMetadata
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 (FileMetadata) –
Return type:UploadSessionFinishBatchResultEntry
class dropbox.files.UploadSessionFinishError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
concurrent_session_data_not_allowed = UploadSessionFinishError(u'concurrent_session_data_not_allowed', None)
concurrent_session_missing_data = UploadSessionFinishError(u'concurrent_session_missing_data', None)
concurrent_session_not_closed = UploadSessionFinishError(u'concurrent_session_not_closed', None)
get_lookup_failed()

The session arguments are incorrect; the value explains the reason.

Only call this if is_lookup_failed() is true.

Return type:UploadSessionLookupError
get_path()

Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset.

Only call this if is_path() is true.

Return type:WriteError
get_properties_error()

The supplied property group is invalid. The file has uploaded without property groups.

Only call this if is_properties_error() is true.

Return type:file_properties.InvalidPropertyGroupError
is_concurrent_session_data_not_allowed()

Check if the union tag is concurrent_session_data_not_allowed.

Return type:bool
is_concurrent_session_missing_data()

Check if the union tag is concurrent_session_missing_data.

Return type:bool
is_concurrent_session_not_closed()

Check if the union tag is concurrent_session_not_closed.

Return type:bool
is_lookup_failed()

Check if the union tag is lookup_failed.

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_properties_error()

Check if the union tag is properties_error.

Return type:bool
is_too_many_shared_folder_targets()

Check if the union tag is too_many_shared_folder_targets.

Return type:bool
is_too_many_write_operations()

Check if the union tag is too_many_write_operations.

Return type:bool
classmethod lookup_failed(val)

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

Parameters:val (UploadSessionLookupError) –
Return type:UploadSessionFinishError
other = UploadSessionFinishError(u'other', None)
classmethod path(val)

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

Parameters:val (WriteError) –
Return type:UploadSessionFinishError
classmethod properties_error(val)

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

Parameters:val (file_properties.InvalidPropertyGroupError) –
Return type:UploadSessionFinishError
too_many_shared_folder_targets = UploadSessionFinishError(u'too_many_shared_folder_targets', None)
too_many_write_operations = UploadSessionFinishError(u'too_many_write_operations', None)
class dropbox.files.UploadSessionLookupError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
closed = UploadSessionLookupError(u'closed', None)
concurrent_session_invalid_data_size = UploadSessionLookupError(u'concurrent_session_invalid_data_size', None)
concurrent_session_invalid_offset = UploadSessionLookupError(u'concurrent_session_invalid_offset', None)
get_incorrect_offset()

The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error.

Only call this if is_incorrect_offset() is true.

Return type:UploadSessionOffsetError
classmethod incorrect_offset(val)

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

Parameters:val (UploadSessionOffsetError) –
Return type:UploadSessionLookupError
is_closed()

Check if the union tag is closed.

Return type:bool
is_concurrent_session_invalid_data_size()

Check if the union tag is concurrent_session_invalid_data_size.

Return type:bool
is_concurrent_session_invalid_offset()

Check if the union tag is concurrent_session_invalid_offset.

Return type:bool
is_incorrect_offset()

Check if the union tag is incorrect_offset.

Return type:bool
is_not_closed()

Check if the union tag is not_closed.

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_too_large()

Check if the union tag is too_large.

Return type:bool
not_closed = UploadSessionLookupError(u'not_closed', None)
not_found = UploadSessionLookupError(u'not_found', None)
other = UploadSessionLookupError(u'other', None)
too_large = UploadSessionLookupError(u'too_large', None)
class dropbox.files.UploadSessionOffsetError(correct_offset=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.UploadSessionOffsetError.correct_offset – The offset up to which data has been collected.
__init__(correct_offset=None)

x.__init__(…) initializes x; see help(type(x)) for signature

correct_offset
class dropbox.files.UploadSessionStartArg(close=None, session_type=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
  • files.UploadSessionStartArg.close – If true, the current session will be closed, at which point you won’t be able to call dropbox.dropbox_client.Dropbox.files_upload_session_append() anymore with the current session.
  • files.UploadSessionStartArg.session_type – Type of upload session you want to start. If not specified, default is UploadSessionType.sequential.
__init__(close=None, session_type=None)

x.__init__(…) initializes x; see help(type(x)) for signature

close
session_type
class dropbox.files.UploadSessionStartError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
concurrent_session_close_not_allowed = UploadSessionStartError(u'concurrent_session_close_not_allowed', None)
concurrent_session_data_not_allowed = UploadSessionStartError(u'concurrent_session_data_not_allowed', None)
is_concurrent_session_close_not_allowed()

Check if the union tag is concurrent_session_close_not_allowed.

Return type:bool
is_concurrent_session_data_not_allowed()

Check if the union tag is concurrent_session_data_not_allowed.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = UploadSessionStartError(u'other', None)
class dropbox.files.UploadSessionStartResult(session_id=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:files.UploadSessionStartResult.session_id – A unique identifier for the upload session. Pass this to dropbox.dropbox_client.Dropbox.files_upload_session_append() and dropbox.dropbox_client.Dropbox.files_upload_session_finish().
__init__(session_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

session_id
class dropbox.files.UploadSessionType(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
concurrent = UploadSessionType(u'concurrent', None)
is_concurrent()

Check if the union tag is concurrent.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_sequential()

Check if the union tag is sequential.

Return type:bool
other = UploadSessionType(u'other', None)
sequential = UploadSessionType(u'sequential', None)
class dropbox.files.UploadWriteFailed(reason=None, upload_session_id=None)

Bases: stone.backends.python_rsrc.stone_base.Struct

Variables:
__init__(reason=None, upload_session_id=None)

x.__init__(…) initializes x; see help(type(x)) for signature

reason
upload_session_id
class dropbox.files.VideoMetadata(dimensions=None, location=None, time_taken=None, duration=None)

Bases: dropbox.files.MediaMetadata

Metadata for a video.

Variables:files.VideoMetadata.duration – The duration of the video in milliseconds.
__init__(dimensions=None, location=None, time_taken=None, duration=None)

x.__init__(…) initializes x; see help(type(x)) for signature

duration
class dropbox.files.WriteConflictError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
file = WriteConflictError(u'file', None)
file_ancestor = WriteConflictError(u'file_ancestor', None)
folder = WriteConflictError(u'folder', None)
is_file()

Check if the union tag is file.

Return type:bool
is_file_ancestor()

Check if the union tag is file_ancestor.

Return type:bool
is_folder()

Check if the union tag is folder.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
other = WriteConflictError(u'other', None)
class dropbox.files.WriteError(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.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:
classmethod conflict(val)

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

Parameters:val (WriteConflictError) –
Return type:WriteError
disallowed_name = WriteError(u'disallowed_name', None)
get_conflict()

Couldn’t write to the target path because there was something in the way.

Only call this if is_conflict() is true.

Return type:WriteConflictError
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]
insufficient_space = WriteError(u'insufficient_space', None)
is_conflict()

Check if the union tag is conflict.

Return type:bool
is_disallowed_name()

Check if the union tag is disallowed_name.

Return type:bool
is_insufficient_space()

Check if the union tag is insufficient_space.

Return type:bool
is_malformed_path()

Check if the union tag is malformed_path.

Return type:bool
is_no_write_permission()

Check if the union tag is no_write_permission.

Return type:bool
is_operation_suppressed()

Check if the union tag is operation_suppressed.

Return type:bool
is_other()

Check if the union tag is other.

Return type:bool
is_team_folder()

Check if the union tag is team_folder.

Return type:bool
is_too_many_write_operations()

Check if the union tag is too_many_write_operations.

Return type:bool
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:WriteError
no_write_permission = WriteError(u'no_write_permission', None)
operation_suppressed = WriteError(u'operation_suppressed', None)
other = WriteError(u'other', None)
team_folder = WriteError(u'team_folder', None)
too_many_write_operations = WriteError(u'too_many_write_operations', None)
class dropbox.files.WriteMode(tag, value=None)

Bases: stone.backends.python_rsrc.stone_base.Union

Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is. In some situations, the conflict behavior is identical: (a) If the target path doesn’t refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it’s always a conflict. (c) If the target path refers to a file with identical contents, nothing gets written; no conflict. The conflict checking differs in the case where there’s a file at the target path with contents different from the contents you’re trying to write.

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.WriteMode.add – Do not overwrite an existing file if there is a conflict. The autorename strategy is to append a number to the file name. For example, “document.txt” might become “document (2).txt”.
  • files.WriteMode.overwrite – Always overwrite the existing file. The autorename strategy is the same as it is for add.
  • files.WriteMode.update (str) – Overwrite if the given “rev” matches the existing file’s “rev”. The autorename strategy is to append the string “conflicted copy” to the file name. For example, “document.txt” might become “document (conflicted copy).txt” or “document (Panda’s conflicted copy).txt”.
add = WriteMode(u'add', None)
get_update()

Overwrite if the given “rev” matches the existing file’s “rev”. The autorename strategy is to append the string “conflicted copy” to the file name. For example, “document.txt” might become “document (conflicted copy).txt” or “document (Panda’s conflicted copy).txt”.

Only call this if is_update() is true.

Return type:str
is_add()

Check if the union tag is add.

Return type:bool
is_overwrite()

Check if the union tag is overwrite.

Return type:bool
is_update()

Check if the union tag is update.

Return type:bool
overwrite = WriteMode(u'overwrite', None)
classmethod update(val)

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

Parameters:val (str) –
Return type:WriteMode