dropbox.files
– Files¶
This namespace contains endpoints and data types for basic file operations.
-
class
dropbox.files.
AddTagArg
(path=None, tag_text=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.AddTagArg.path – Path to the item to be tagged.
- files.AddTagArg.tag_text – The value of the tag to add. Will be automatically converted to lowercase letters.
-
__init__
(path=None, tag_text=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
path
¶
-
tag_text
¶
-
class
dropbox.files.
AddTagError
(tag, value=None)¶ Bases:
dropbox.files.BaseTagError
This class acts as a tagged union. Only one of the
is_*
methods will return true. To get the associated value of a tag (if one exists), use the correspondingget_*
method.Variables: files.AddTagError.too_many_tags – The item already has the maximum supported number of tags. Check if the union tag is
too_many_tags
.Return type: bool
-
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 correspondingget_*
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 valueval
.Parameters: val (file_properties.LookUpPropertiesError) – Return type: AlphaGetMetadataError
-
-
class
dropbox.files.
BaseTagError
(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 correspondingget_*
method.-
get_path
()¶ Only call this if
is_path()
is true.Return type: LookupError
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
is_path
()¶ Check if the union tag is
path
.Return type: bool
-
other
= BaseTagError(u'other', None)¶
-
classmethod
path
(val)¶ Create an instance of this class set to the
path
tag with valueval
.Parameters: val (LookupError) – Return type: BaseTagError
-
-
class
dropbox.files.
CommitInfo
(path=None, mode=None, autorename=None, client_modified=None, mute=None, property_groups=None, strict_conflict=None)¶ Bases:
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 whenmode
=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.
ContentSyncSetting
(id=None, sync_setting=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.ContentSyncSetting.id – Id of the item this setting is applied to.
- files.ContentSyncSetting.sync_setting – Setting for this item.
-
__init__
(id=None, sync_setting=None)¶ 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: - files.ContentSyncSettingArg.id – Id of the item this setting is applied to.
- files.ContentSyncSettingArg.sync_setting – Setting for this item.
-
__init__
(id=None, sync_setting=None)¶ 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: - files.CreateFolderArg.path – Path in the user’s Dropbox to create.
- files.CreateFolderArg.autorename – If there’s a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.
-
__init__
(path=None, autorename=None)¶ 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: - files.CreateFolderBatchArg.paths – List of paths to be created in the user’s Dropbox. Duplicate path arguments in the batch are considered only once.
- files.CreateFolderBatchArg.autorename – If there’s a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.
- files.CreateFolderBatchArg.force_async – Whether to force the create to happen asynchronously.
-
__init__
(paths=None, autorename=None, force_async=None)¶ 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 correspondingget_*
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 correspondingget_*
method.Variables: - CreateFolderBatchJobStatus.complete (CreateFolderBatchResult) – The batch create folder has finished.
- CreateFolderBatchJobStatus.failed (CreateFolderBatchError) – The batch create folder has failed.
-
classmethod
complete
(val)¶ Create an instance of this class set to the
complete
tag with valueval
.Parameters: val (CreateFolderBatchResult) – Return type: CreateFolderBatchJobStatus
-
classmethod
failed
(val)¶ Create an instance of this class set to the
failed
tag with valueval
.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 correspondingget_*
method.-
classmethod
complete
(val)¶ Create an instance of this class set to the
complete
tag with valueval
.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)¶
-
classmethod
-
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 insideCreateFolderBatchResult.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 correspondingget_*
method.-
classmethod
failure
(val)¶ Create an instance of this class set to the
failure
tag with valueval
.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 valueval
.Parameters: val (CreateFolderEntryResult) – Return type: CreateFolderBatchResultEntry
-
classmethod
-
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 correspondingget_*
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 valueval
.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 correspondingget_*
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 valueval
.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: - files.DeleteArg.path – Path in the user’s Dropbox to delete.
- files.DeleteArg.parent_rev – Perform delete if given “rev” matches the existing file’s latest “rev”. This field does not support deleting a folder.
-
__init__
(path=None, parent_rev=None)¶ 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 correspondingget_*
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 correspondingget_*
method.Variables: - DeleteBatchJobStatus.complete (DeleteBatchResult) – The batch delete has finished.
- DeleteBatchJobStatus.failed (DeleteBatchError) – The batch delete has failed.
-
classmethod
complete
(val)¶ Create an instance of this class set to the
complete
tag with valueval
.Parameters: val (DeleteBatchResult) – Return type: DeleteBatchJobStatus
-
classmethod
failed
(val)¶ Create an instance of this class set to the
failed
tag with valueval
.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 correspondingget_*
method.-
classmethod
complete
(val)¶ Create an instance of this class set to the
complete
tag with valueval
.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)¶
-
classmethod
-
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 insideDeleteBatchResult.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 correspondingget_*
method.-
classmethod
failure
(val)¶ Create an instance of this class set to the
failure
tag with valueval
.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 valueval
.Parameters: val (DeleteBatchResultData) – Return type: DeleteBatchResultEntry
-
classmethod
-
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 correspondingget_*
method.Variables: - files.DeleteError.too_many_write_operations – There are too many write operations in user’s Dropbox. Please retry this request.
- files.DeleteError.too_many_files – There are too many files in one request. Please retry with fewer files.
-
get_path_lookup
()¶ Only call this if
is_path_lookup()
is true.Return type: LookupError
-
get_path_write
()¶ Only call this if
is_path_write()
is true.Return type: WriteError
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
is_path_lookup
()¶ Check if the union tag is
path_lookup
.Return type: bool
-
is_path_write
()¶ Check if the union tag is
path_write
.Return type: bool
-
is_too_many_files
()¶ Check if the union tag is
too_many_files
.Return type: bool
-
is_too_many_write_operations
()¶ Check if the union tag is
too_many_write_operations
.Return type: bool
-
other
= DeleteError(u'other', None)¶
-
classmethod
path_lookup
(val)¶ Create an instance of this class set to the
path_lookup
tag with valueval
.Parameters: val (LookupError) – Return type: DeleteError
-
classmethod
path_write
(val)¶ Create an instance of this class set to the
path_write
tag with valueval
.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, preview_url=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, preview_url=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: - files.Dimensions.height – Height of the photo/video.
- files.Dimensions.width – Width of the photo/video.
-
__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: - files.DownloadArg.path – The path of the file to download.
- files.DownloadArg.rev – Please specify revision in
path
instead.
-
__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 correspondingget_*
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 valueval
.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 correspondingget_*
method.Variables: - files.DownloadZipError.too_large – The folder or a file is too large to download.
- files.DownloadZipError.too_many_files – The folder has too many files to download.
-
get_path
()¶ Only call this if
is_path()
is true.Return type: LookupError
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
is_path
()¶ Check if the union tag is
path
.Return type: bool
-
is_too_large
()¶ Check if the union tag is
too_large
.Return type: bool
-
is_too_many_files
()¶ Check if the union tag is
too_many_files
.Return type: bool
-
other
= DownloadZipError(u'other', None)¶
-
classmethod
path
(val)¶ Create an instance of this class set to the
path
tag with valueval
.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, export_format=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.ExportArg.path – The path of the file to be exported.
- files.ExportArg.export_format – The file format to which the file
should be exported. This must be one of the formats listed in the file’s
export_options returned by
dropbox.dropbox_client.Dropbox.files_get_metadata()
. If none is specified, the default format (specified in export_as in file metadata) will be used.
-
__init__
(path=None, export_format=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
export_format
¶
-
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 correspondingget_*
method.Variables: - files.ExportError.non_exportable – This file type cannot be exported.
Use
dropbox.dropbox_client.Dropbox.files_download()
instead. - files.ExportError.invalid_export_format – The specified export format is not a valid option for this file type.
- files.ExportError.retry_error – The exportable content is not yet available. Please retry later.
-
get_path
()¶ Only call this if
is_path()
is true.Return type: LookupError
-
invalid_export_format
= ExportError(u'invalid_export_format', None)¶
-
is_invalid_export_format
()¶ Check if the union tag is
invalid_export_format
.Return type: bool
-
is_non_exportable
()¶ Check if the union tag is
non_exportable
.Return type: bool
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
is_path
()¶ Check if the union tag is
path
.Return type: bool
-
is_retry_error
()¶ Check if the union tag is
retry_error
.Return type: bool
-
non_exportable
= ExportError(u'non_exportable', None)¶
-
other
= ExportError(u'other', None)¶
-
classmethod
path
(val)¶ Create an instance of this class set to the
path
tag with valueval
.Parameters: val (LookupError) – Return type: ExportError
-
retry_error
= ExportError(u'retry_error', None)¶
- files.ExportError.non_exportable – This file type cannot be exported.
Use
-
class
dropbox.files.
ExportInfo
(export_as=None, export_options=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.
- files.ExportInfo.export_options – Additional formats to which the file can be exported. These values can be specified as the export_format in /files/export.
-
__init__
(export_as=None, export_options=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
export_as
¶
-
export_options
¶
-
class
dropbox.files.
ExportMetadata
(name=None, size=None, export_hash=None, paper_revision=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.ExportMetadata.name – The last component of the path (including extension). This never contains a slash.
- files.ExportMetadata.size – The file size in bytes.
- files.ExportMetadata.export_hash – A hash based on the exported file content. This field can be used to verify data integrity. Similar to content hash. For more information see our Content hash page.
- files.ExportMetadata.paper_revision – If the file is a Paper doc, this
gives the latest doc revision which can be used in
dropbox.dropbox_client.Dropbox.files_paper_update()
.
-
__init__
(name=None, size=None, export_hash=None, paper_revision=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
export_hash
¶
-
name
¶
-
paper_revision
¶
-
size
¶
-
class
dropbox.files.
ExportResult
(export_metadata=None, file_metadata=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.ExportResult.export_metadata – Metadata for the exported version of the file.
- files.ExportResult.file_metadata – Metadata for the original file.
-
__init__
(export_metadata=None, file_metadata=None)¶ 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 correspondingget_*
method.Variables: - files.FileCategory.image – jpg, png, gif, and more.
- files.FileCategory.document – doc, docx, txt, and more.
- files.FileCategory.pdf – pdf.
- files.FileCategory.spreadsheet – xlsx, xls, csv, and more.
- files.FileCategory.presentation – ppt, pptx, key, and more.
- files.FileCategory.audio – mp3, wav, mid, and more.
- files.FileCategory.video – mov, wmv, mp4, and more.
- files.FileCategory.folder – dropbox folder.
- files.FileCategory.paper – dropbox paper doc.
- files.FileCategory.others – any file not in one of the categories above.
-
audio
= FileCategory(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 correspondingget_*
method.Variables: - files.FileLockContent.unlocked – Empty type to indicate no lock.
- FileLockContent.single_user (SingleUserLock) – A lock held by a single user.
-
get_single_user
()¶ A lock held by a single user.
Only call this if
is_single_user()
is true.Return type: SingleUserLock
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
is_single_user
()¶ Check if the union tag is
single_user
.Return type: bool
-
is_unlocked
()¶ Check if the union tag is
unlocked
.Return type: bool
-
other
= FileLockContent(u'other', None)¶
-
classmethod
single_user
(val)¶ Create an instance of this class set to the
single_user
tag with valueval
.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: - files.FileLockMetadata.is_lockholder – True if caller holds the file lock.
- files.FileLockMetadata.lockholder_name – The display name of the lock holder.
- files.FileLockMetadata.lockholder_account_id – The account ID of the lock holder if known.
- files.FileLockMetadata.created – The timestamp of the lock was created.
-
__init__
(is_lockholder=None, lockholder_name=None, lockholder_account_id=None, created=None)¶ 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, preview_url=None, media_info=None, symlink_info=None, sharing_info=None, is_downloadable=None, export_info=None, property_groups=None, has_explicit_shared_members=None, content_hash=None, file_lock_info=None)¶ Bases:
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()
, ordropbox.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()
ordropbox.dropbox_client.Dropbox.files_get_metadata()
. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. - files.FileMetadata.content_hash –
A hash of the file content. This field can be used to verify data integrity. For more information see our Content hash page.
- files.FileMetadata.file_lock_info – If present, the metadata associated with the file’s current lock.
-
__init__
(name=None, id=None, client_modified=None, server_modified=None, rev=None, size=None, path_lower=None, path_display=None, parent_shared_folder_id=None, preview_url=None, media_info=None, symlink_info=None, sharing_info=None, is_downloadable=None, export_info=None, property_groups=None, has_explicit_shared_members=None, content_hash=None, file_lock_info=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
client_modified
¶
-
content_hash
¶
-
export_info
¶
-
file_lock_info
¶
-
id
¶
-
is_downloadable
¶
-
media_info
¶
-
property_groups
¶
-
rev
¶
-
server_modified
¶
-
sharing_info
¶
-
size
¶
-
symlink_info
¶
-
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: - files.FileSharingInfo.parent_shared_folder_id – ID of shared folder that holds this file.
- files.FileSharingInfo.modified_by – The last user who modified the file. This field will be null if the user’s account has been deleted.
-
__init__
(read_only=None, parent_shared_folder_id=None, modified_by=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
modified_by
¶
-
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 correspondingget_*
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, preview_url=None, shared_folder_id=None, sharing_info=None, property_groups=None)¶ Bases:
dropbox.files.Metadata
Variables: - files.FolderMetadata.id – A unique identifier for the folder.
- files.FolderMetadata.shared_folder_id – Please use
sharing_info
instead. - files.FolderMetadata.sharing_info – Set if the folder is contained in a shared folder or is a shared folder mount point.
- files.FolderMetadata.property_groups – Additional information if the file has custom properties with the property template specified. Note that only properties associated with user-owned templates, not team-owned templates, can be attached to folders.
-
__init__
(name=None, id=None, path_lower=None, path_display=None, parent_shared_folder_id=None, preview_url=None, shared_folder_id=None, sharing_info=None, property_groups=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
id
¶
-
property_groups
¶
-
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: - files.FolderSharingInfo.parent_shared_folder_id – Set if the folder is contained by a shared folder.
- files.FolderSharingInfo.shared_folder_id – If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.
- files.FolderSharingInfo.traverse_only – Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don’t have read access to this folder. They do, however, have access to some sub folder.
- files.FolderSharingInfo.no_access – Specifies that the folder cannot be accessed by the user.
-
__init__
(read_only=None, parent_shared_folder_id=None, shared_folder_id=None, traverse_only=None, no_access=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
no_access
¶
-
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 correspondingget_*
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 valueval
.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: - files.GetCopyReferenceResult.metadata – Metadata of the file or folder.
- files.GetCopyReferenceResult.copy_reference – A copy reference to the file or folder.
- files.GetCopyReferenceResult.expires – The expiration date of the copy reference. This value is currently set to be far enough in the future so that expiration is effectively not an issue.
-
__init__
(metadata=None, copy_reference=None, expires=None)¶ 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: - files.GetMetadataArg.path – The path of a file or folder on Dropbox.
- files.GetMetadataArg.include_media_info – If true,
FileMetadata.media_info
is set for photo and video. - files.GetMetadataArg.include_deleted – If true,
DeletedMetadata
will be returned for deleted file or folder, otherwiseLookupError.not_found
will be returned. - files.GetMetadataArg.include_has_explicit_shared_members – If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
- files.GetMetadataArg.include_property_groups – If set to a valid list
of template IDs,
FileMetadata.property_groups
is set if there exists property data associated with the file and each of the listed templates.
-
__init__
(path=None, include_media_info=None, include_deleted=None, include_has_explicit_shared_members=None, include_property_groups=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
include_deleted
¶
-
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 correspondingget_*
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 valueval
.Parameters: val (LookupError) – Return type: GetMetadataError
-
-
class
dropbox.files.
GetTagsArg
(paths=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: files.GetTagsArg.paths – Path to the items. -
__init__
(paths=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
paths
¶
-
-
class
dropbox.files.
GetTagsResult
(paths_to_tags=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: files.GetTagsResult.paths_to_tags – List of paths and their corresponding tags. -
__init__
(paths_to_tags=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
-
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 correspondingget_*
method.Variables: - files.GetTemporaryLinkError.email_not_verified – This user’s email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here.
- files.GetTemporaryLinkError.unsupported_file – Cannot get temporary
link to this file type; use
dropbox.dropbox_client.Dropbox.files_export()
instead. - files.GetTemporaryLinkError.not_allowed – The user is not allowed to request a temporary link to the specified file. For example, this can occur if the file is restricted or if the user’s links are banned.
-
email_not_verified
= GetTemporaryLinkError(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_not_allowed
()¶ Check if the union tag is
not_allowed
.Return type: bool
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
is_path
()¶ Check if the union tag is
path
.Return type: bool
-
is_unsupported_file
()¶ Check if the union tag is
unsupported_file
.Return type: bool
-
not_allowed
= GetTemporaryLinkError(u'not_allowed', None)¶
-
other
= GetTemporaryLinkError(u'other', None)¶
-
classmethod
path
(val)¶ Create an instance of this class set to the
path
tag with valueval
.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: - files.GetTemporaryLinkResult.metadata – Metadata of the file.
- files.GetTemporaryLinkResult.link – The temporary link which can be used to stream content the file.
-
__init__
(metadata=None, link=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
link
¶
-
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
¶
- files.GetTemporaryUploadLinkArg.commit_info – Contains the path and
other optional modifiers for the future upload commit. Equivalent to the
parameters provided to
-
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
-
link
¶
-
-
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 correspondingget_*
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 correspondingget_*
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 valueval
.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 valueval
.Parameters: val (GetThumbnailBatchResultData) – Return type: GetThumbnailBatchResultEntry
-
classmethod
-
class
dropbox.files.
GpsCoordinates
(latitude=None, longitude=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
GPS coordinates for a photo or video.
Variables: - files.GpsCoordinates.latitude – Latitude of the GPS coordinates.
- files.GpsCoordinates.longitude – Longitude of the GPS coordinates.
-
__init__
(latitude=None, longitude=None)¶ 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: - files.HighlightSpan.highlight_str – String to be determined whether it should be highlighted or not.
- files.HighlightSpan.is_highlighted – The string should be highlighted or not.
-
__init__
(highlight_str=None, is_highlighted=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
highlight_str
¶
-
is_highlighted
¶
-
class
dropbox.files.
ImportFormat
(tag, value=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Union
The import format of the incoming Paper doc content.
This class acts as a tagged union. Only one of the
is_*
methods will return true. To get the associated value of a tag (if one exists), use the correspondingget_*
method.Variables: - files.ImportFormat.html – The provided data is interpreted as standard HTML.
- files.ImportFormat.markdown – The provided data is interpreted as markdown.
- files.ImportFormat.plain_text – The provided data is interpreted as plain text.
-
html
= ImportFormat(u'html', None)¶
-
is_html
()¶ Check if the union tag is
html
.Return type: bool
-
is_markdown
()¶ Check if the union tag is
markdown
.Return type: bool
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
is_plain_text
()¶ Check if the union tag is
plain_text
.Return type: bool
-
markdown
= ImportFormat(u'markdown', None)¶
-
other
= ImportFormat(u'other', None)¶
-
plain_text
= ImportFormat(u'plain_text', None)¶
-
class
dropbox.files.
ListFolderArg
(path=None, recursive=None, include_media_info=None, include_deleted=None, include_has_explicit_shared_members=None, include_mounted_folders=None, limit=None, shared_link=None, include_property_groups=None, include_non_downloadable_files=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.ListFolderArg.path – A unique identifier for the file.
- files.ListFolderArg.recursive – If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.
- files.ListFolderArg.include_media_info – If true,
FileMetadata.media_info
is set for photo and video. This parameter will no longer have an effect starting December 2, 2019. - files.ListFolderArg.include_deleted – If true, the results will include entries for files and folders that used to exist but were deleted.
- files.ListFolderArg.include_has_explicit_shared_members – If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
- files.ListFolderArg.include_mounted_folders – If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.
- files.ListFolderArg.limit – The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.
- files.ListFolderArg.shared_link – A shared link to list the contents
of. If the link is password-protected, the password must be provided. If
this field is present,
ListFolderArg.path
will be relative to root of the shared link. Only non-recursive mode is supported for shared link. - files.ListFolderArg.include_property_groups – If set to a valid list of
template IDs,
FileMetadata.property_groups
is set if there exists property data associated with the file and each of the listed templates. - files.ListFolderArg.include_non_downloadable_files – If true, include files that are not downloadable, i.e. Google Docs.
-
__init__
(path=None, recursive=None, include_media_info=None, include_deleted=None, include_has_explicit_shared_members=None, include_mounted_folders=None, limit=None, shared_link=None, include_property_groups=None, include_non_downloadable_files=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
include_deleted
¶
-
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()
ordropbox.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 correspondingget_*
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 valueval
.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 correspondingget_*
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 valueval
.Parameters: val (LookupError) – Return type: ListFolderError
-
classmethod
template_error
(val)¶ Create an instance of this class set to the
template_error
tag with valueval
.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()
ordropbox.dropbox_client.Dropbox.files_list_folder_continue()
. Cursors retrieved by settingListFolderArg.include_media_info
toTrue
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
¶
- files.ListFolderLongpollArg.cursor – A cursor as returned by
-
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 correspondingget_*
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: - files.ListFolderLongpollResult.changes – Indicates whether new changes
are available. If true, call
dropbox.dropbox_client.Dropbox.files_list_folder_continue()
to retrieve the changes. - files.ListFolderLongpollResult.backoff – If present, backoff for at
least this many seconds before calling
dropbox.dropbox_client.Dropbox.files_list_folder_longpoll()
again.
-
__init__
(changes=None, backoff=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
backoff
¶
-
changes
¶
- files.ListFolderLongpollResult.changes – Indicates whether new changes
are available. If true, call
-
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: - files.ListRevisionsArg.path – The path to the file you want to see the revisions of.
- files.ListRevisionsArg.mode – Determines the behavior of the API in listing the revisions for a given file path or id.
- files.ListRevisionsArg.limit – The maximum number of revision entries returned.
-
__init__
(path=None, mode=None, limit=None)¶ 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 correspondingget_*
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 valueval
.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 correspondingget_*
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: - files.ListRevisionsResult.is_deleted – If the file identified by the latest revision in the response is either deleted or moved.
- files.ListRevisionsResult.server_deleted – The time of deletion if the file was deleted.
- files.ListRevisionsResult.entries – The revisions for the file. Only revisions that are not deleted will show up here.
-
__init__
(is_deleted=None, entries=None, server_deleted=None)¶ 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 correspondingget_*
method.Variables: - LockFileError.path_lookup (LookupError) – Could not find the specified resource.
- files.LockFileError.too_many_write_operations – There are too many write operations in user’s Dropbox. Please retry this request.
- files.LockFileError.too_many_files – There are too many files in one request. Please retry with fewer files.
- files.LockFileError.no_write_permission – The user does not have permissions to change the lock state or access the file.
- files.LockFileError.cannot_be_locked – Item is a type that cannot be locked.
- files.LockFileError.file_not_shared – Requested file is not currently shared.
- LockFileError.lock_conflict (LockConflictError) – The user action conflicts with an existing lock on the file.
- files.LockFileError.internal_error – Something went wrong with the job on Dropbox’s end. You’ll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.
-
cannot_be_locked
= LockFileError(u'cannot_be_locked', 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
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 valueval
.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 valueval
.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: - files.LockFileResult.metadata – Metadata of the file.
- files.LockFileResult.lock – The file lock state after the operation.
-
__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 correspondingget_*
method.-
classmethod
failure
(val)¶ Create an instance of this class set to the
failure
tag with valueval
.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 valueval
.Parameters: val (LockFileResult) – Return type: LockFileResultEntry
-
classmethod
-
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 correspondingget_*
method.Variables: - files.LookupError.malformed_path (Optional[str]) – The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information.
- files.LookupError.not_found – There is nothing at the given path.
- files.LookupError.not_file – We were expecting a file, but the given path refers to something that isn’t a file.
- files.LookupError.not_folder – We were expecting a folder, but the given path refers to something that isn’t a folder.
- files.LookupError.restricted_content – The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements.
- files.LookupError.unsupported_content_type – This operation is not supported for this content type.
- files.LookupError.locked – The given path is locked.
-
get_malformed_path
()¶ The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.
Only call this if
is_malformed_path()
is true.Return type: Optional[str]
-
is_locked
()¶ Check if the union tag is
locked
.Return type: bool
-
is_malformed_path
()¶ Check if the union tag is
malformed_path
.Return type: bool
-
is_not_file
()¶ Check if the union tag is
not_file
.Return type: bool
-
is_not_folder
()¶ Check if the union tag is
not_folder
.Return type: bool
-
is_not_found
()¶ Check if the union tag is
not_found
.Return type: bool
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
is_restricted_content
()¶ Check if the union tag is
restricted_content
.Return type: bool
-
is_unsupported_content_type
()¶ Check if the union tag is
unsupported_content_type
.Return type: bool
-
locked
= LookupError(u'locked', None)¶
-
classmethod
malformed_path
(val)¶ Create an instance of this class set to the
malformed_path
tag with valueval
.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 correspondingget_*
method.Variables: - files.MediaInfo.pending – Indicate the photo/video is still under processing and metadata is not available yet.
- MediaInfo.metadata (MediaMetadata) – The metadata for the photo/video.
-
get_metadata
()¶ The metadata for the photo/video.
Only call this if
is_metadata()
is true.Return type: MediaMetadata
-
is_metadata
()¶ Check if the union tag is
metadata
.Return type: bool
-
is_pending
()¶ Check if the union tag is
pending
.Return type: bool
-
classmethod
metadata
(val)¶ Create an instance of this class set to the
metadata
tag with valueval
.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: - files.MediaMetadata.dimensions – Dimension of the photo/video.
- files.MediaMetadata.location – The GPS coordinate of the photo/video.
- files.MediaMetadata.time_taken – The timestamp when the photo/video is taken.
-
__init__
(dimensions=None, location=None, time_taken=None)¶ 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, preview_url=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
orFolderSharingInfo.parent_shared_folder_id
instead. - files.Metadata.preview_url – The preview URL of the file.
-
__init__
(name=None, path_lower=None, path_display=None, parent_shared_folder_id=None, preview_url=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
name
¶
-
path_display
¶
-
path_lower
¶
-
preview_url
¶
-
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 correspondingget_*
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 valueval
.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: - files.MinimalFileLinkMetadata.url – URL of the shared link.
- files.MinimalFileLinkMetadata.id – Unique identifier for the linked file.
- files.MinimalFileLinkMetadata.path – Full path in the user’s Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user’s Dropbox.
- files.MinimalFileLinkMetadata.rev – A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts.
-
__init__
(url=None, rev=None, id=None, path=None)¶ 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.
MoveIntoFamilyError
(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 correspondingget_*
method.Variables: files.MoveIntoFamilyError.is_shared_folder – Moving shared folder into Family Room folder is not allowed. Check if the union tag is
is_shared_folder
.Return type: bool
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
other
= MoveIntoFamilyError(u'other', None)¶
-
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 correspondingget_*
method.Variables: files.MoveIntoVaultError.is_shared_folder – Moving shared folder into Vault is not allowed. Check if the union tag is
is_shared_folder
.Return type: bool
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
other
= MoveIntoVaultError(u'other', None)¶
-
class
dropbox.files.
PaperContentError
(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 correspondingget_*
method.Variables: - files.PaperContentError.insufficient_permissions – Your account does not have permissions to edit Paper docs.
- files.PaperContentError.content_malformed – The provided content was malformed and cannot be imported to Paper.
- files.PaperContentError.doc_length_exceeded – The Paper doc would be too large, split the content into multiple docs.
- files.PaperContentError.image_size_exceeded – The imported document contains an image that is too large. The current limit is 1MB. This only applies to HTML with data URI.
-
content_malformed
= PaperContentError(u'content_malformed', None)¶
-
doc_length_exceeded
= PaperContentError(u'doc_length_exceeded', None)¶
-
image_size_exceeded
= PaperContentError(u'image_size_exceeded', None)¶
-
insufficient_permissions
= PaperContentError(u'insufficient_permissions', None)¶
-
is_content_malformed
()¶ Check if the union tag is
content_malformed
.Return type: bool
-
is_doc_length_exceeded
()¶ Check if the union tag is
doc_length_exceeded
.Return type: bool
-
is_image_size_exceeded
()¶ Check if the union tag is
image_size_exceeded
.Return type: bool
-
is_insufficient_permissions
()¶ Check if the union tag is
insufficient_permissions
.Return type: bool
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
other
= PaperContentError(u'other', None)¶
-
class
dropbox.files.
PaperCreateArg
(path=None, import_format=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.PaperCreateArg.path – The fully qualified path to the location in the user’s Dropbox where the Paper Doc should be created. This should include the document’s title and end with .paper.
- files.PaperCreateArg.import_format – The format of the provided data.
-
__init__
(path=None, import_format=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
import_format
¶
-
path
¶
-
class
dropbox.files.
PaperCreateError
(tag, value=None)¶ Bases:
dropbox.files.PaperContentError
This class acts as a tagged union. Only one of the
is_*
methods will return true. To get the associated value of a tag (if one exists), use the correspondingget_*
method.Variables: - files.PaperCreateError.invalid_path – The file could not be saved to the specified location.
- files.PaperCreateError.email_unverified – The user’s email must be verified to create Paper docs.
- files.PaperCreateError.invalid_file_extension – The file path must end in .paper.
- files.PaperCreateError.paper_disabled – Paper is disabled for your team.
-
email_unverified
= PaperCreateError(u'email_unverified', None)¶
-
invalid_file_extension
= PaperCreateError(u'invalid_file_extension', None)¶
-
invalid_path
= PaperCreateError(u'invalid_path', None)¶
-
is_email_unverified
()¶ Check if the union tag is
email_unverified
.Return type: bool
-
is_invalid_file_extension
()¶ Check if the union tag is
invalid_file_extension
.Return type: bool
-
is_invalid_path
()¶ Check if the union tag is
invalid_path
.Return type: bool
-
is_paper_disabled
()¶ Check if the union tag is
paper_disabled
.Return type: bool
-
paper_disabled
= PaperCreateError(u'paper_disabled', None)¶
-
class
dropbox.files.
PaperCreateResult
(url=None, result_path=None, file_id=None, paper_revision=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.PaperCreateResult.url – URL to open the Paper Doc.
- files.PaperCreateResult.result_path – The fully qualified path the Paper Doc was actually created at.
- files.PaperCreateResult.file_id – The id to use in Dropbox APIs when referencing the Paper Doc.
- files.PaperCreateResult.paper_revision – The current doc revision.
-
__init__
(url=None, result_path=None, file_id=None, paper_revision=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
file_id
¶
-
paper_revision
¶
-
result_path
¶
-
url
¶
-
class
dropbox.files.
PaperDocUpdatePolicy
(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 correspondingget_*
method.Variables: - files.PaperDocUpdatePolicy.update – Sets the doc content to the provided content if the provided paper_revision matches the latest doc revision. Otherwise, returns an error.
- files.PaperDocUpdatePolicy.overwrite – Sets the doc content to the provided content without checking paper_revision.
- files.PaperDocUpdatePolicy.prepend – Adds the provided content to the beginning of the doc without checking paper_revision.
- files.PaperDocUpdatePolicy.append – Adds the provided content to the end of the doc without checking paper_revision.
-
append
= PaperDocUpdatePolicy(u'append', None)¶
-
is_append
()¶ Check if the union tag is
append
.Return type: bool
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
is_overwrite
()¶ Check if the union tag is
overwrite
.Return type: bool
-
is_prepend
()¶ Check if the union tag is
prepend
.Return type: bool
-
is_update
()¶ Check if the union tag is
update
.Return type: bool
-
other
= PaperDocUpdatePolicy(u'other', None)¶
-
overwrite
= PaperDocUpdatePolicy(u'overwrite', None)¶
-
prepend
= PaperDocUpdatePolicy(u'prepend', None)¶
-
update
= PaperDocUpdatePolicy(u'update', None)¶
-
class
dropbox.files.
PaperUpdateArg
(path=None, import_format=None, doc_update_policy=None, paper_revision=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.PaperUpdateArg.path – Path in the user’s Dropbox to update. The path must correspond to a Paper doc or an error will be returned.
- files.PaperUpdateArg.import_format – The format of the provided data.
- files.PaperUpdateArg.doc_update_policy – How the provided content should be applied to the doc.
- files.PaperUpdateArg.paper_revision – The latest doc revision. Required when doc_update_policy is update. This value must match the current revision of the doc or error revision_mismatch will be returned.
-
__init__
(path=None, import_format=None, doc_update_policy=None, paper_revision=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
doc_update_policy
¶
-
import_format
¶
-
paper_revision
¶
-
path
¶
-
class
dropbox.files.
PaperUpdateError
(tag, value=None)¶ Bases:
dropbox.files.PaperContentError
This class acts as a tagged union. Only one of the
is_*
methods will return true. To get the associated value of a tag (if one exists), use the correspondingget_*
method.Variables: - files.PaperUpdateError.revision_mismatch – The provided revision does not match the document head.
- files.PaperUpdateError.doc_archived – This operation is not allowed on archived Paper docs.
- files.PaperUpdateError.doc_deleted – This operation is not allowed on deleted Paper docs.
-
doc_archived
= PaperUpdateError(u'doc_archived', None)¶
-
doc_deleted
= PaperUpdateError(u'doc_deleted', None)¶
-
get_path
()¶ Only call this if
is_path()
is true.Return type: LookupError
-
is_doc_archived
()¶ Check if the union tag is
doc_archived
.Return type: bool
-
is_doc_deleted
()¶ Check if the union tag is
doc_deleted
.Return type: bool
-
is_path
()¶ Check if the union tag is
path
.Return type: bool
-
is_revision_mismatch
()¶ Check if the union tag is
revision_mismatch
.Return type: bool
-
classmethod
path
(val)¶ Create an instance of this class set to the
path
tag with valueval
.Parameters: val (LookupError) – Return type: PaperUpdateError
-
revision_mismatch
= PaperUpdateError(u'revision_mismatch', None)¶
-
class
dropbox.files.
PaperUpdateResult
(paper_revision=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: files.PaperUpdateResult.paper_revision – The current doc revision. -
__init__
(paper_revision=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
paper_revision
¶
-
-
class
dropbox.files.
PathOrLink
(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 correspondingget_*
method.-
get_link
()¶ Only call this if
is_link()
is true.Return type: SharedLinkFileInfo
-
is_link
()¶ Check if the union tag is
link
.Return type: bool
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
is_path
()¶ Check if the union tag is
path
.Return type: bool
-
classmethod
link
(val)¶ Create an instance of this class set to the
link
tag with valueval
.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 valueval
.Parameters: val (str) – Return type: PathOrLink
-
-
class
dropbox.files.
PathToTags
(path=None, tags=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.PathToTags.path – Path of the item.
- files.PathToTags.tags – Tags assigned to this item.
-
__init__
(path=None, tags=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
path
¶
-
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: - files.PreviewArg.path – The path of the file to preview.
- files.PreviewArg.rev – Please specify revision in
path
instead.
-
__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 correspondingget_*
method.Variables: - PreviewError.path (LookupError) – An error occurs when downloading metadata for the file.
- files.PreviewError.in_progress – This preview generation is still in progress and the file is not ready for preview yet.
- files.PreviewError.unsupported_extension – The file extension is not supported preview generation.
- files.PreviewError.unsupported_content – The file content is not supported for preview generation.
-
get_path
()¶ An error occurs when downloading metadata for the file.
Only call this if
is_path()
is true.Return type: LookupError
-
in_progress
= PreviewError(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 valueval
.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
¶
-
link_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: - files.RelocationArg.allow_shared_folder – This flag has no effect.
- files.RelocationArg.autorename – If there’s a conflict, have the Dropbox server try to autorename the file to avoid the conflict.
- files.RelocationArg.allow_ownership_transfer – Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.
-
__init__
(from_path=None, to_path=None, allow_shared_folder=None, autorename=None, allow_ownership_transfer=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
allow_ownership_transfer
¶
-
autorename
¶
-
class
dropbox.files.
RelocationBatchArg
(entries=None, autorename=None, allow_shared_folder=None, allow_ownership_transfer=None)¶ Bases:
dropbox.files.RelocationBatchArgBase
Variables: - files.RelocationBatchArg.allow_shared_folder – This flag has no effect.
- files.RelocationBatchArg.allow_ownership_transfer – Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.
-
__init__
(entries=None, autorename=None, allow_shared_folder=None, allow_ownership_transfer=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
allow_ownership_transfer
¶
-
class
dropbox.files.
RelocationBatchArgBase
(entries=None, autorename=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.RelocationBatchArgBase.entries – List of entries to be moved or
copied. Each entry is
RelocationPath
. - files.RelocationBatchArgBase.autorename – If there’s a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.
-
__init__
(entries=None, autorename=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
autorename
¶
-
entries
¶
- files.RelocationBatchArgBase.entries – List of entries to be moved or
copied. Each entry is
-
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 correspondingget_*
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 correspondingget_*
method.Variables: - RelocationBatchErrorEntry.relocation_error (RelocationError) – User errors that retry won’t help.
- files.RelocationBatchErrorEntry.internal_error – Something went wrong with the job on Dropbox’s end. You’ll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.
- files.RelocationBatchErrorEntry.too_many_write_operations – There are too many write operations in user’s Dropbox. Please retry this request.
-
get_relocation_error
()¶ User errors that retry won’t help.
Only call this if
is_relocation_error()
is true.Return type: RelocationError
-
internal_error
= RelocationBatchErrorEntry(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 valueval
.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 correspondingget_*
method.Variables: - RelocationBatchJobStatus.complete (RelocationBatchResult) – The copy or move batch job has finished.
- RelocationBatchJobStatus.failed (RelocationBatchError) – The copy or move batch job has failed with exception.
-
classmethod
complete
(val)¶ Create an instance of this class set to the
complete
tag with valueval
.Parameters: val (RelocationBatchResult) – Return type: RelocationBatchJobStatus
-
classmethod
failed
(val)¶ Create an instance of this class set to the
failed
tag with valueval
.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()
ordropbox.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 correspondingget_*
method.-
classmethod
complete
(val)¶ Create an instance of this class set to the
complete
tag with valueval
.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)¶
-
classmethod
-
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 correspondingget_*
method.-
classmethod
failure
(val)¶ Create an instance of this class set to the
failure
tag with valueval
.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 valueval
.Parameters: val (Metadata) – Return type: RelocationBatchResultEntry
-
classmethod
-
class
dropbox.files.
RelocationBatchV2JobStatus
(tag, value=None)¶ Bases:
dropbox.async_.PollResultBase
Result returned by
dropbox.dropbox_client.Dropbox.files_copy_batch_check()
ordropbox.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 correspondingget_*
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 valueval
.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
-
classmethod
-
class
dropbox.files.
RelocationBatchV2Launch
(tag, value=None)¶ Bases:
dropbox.async_.LaunchResultBase
Result returned by
dropbox.dropbox_client.Dropbox.files_copy_batch()
ordropbox.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 correspondingget_*
method.-
classmethod
complete
(val)¶ Create an instance of this class set to the
complete
tag with valueval
.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
-
classmethod
-
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 insideRelocationBatchV2Result.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 correspondingget_*
method.Variables: - files.RelocationError.cant_copy_shared_folder – Shared folders can’t be copied.
- files.RelocationError.cant_nest_shared_folder – Your move operation would result in nested shared folders. This is not allowed.
- files.RelocationError.cant_move_folder_into_itself – You cannot move a folder into itself.
- files.RelocationError.too_many_files – The operation would involve more than 10,000 files and folders.
- files.RelocationError.duplicated_or_nested_paths – There are
duplicated/nested paths among
RelocationArg.from_path
andRelocationArg.to_path
. - files.RelocationError.cant_transfer_ownership – Your move operation
would result in an ownership transfer. You may reissue the request with
the field
RelocationArg.allow_ownership_transfer
to true. - files.RelocationError.insufficient_quota – The current user does not have enough space to move or copy the files.
- files.RelocationError.internal_error – Something went wrong with the job on Dropbox’s end. You’ll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.
- files.RelocationError.cant_move_shared_folder – Can’t move the shared folder to the given destination.
- RelocationError.cant_move_into_vault (MoveIntoVaultError) – Some content cannot be moved into Vault under certain circumstances, see detailed error.
- RelocationError.cant_move_into_family (MoveIntoFamilyError) – Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.
-
cant_move_folder_into_itself
= RelocationError(u'cant_move_folder_into_itself', None)¶
-
classmethod
cant_move_into_family
(val)¶ Create an instance of this class set to the
cant_move_into_family
tag with valueval
.Parameters: val (MoveIntoFamilyError) – Return type: RelocationError
-
classmethod
cant_move_into_vault
(val)¶ Create an instance of this class set to the
cant_move_into_vault
tag with valueval
.Parameters: val (MoveIntoVaultError) – Return type: RelocationError
-
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 valueval
.Parameters: val (LookupError) – Return type: RelocationError
-
classmethod
from_write
(val)¶ Create an instance of this class set to the
from_write
tag with valueval
.Parameters: val (WriteError) – Return type: RelocationError
-
get_cant_move_into_family
()¶ Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.
Only call this if
is_cant_move_into_family()
is true.Return type: MoveIntoFamilyError
-
get_cant_move_into_vault
()¶ Some content cannot be moved into Vault under certain circumstances, see detailed error.
Only call this if
is_cant_move_into_vault()
is true.Return type: MoveIntoVaultError
-
get_from_lookup
()¶ Only call this if
is_from_lookup()
is true.Return type: LookupError
-
get_from_write
()¶ Only call this if
is_from_write()
is true.Return type: WriteError
-
get_to
()¶ Only call this if
is_to()
is true.Return type: WriteError
-
insufficient_quota
= RelocationError(u'insufficient_quota', None)¶
-
internal_error
= RelocationError(u'internal_error', None)¶
Check if the union tag is
cant_copy_shared_folder
.Return type: bool
-
is_cant_move_folder_into_itself
()¶ Check if the union tag is
cant_move_folder_into_itself
.Return type: bool
-
is_cant_move_into_family
()¶ Check if the union tag is
cant_move_into_family
.Return type: bool
-
is_cant_move_into_vault
()¶ Check if the union tag is
cant_move_into_vault
.Return type: bool
Check if the union tag is
cant_move_shared_folder
.Return type: bool
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 valueval
.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: - files.RelocationPath.from_path – Path in the user’s Dropbox to be copied or moved.
- files.RelocationPath.to_path – Path in the user’s Dropbox that is the destination.
-
__init__
(from_path=None, to_path=None)¶ 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.
RemoveTagArg
(path=None, tag_text=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.RemoveTagArg.path – Path to the item to tag.
- files.RemoveTagArg.tag_text – The tag to remove. Will be automatically converted to lowercase letters.
-
__init__
(path=None, tag_text=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
path
¶
-
tag_text
¶
-
class
dropbox.files.
RemoveTagError
(tag, value=None)¶ Bases:
dropbox.files.BaseTagError
This class acts as a tagged union. Only one of the
is_*
methods will return true. To get the associated value of a tag (if one exists), use the correspondingget_*
method.Variables: files.RemoveTagError.tag_not_present – That tag doesn’t exist at this path. -
is_tag_not_present
()¶ Check if the union tag is
tag_not_present
.Return type: bool
-
tag_not_present
= RemoveTagError(u'tag_not_present', None)¶
-
-
class
dropbox.files.
RestoreArg
(path=None, rev=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.RestoreArg.path – The path to save the restored file.
- files.RestoreArg.rev – The revision to restore.
-
__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 correspondingget_*
method.Variables: - RestoreError.path_lookup (LookupError) – An error occurs when downloading metadata for the file.
- RestoreError.path_write (WriteError) – An error occurs when trying to restore the file to that path.
- files.RestoreError.invalid_revision – The revision is invalid. It may not exist or may point to a deleted file.
- files.RestoreError.in_progress – The restore is currently executing, but has not yet completed.
-
get_path_lookup
()¶ An error occurs when downloading metadata for the file.
Only call this if
is_path_lookup()
is true.Return type: LookupError
-
get_path_write
()¶ An error occurs when trying to restore the file to that path.
Only call this if
is_path_write()
is true.Return type: WriteError
-
in_progress
= RestoreError(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 valueval
.Parameters: val (LookupError) – Return type: RestoreError
-
classmethod
path_write
(val)¶ Create an instance of this class set to the
path_write
tag with valueval
.Parameters: val (WriteError) – Return type: RestoreError
-
class
dropbox.files.
SaveCopyReferenceArg
(copy_reference=None, path=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.SaveCopyReferenceArg.copy_reference – A copy reference returned
by
dropbox.dropbox_client.Dropbox.files_copy_reference_get()
. - files.SaveCopyReferenceArg.path – Path in the user’s Dropbox that is the destination.
-
__init__
(copy_reference=None, path=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
copy_reference
¶
-
path
¶
- files.SaveCopyReferenceArg.copy_reference – A copy reference returned
by
-
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 correspondingget_*
method.Variables: - files.SaveCopyReferenceError.invalid_copy_reference – The copy reference is invalid.
- files.SaveCopyReferenceError.no_permission – You don’t have permission to save the given copy reference. Please make sure this app is same app which created the copy reference and the source user is still linked to the app.
- files.SaveCopyReferenceError.not_found – The file referenced by the copy reference cannot be found.
- files.SaveCopyReferenceError.too_many_files – The operation would involve more than 10,000 files and folders.
-
get_path
()¶ Only call this if
is_path()
is true.Return type: WriteError
-
invalid_copy_reference
= SaveCopyReferenceError(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 valueval
.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: - files.SaveUrlArg.path – The path in Dropbox where the URL will be saved to.
- files.SaveUrlArg.url – The URL to be saved.
-
__init__
(path=None, url=None)¶ 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 correspondingget_*
method.Variables: - files.SaveUrlError.download_failed – Failed downloading the given URL. The URL may be password-protected and the password provided was incorrect, or the link may be disabled.
- files.SaveUrlError.invalid_url – The given URL is invalid.
- files.SaveUrlError.not_found – The file where the URL is saved to no longer exists.
-
download_failed
= SaveUrlError(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 valueval
.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 correspondingget_*
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 valueval
.Parameters: val (FileMetadata) – Return type: SaveUrlJobStatus
-
classmethod
failed
(val)¶ Create an instance of this class set to the
failed
tag with valueval
.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
-
classmethod
-
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 correspondingget_*
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 valueval
.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
-
classmethod
-
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 correspondingget_*
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 valueval
.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 valueval
.Parameters: val (LookupError) – Return type: SearchError
-
-
class
dropbox.files.
SearchMatch
(match_type=None, metadata=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.SearchMatch.match_type – The type of the match.
- files.SearchMatch.metadata – The metadata for the matched file or folder.
-
__init__
(match_type=None, metadata=None)¶ 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 correspondingget_*
method.Variables: - files.SearchMatchType.filename – This item was matched on its file or folder name.
- files.SearchMatchType.content – This item was matched based on its file contents.
- files.SearchMatchType.both – This item was matched based on both its contents and its file name.
-
both
= SearchMatchType(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 correspondingget_*
method.Variables: - files.SearchMatchTypeV2.filename – This item was matched on its file or folder name.
- files.SearchMatchTypeV2.file_content – This item was matched based on its file contents.
- files.SearchMatchTypeV2.filename_and_content – This item was matched based on both its contents and its file name.
- files.SearchMatchTypeV2.image_content – This item was matched on image content.
-
file_content
= SearchMatchTypeV2(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: - files.SearchMatchV2.metadata – The metadata for the matched file or folder.
- files.SearchMatchV2.match_type – The type of the match.
- files.SearchMatchV2.highlight_spans – The list of HighlightSpan determines which parts of the file title should be highlighted.
-
__init__
(metadata=None, match_type=None, highlight_spans=None)¶ 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 correspondingget_*
method.Variables: - files.SearchMode.filename – Search file and folder names.
- files.SearchMode.filename_and_content – Search file and folder names as well as file contents.
- files.SearchMode.deleted_filename – Search for deleted file and folder names.
-
deleted_filename
= SearchMode(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, account_id=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.SearchOptions.path – Scopes the search to a path in the user’s Dropbox. Searches the entire Dropbox if not specified.
- files.SearchOptions.max_results – The maximum number of search results to return.
- files.SearchOptions.order_by – Specified property of the order of search results. By default, results are sorted by relevance.
- files.SearchOptions.file_status – Restricts search to the given file status.
- files.SearchOptions.filename_only – Restricts search to only match on filenames.
- files.SearchOptions.file_extensions – Restricts search to only the extensions specified. Only supported for active file search.
- files.SearchOptions.file_categories – Restricts search to only the file categories specified. Only supported for active file search.
- files.SearchOptions.account_id – Restricts results to the given account id.
-
__init__
(path=None, max_results=None, order_by=None, file_status=None, filename_only=None, file_extensions=None, file_categories=None, account_id=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
account_id
¶
-
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 correspondingget_*
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: - files.SearchV2Arg.query – The string to search for. May match across multiple fields based on the request arguments.
- files.SearchV2Arg.options – Options for more targeted search results.
- files.SearchV2Arg.match_field_options – Options for search results match fields.
- files.SearchV2Arg.include_highlights – Deprecated and moved this option to SearchMatchFieldOptions.
-
__init__
(query=None, options=None, match_field_options=None, include_highlights=None)¶ 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: - files.SharedLink.url – Shared link url.
- files.SharedLink.password – Password for the shared link.
x.__init__(…) initializes x; see help(type(x)) for signature
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.
x.__init__(…) initializes x; see help(type(x)) for signature
-
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: - files.SingleUserLock.created – The time the lock was created.
- files.SingleUserLock.lock_holder_account_id – The account ID of the lock holder if known.
- files.SingleUserLock.lock_holder_team_id – The id of the team of the account holder if it exists.
-
__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 correspondingget_*
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 correspondingget_*
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 correspondingget_*
method.Variables: - files.SyncSettingsError.unsupported_combination – Setting this combination of sync settings simultaneously is not supported.
- files.SyncSettingsError.unsupported_configuration – The specified configuration is not supported.
-
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 valueval
.Parameters: val (LookupError) – Return type: SyncSettingsError
-
unsupported_combination
= SyncSettingsError(u'unsupported_combination', None)¶
-
unsupported_configuration
= SyncSettingsError(u'unsupported_configuration', None)¶
-
class
dropbox.files.
Tag
(tag, value=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Union
Tag that can be added in multiple ways.
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 correspondingget_*
method.Variables: Tag.user_generated_tag (UserGeneratedTag) – Tag generated by the user. -
get_user_generated_tag
()¶ Tag generated by the user.
Only call this if
is_user_generated_tag()
is true.Return type: UserGeneratedTag
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
is_user_generated_tag
()¶ Check if the union tag is
user_generated_tag
.Return type: bool
-
other
= Tag(u'other', None)¶
-
classmethod
user_generated_tag
(val)¶ Create an instance of this class set to the
user_generated_tag
tag with valueval
.Parameters: val (UserGeneratedTag) – Return type: Tag
-
-
class
dropbox.files.
ThumbnailArg
(path=None, format=None, size=None, mode=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.ThumbnailArg.path – The path to the image file you want to thumbnail.
- files.ThumbnailArg.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.ThumbnailArg.size – The size for the thumbnail image.
- files.ThumbnailArg.mode – How to resize and crop the image to achieve the desired size.
-
__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 correspondingget_*
method.Variables: - ThumbnailError.path (LookupError) – An error occurs when downloading metadata for the image.
- files.ThumbnailError.unsupported_extension – The file extension doesn’t allow conversion to a thumbnail.
- files.ThumbnailError.unsupported_image – The image cannot be converted to a thumbnail.
- files.ThumbnailError.conversion_error – An error occurs during thumbnail conversion.
-
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 valueval
.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 correspondingget_*
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 correspondingget_*
method.Variables: - files.ThumbnailMode.strict – Scale down the image to fit within the given size.
- files.ThumbnailMode.bestfit – Scale down the image to fit within the given size or its transpose.
- files.ThumbnailMode.fitone_bestfit – Scale down the image to completely cover the given size or its transpose.
-
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 correspondingget_*
method.Variables: - files.ThumbnailSize.w32h32 – 32 by 32 px.
- files.ThumbnailSize.w64h64 – 64 by 64 px.
- files.ThumbnailSize.w128h128 – 128 by 128 px.
- files.ThumbnailSize.w256h256 – 256 by 256 px.
- files.ThumbnailSize.w480h320 – 480 by 320 px.
- files.ThumbnailSize.w640h480 – 640 by 480 px.
- files.ThumbnailSize.w960h640 – 960 by 640 px.
- files.ThumbnailSize.w1024h768 – 1024 by 768 px.
- files.ThumbnailSize.w2048h1536 – 2048 by 1536 px.
-
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 correspondingget_*
method.Variables: - ThumbnailV2Error.path (LookupError) – An error occurred when downloading metadata for the image.
- files.ThumbnailV2Error.unsupported_extension – The file extension doesn’t allow conversion to a thumbnail.
- files.ThumbnailV2Error.unsupported_image – The image cannot be converted to a thumbnail.
- files.ThumbnailV2Error.conversion_error – An error occurred during thumbnail conversion.
- files.ThumbnailV2Error.access_denied – Access to this shared link is forbidden.
- files.ThumbnailV2Error.not_found – The shared link does not exist.
-
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 valueval
.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.
UploadArg
(path=None, mode=None, autorename=None, client_modified=None, mute=None, property_groups=None, strict_conflict=None, content_hash=None)¶ Bases:
dropbox.files.CommitInfo
Variables: files.UploadArg.content_hash – A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
-
__init__
(path=None, mode=None, autorename=None, client_modified=None, mute=None, property_groups=None, strict_conflict=None, content_hash=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
content_hash
¶
-
-
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 correspondingget_*
method.Variables: - UploadError.path (UploadWriteFailed) – Unable to save the uploaded contents to a file.
- UploadError.properties_error (InvalidPropertyGroupError) – The supplied property group is invalid. The file has uploaded without property groups.
- files.UploadError.payload_too_large – The request payload must be at most 150 MB.
- files.UploadError.content_hash_mismatch – The content received by the Dropbox server in this call does not match the provided content hash.
-
content_hash_mismatch
= UploadError(u'content_hash_mismatch', None)¶
-
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_content_hash_mismatch
()¶ Check if the union tag is
content_hash_mismatch
.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_payload_too_large
()¶ Check if the union tag is
payload_too_large
.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 valueval
.Parameters: val (UploadWriteFailed) – Return type: UploadError
-
payload_too_large
= UploadError(u'payload_too_large', None)¶
-
classmethod
properties_error
(val)¶ Create an instance of this class set to the
properties_error
tag with valueval
.Parameters: val (file_properties.InvalidPropertyGroupError) – Return type: UploadError
-
class
dropbox.files.
UploadSessionAppendArg
(cursor=None, close=None, content_hash=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.UploadSessionAppendArg.cursor – Contains the upload session ID and the offset.
- files.UploadSessionAppendArg.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.UploadSessionAppendArg.content_hash –
A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
-
__init__
(cursor=None, close=None, content_hash=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
close
¶
-
content_hash
¶
-
cursor
¶
-
class
dropbox.files.
UploadSessionAppendError
(tag, value=None)¶ Bases:
dropbox.files.UploadSessionLookupError
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 correspondingget_*
method.Variables: files.UploadSessionAppendError.content_hash_mismatch – The content received by the Dropbox server in this call does not match the provided content hash. -
content_hash_mismatch
= UploadSessionAppendError(u'content_hash_mismatch', None)¶
-
is_content_hash_mismatch
()¶ Check if the union tag is
content_hash_mismatch
.Return type: bool
-
-
class
dropbox.files.
UploadSessionCursor
(session_id=None, offset=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.UploadSessionCursor.session_id – The upload session ID (returned
by
dropbox.dropbox_client.Dropbox.files_upload_session_start()
). - files.UploadSessionCursor.offset – Offset in bytes at which data should be appended. We use this to make sure upload data isn’t lost or duplicated in the event of a network error.
-
__init__
(session_id=None, offset=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
offset
¶
-
session_id
¶
- files.UploadSessionCursor.session_id – The upload session ID (returned
by
-
class
dropbox.files.
UploadSessionFinishArg
(cursor=None, commit=None, content_hash=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.UploadSessionFinishArg.cursor – Contains the upload session ID and the offset.
- files.UploadSessionFinishArg.commit – Contains the path and other optional modifiers for the commit.
- files.UploadSessionFinishArg.content_hash –
A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
-
__init__
(cursor=None, commit=None, content_hash=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
commit
¶
-
content_hash
¶
-
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 correspondingget_*
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 valueval
.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 correspondingget_*
method.-
classmethod
complete
(val)¶ Create an instance of this class set to the
complete
tag with valueval
.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)¶
-
classmethod
-
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 insideUploadSessionFinishBatchResult.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 correspondingget_*
method.-
classmethod
failure
(val)¶ Create an instance of this class set to the
failure
tag with valueval
.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 valueval
.Parameters: val (FileMetadata) – Return type: UploadSessionFinishBatchResultEntry
-
classmethod
-
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 correspondingget_*
method.Variables: - UploadSessionFinishError.lookup_failed (UploadSessionLookupError) – The session arguments are incorrect; the value explains the reason.
- UploadSessionFinishError.path (WriteError) – 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.
- UploadSessionFinishError.properties_error (InvalidPropertyGroupError) – The supplied property group is invalid. The file has uploaded without property groups.
- files.UploadSessionFinishError.too_many_shared_folder_targets – The batch request commits files into too many different shared folders. Please limit your batch request to files contained in a single shared folder.
- files.UploadSessionFinishError.too_many_write_operations – There are too many write operations happening in the user’s Dropbox. You should retry uploading this file.
- files.UploadSessionFinishError.concurrent_session_data_not_allowed – Uploading data not allowed when finishing concurrent upload session.
- files.UploadSessionFinishError.concurrent_session_not_closed – Concurrent upload sessions need to be closed before finishing.
- files.UploadSessionFinishError.concurrent_session_missing_data – Not all pieces of data were uploaded before trying to finish the session.
- files.UploadSessionFinishError.payload_too_large – The request payload must be at most 150 MB.
- files.UploadSessionFinishError.content_hash_mismatch – The content received by the Dropbox server in this call does not match the provided content hash.
-
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)¶
-
content_hash_mismatch
= UploadSessionFinishError(u'content_hash_mismatch', 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_content_hash_mismatch
()¶ Check if the union tag is
content_hash_mismatch
.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_payload_too_large
()¶ Check if the union tag is
payload_too_large
.Return type: bool
-
is_properties_error
()¶ Check if the union tag is
properties_error
.Return type: bool
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 valueval
.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 valueval
.Parameters: val (WriteError) – Return type: UploadSessionFinishError
-
payload_too_large
= UploadSessionFinishError(u'payload_too_large', None)¶
-
classmethod
properties_error
(val)¶ Create an instance of this class set to the
properties_error
tag with valueval
.Parameters: val (file_properties.InvalidPropertyGroupError) – Return type: UploadSessionFinishError
-
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 correspondingget_*
method.Variables: - files.UploadSessionLookupError.not_found – The upload session ID was not found or has expired. Upload sessions are valid for 7 days.
- UploadSessionLookupError.incorrect_offset (UploadSessionOffsetError) – 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.
- files.UploadSessionLookupError.closed – You are attempting to append data to an upload session that has already been closed (i.e. committed).
- files.UploadSessionLookupError.not_closed – The session must be closed before calling upload_session/finish_batch.
- files.UploadSessionLookupError.too_large – You can not append to the upload session because the size of a file should not reach the max file size limit (i.e. 350GB).
- files.UploadSessionLookupError.concurrent_session_invalid_offset – For concurrent upload sessions, offset needs to be multiple of 4194304 bytes.
- files.UploadSessionLookupError.concurrent_session_invalid_data_size – For concurrent upload sessions, only chunks with size multiple of 4194304 bytes can be uploaded.
- files.UploadSessionLookupError.payload_too_large – The request payload must be at most 150 MB.
-
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 valueval
.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_payload_too_large
()¶ Check if the union tag is
payload_too_large
.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)¶
-
payload_too_large
= UploadSessionLookupError(u'payload_too_large', 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, content_hash=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
. - files.UploadSessionStartArg.content_hash –
A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
-
__init__
(close=None, session_type=None, content_hash=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
close
¶
-
content_hash
¶
-
session_type
¶
- files.UploadSessionStartArg.close – If true, the current session will
be closed, at which point you won’t be able to call
-
class
dropbox.files.
UploadSessionStartBatchArg
(num_sessions=None, session_type=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: - files.UploadSessionStartBatchArg.session_type – Type of upload session
you want to start. If not specified, default is
UploadSessionType.sequential
. - files.UploadSessionStartBatchArg.num_sessions – The number of upload sessions to start.
-
__init__
(num_sessions=None, session_type=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
num_sessions
¶
-
session_type
¶
- files.UploadSessionStartBatchArg.session_type – Type of upload session
you want to start. If not specified, default is
-
class
dropbox.files.
UploadSessionStartBatchResult
(session_ids=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
Variables: files.UploadSessionStartBatchResult.session_ids – A List of unique identifiers for the upload session. Pass each session_id to dropbox.dropbox_client.Dropbox.files_upload_session_append()
anddropbox.dropbox_client.Dropbox.files_upload_session_finish()
.-
__init__
(session_ids=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
session_ids
¶
-
-
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 correspondingget_*
method.Variables: - files.UploadSessionStartError.concurrent_session_data_not_allowed – Uploading data not allowed when starting concurrent upload session.
- files.UploadSessionStartError.concurrent_session_close_not_allowed – Can not start a closed concurrent upload session.
- files.UploadSessionStartError.payload_too_large – The request payload must be at most 150 MB.
- files.UploadSessionStartError.content_hash_mismatch – The content received by the Dropbox server in this call does not match the provided content hash.
-
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)¶
-
content_hash_mismatch
= UploadSessionStartError(u'content_hash_mismatch', 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_content_hash_mismatch
()¶ Check if the union tag is
content_hash_mismatch
.Return type: bool
-
is_other
()¶ Check if the union tag is
other
.Return type: bool
-
is_payload_too_large
()¶ Check if the union tag is
payload_too_large
.Return type: bool
-
other
= UploadSessionStartError(u'other', None)¶
-
payload_too_large
= UploadSessionStartError(u'payload_too_large', 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()
anddropbox.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 correspondingget_*
method.Variables: - files.UploadSessionType.sequential – Pieces of data are uploaded sequentially one after another. This is the default behavior.
- files.UploadSessionType.concurrent – Pieces of data can be uploaded in concurrent RPCs in any order.
-
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: - files.UploadWriteFailed.reason – The reason why the file couldn’t be saved.
- files.UploadWriteFailed.upload_session_id – The upload session ID; data
has already been uploaded to the corresponding upload session and this
ID may be used to retry the commit with
dropbox.dropbox_client.Dropbox.files_upload_session_finish()
.
-
__init__
(reason=None, upload_session_id=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
reason
¶
-
upload_session_id
¶
-
class
dropbox.files.
UserGeneratedTag
(tag_text=None)¶ Bases:
stone.backends.python_rsrc.stone_base.Struct
-
__init__
(tag_text=None)¶ x.__init__(…) initializes x; see help(type(x)) for signature
-
tag_text
¶
-
-
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 correspondingget_*
method.Variables: - files.WriteConflictError.file – There’s a file in the way.
- files.WriteConflictError.folder – There’s a folder in the way.
- files.WriteConflictError.file_ancestor – There’s a file at an ancestor path, so we couldn’t create the required parent folders.
-
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 correspondingget_*
method.Variables: - files.WriteError.malformed_path (Optional[str]) – The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information.
- WriteError.conflict (WriteConflictError) – Couldn’t write to the target path because there was something in the way.
- files.WriteError.no_write_permission – The user doesn’t have permissions to write to the target location.
- files.WriteError.insufficient_space – The user doesn’t have enough available space (bytes) to write more data.
- files.WriteError.disallowed_name – Dropbox will not save the file or folder because of its name.
- files.WriteError.team_folder – This endpoint cannot move or delete team folders.
- files.WriteError.operation_suppressed – This file operation is not allowed at this path.
- files.WriteError.too_many_write_operations – There are too many write operations in user’s Dropbox. Please retry this request.
-
classmethod
conflict
(val)¶ Create an instance of this class set to the
conflict
tag with valueval
.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 valueval
.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 correspondingget_*
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 supplied value should be the latest known “rev” of the file, for example, from :type:`FileMetadata`, from when the file was last downloaded by the app. This will cause the file on the Dropbox servers to be overwritten if the given “rev” matches the existing file’s current “rev” on the Dropbox servers. 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 supplied value should be the latest known “rev” of the file, for example, from
FileMetadata
, from when the file was last downloaded by the app. This will cause the file on the Dropbox servers to be overwritten if the given “rev” matches the existing file’s current “rev” on the Dropbox servers. 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)¶