module documentation
This namespace contains endpoints and data types for basic file operations.
Class |
|
:ivar files.AddTagArg.path: Path to the item to be tagged. :ivar files.AddTagArg.tag_text: The value of the tag to add. Will be automatically converted to lowercase letters. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.AlphaGetMetadataArg.include_property_templates: If set to a valid list of template IDs, ``FileMetadata.property_groups`` is set for files with custom properties. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.CommitInfo.path: Path in the user's Dropbox to save the file. :ivar files.CommitInfo.mode: Selects what to do if the file already exists. :ivar files.CommitInfo.autorename: If there's a conflict, as determined by ``mode``, have the Dropbox server try to autorename the file to avoid conflict... |
Class |
|
:ivar files.ContentSyncSetting.id: Id of the item this setting is applied to. :ivar files.ContentSyncSetting.sync_setting: Setting for this item. |
Class |
|
:ivar files.ContentSyncSettingArg.id: Id of the item this setting is applied to. :ivar files.ContentSyncSettingArg.sync_setting: Setting for this item. |
Class |
|
:ivar files.CreateFolderArg.path: Path in the user's Dropbox to create. :ivar files.CreateFolderArg.autorename: If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict. |
Class |
|
:ivar files.CreateFolderBatchArg.paths: List of paths to be created in the user's Dropbox. Duplicate path arguments in the batch are considered only once. :ivar files.CreateFolderBatchArg.autorename: If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
Result returned by :meth:`dropbox.dropbox_client.Dropbox.files_create_folder_batch` that may either launch an asynchronous job or complete synchronously. |
Class |
|
:ivar files.CreateFolderBatchResult.entries: Each entry in ``CreateFolderBatchArg.paths`` will appear at the same position inside ``CreateFolderBatchResult.entries``. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.CreateFolderEntryResult.metadata: Metadata of the created folder. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.CreateFolderResult.metadata: Metadata of the created folder. |
Class |
|
:ivar files.DeleteArg.path: Path in the user's Dropbox to delete. :ivar files.DeleteArg.parent_rev: Perform delete if given "rev" matches the existing file's latest "rev". This field does not support deleting a folder. |
Class |
|
Undocumented |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
Result returned by :meth:`dropbox.dropbox_client.Dropbox.files_delete_batch` that may either launch an asynchronous job or complete synchronously. |
Class |
|
:ivar files.DeleteBatchResult.entries: Each entry in ``DeleteBatchArg.entries`` will appear at the same position inside ``DeleteBatchResult.entries``. |
Class |
|
:ivar files.DeleteBatchResultData.metadata: Metadata of the deleted object. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
Indicates that there used to be a file or folder at this path, but it no longer exists. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.DeleteResult.metadata: Metadata of the deleted object. |
Class |
|
Dimensions for a photo or video. |
Class |
|
:ivar files.DownloadArg.path: The path of the file to download. :ivar files.DownloadArg.rev: Please specify revision in ``path`` instead. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.DownloadZipArg.path: The path of the folder to download. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
Undocumented |
Class |
|
:ivar files.ExportArg.path: The path of the file to be exported. :ivar 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 :meth:`dropbox... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
Export information for a file. |
Class |
|
:ivar files.ExportMetadata.name: The last component of the path (including extension). This never contains a slash. :ivar files.ExportMetadata.size: The file size in bytes. :ivar files.ExportMetadata... |
Class |
|
:ivar files.ExportResult.export_metadata: Metadata for the exported version of the file. :ivar files.ExportResult.file_metadata: Metadata for the original file. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.FileLock.content: The lock description. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.FileLockMetadata.is_lockholder: True if caller holds the file lock. :ivar files.FileLockMetadata.lockholder_name: The display name of the lock holder. :ivar files.FileLockMetadata.lockholder_account_id: The account ID of the lock holder if known... |
Class |
|
:ivar files.FileMetadata.id: A unique identifier for the file. :ivar files.FileMetadata.client_modified: For files, this is the modification time set by the desktop client when the file was added to Dropbox... |
Class |
|
Undocumented |
Class |
|
Sharing info for a file which is contained by a shared folder. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.FolderMetadata.id: A unique identifier for the folder. :ivar files.FolderMetadata.shared_folder_id: Please use ``sharing_info`` instead. :ivar files.FolderMetadata.sharing_info: Set if the folder is contained in a shared folder or is a shared folder mount point... |
Class |
|
Sharing info for a folder which is contained in a shared folder or is a shared folder mount point. |
Class |
|
:ivar files.GetCopyReferenceArg.path: The path to the file or folder you want to get a copy reference to. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.GetCopyReferenceResult.metadata: Metadata of the file or folder. :ivar files.GetCopyReferenceResult.copy_reference: A copy reference to the file or folder. :ivar files.GetCopyReferenceResult... |
Class |
|
:ivar files.GetMetadataArg.path: The path of a file or folder on Dropbox. :ivar files.GetMetadataArg.include_media_info: If true, ``FileMetadata.media_info`` is set for photo and video. :ivar files... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.GetTagsArg.paths: Path to the items. |
Class |
|
:ivar files.GetTagsResult.paths_to_tags: List of paths and their corresponding tags. |
Class |
|
:ivar files.GetTemporaryLinkArg.path: The path to the file you want a temporary link to. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.GetTemporaryLinkResult.metadata: Metadata of the file. :ivar files.GetTemporaryLinkResult.link: The temporary link which can be used to stream content the file. |
Class |
|
:ivar files.GetTemporaryUploadLinkArg.commit_info: Contains the path and other optional modifiers for the future upload commit. Equivalent to the parameters provided to :meth:`dropbox.dropbox_client... |
Class |
|
:ivar files.GetTemporaryUploadLinkResult.link: The temporary link which can be used to stream a file to a Dropbox location. |
Class |
|
Arguments for :meth:`dropbox.dropbox_client.Dropbox.files_get_thumbnail_batch`. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.GetThumbnailBatchResult.entries: List of files and their thumbnails. |
Class |
|
:ivar files.GetThumbnailBatchResultData.thumbnail: A string containing the base64-encoded thumbnail data for this file. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
GPS coordinates for a photo or video. |
Class |
|
:ivar files.HighlightSpan.highlight_str: String to be determined whether it should be highlighted or not. :ivar files.HighlightSpan.is_highlighted: The string should be highlighted or not. |
Class |
|
The import format of the incoming Paper doc content. |
Class |
|
:ivar files.ListFolderArg.path: A unique identifier for the file. :ivar 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... |
Class |
|
:ivar files.ListFolderContinueArg.cursor: The cursor returned by your last call to :meth:`dropbox.dropbox_client.Dropbox.files_list_folder` or :meth:`dropbox.dropbox_client.Dropbox.files_list_folder_continue`. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.ListFolderGetLatestCursorResult.cursor: Pass the cursor into :meth:`dropbox.dropbox_client.Dropbox.files_list_folder_continue` to see what's changed in the folder since your previous query. |
Class |
|
:ivar files.ListFolderLongpollArg.cursor: A cursor as returned by :meth:`dropbox.dropbox_client.Dropbox.files_list_folder` or :meth:`dropbox.dropbox_client.Dropbox.files_list_folder_continue`. ... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.ListFolderLongpollResult.changes: Indicates whether new changes are available. If true, call :meth:`dropbox.dropbox_client.Dropbox.files_list_folder_continue` to retrieve the changes... |
Class |
|
:ivar files.ListFolderResult.entries: The files and (direct) subfolders in the folder. :ivar files.ListFolderResult.cursor: Pass the cursor into :meth:`dropbox.dropbox_client.Dropbox.files_list_folder_continue` to see what's changed in the folder since your previous query... |
Class |
|
:ivar files.ListRevisionsArg.path: The path to the file you want to see the revisions of. :ivar files.ListRevisionsArg.mode: Determines the behavior of the API in listing the revisions for a given file path or id... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.ListRevisionsResult.is_deleted: If the file identified by the latest revision in the response is either deleted or moved. :ivar files.ListRevisionsResult.server_deleted: The time of deletion if the file was deleted... |
Class |
|
:ivar files.LockConflictError.lock: The lock that caused the conflict. |
Class |
|
:ivar files.LockFileArg.path: Path in the user's Dropbox to a file. |
Class |
|
:ivar 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. |
Class |
|
:ivar 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. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.LockFileResult.metadata: Metadata of the file. :ivar files.LockFileResult.lock: The file lock state after the operation. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
Metadata for a photo or video. |
Class |
|
Metadata for a file or folder. |
Class |
|
Metadata for a file, folder or other resource types. |
Class |
|
:ivar files.MinimalFileLinkMetadata.url: URL of the shared link. :ivar files.MinimalFileLinkMetadata.id: Unique identifier for the linked file. :ivar files.MinimalFileLinkMetadata.path: Full path in the user's Dropbox... |
Class |
|
:ivar 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. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar 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... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.PaperCreateResult.url: URL to open the Paper Doc. :ivar files.PaperCreateResult.result_path: The fully qualified path the Paper Doc was actually created at. :ivar files.PaperCreateResult... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar 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. :ivar files.PaperUpdateArg.import_format: The format of the provided data... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.PaperUpdateResult.paper_revision: The current doc revision. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.PathToTags.path: Path of the item. :ivar files.PathToTags.tags: Tags assigned to this item. |
Class |
|
Metadata for a photo. |
Class |
|
:ivar files.PreviewArg.path: The path of the file to preview. :ivar files.PreviewArg.rev: Please specify revision in ``path`` instead. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar 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). :ivar files.PreviewResult... |
Class |
|
:ivar files.RelocationArg.allow_shared_folder: This flag has no effect. :ivar files.RelocationArg.autorename: If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict... |
Class |
|
:ivar files.RelocationBatchArg.allow_shared_folder: This flag has no effect. :ivar files.RelocationBatchArg.allow_ownership_transfer: Allow moves by owner even if it would result in an ownership transfer for the content being moved... |
Class |
|
:ivar files.RelocationBatchArgBase.entries: List of entries to be moved or copied. Each entry is :class:`RelocationPath`. :ivar files.RelocationBatchArgBase.autorename: If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
Result returned by :meth:`dropbox.dropbox_client.Dropbox.files_copy_batch` or :meth:`dropbox.dropbox_client.Dropbox.files_move_batch` that may either launch an asynchronous job or complete synchronously. |
Class |
|
Undocumented |
Class |
|
:ivar files.RelocationBatchResultData.metadata: Metadata of the relocated object. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
Result returned by :meth:`dropbox.dropbox_client.Dropbox.files_copy_batch_check` or :meth:`dropbox.dropbox_client.Dropbox.files_move_batch_check` that may either be in progress or completed with result for each entry. |
Class |
|
Result returned by :meth:`dropbox.dropbox_client.Dropbox.files_copy_batch` or :meth:`dropbox.dropbox_client.Dropbox.files_move_batch` that may either launch an asynchronous job or complete synchronously. |
Class |
|
:ivar files.RelocationBatchV2Result.entries: Each entry in CopyBatchArg.entries or ``MoveBatchArg.entries`` will appear at the same position inside ``RelocationBatchV2Result.entries``. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.RelocationPath.from_path: Path in the user's Dropbox to be copied or moved. :ivar files.RelocationPath.to_path: Path in the user's Dropbox that is the destination. |
Class |
|
:ivar files.RelocationResult.metadata: Metadata of the relocated object. |
Class |
|
:ivar files.RemoveTagArg.path: Path to the item to tag. :ivar files.RemoveTagArg.tag_text: The tag to remove. Will be automatically converted to lowercase letters. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.RestoreArg.path: The path to save the restored file. :ivar files.RestoreArg.rev: The revision to restore. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.SaveCopyReferenceArg.copy_reference: A copy reference returned by :meth:`dropbox.dropbox_client.Dropbox.files_copy_reference_get`. :ivar files.SaveCopyReferenceArg.path: Path in the user's Dropbox that is the destination. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.SaveCopyReferenceResult.metadata: The metadata of the saved file or folder in the user's Dropbox. |
Class |
|
:ivar files.SaveUrlArg.path: The path in Dropbox where the URL will be saved to. :ivar files.SaveUrlArg.url: The URL to be saved. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.SearchArg.path: The path in the user's Dropbox to search. Should probably be a folder. :ivar files.SearchArg.query: The string to search for. Query string may be rewritten to improve relevance of results... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.SearchMatch.match_type: The type of the match. :ivar files.SearchMatch.metadata: The metadata for the matched file or folder. |
Class |
|
:ivar files.SearchMatchFieldOptions.include_highlights: Whether to include highlight span from file title. |
Class |
|
Indicates what type of match was found for a given item. |
Class |
|
Indicates what type of match was found for a given item. |
Class |
|
:ivar files.SearchMatchV2.metadata: The metadata for the matched file or folder. :ivar files.SearchMatchV2.match_type: The type of the match. :ivar files.SearchMatchV2.highlight_spans: The list of HighlightSpan determines which parts of the file title should be highlighted. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.SearchOptions.path: Scopes the search to a path in the user's Dropbox. Searches the entire Dropbox if not specified. :ivar files.SearchOptions.max_results: The maximum number of search results to return... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.SearchResult.matches: A list (possibly empty) of matches for the query. :ivar files.SearchResult.more: Used for paging. If true, indicates there is another page of results available that can be fetched by calling :meth:`dropbox... |
Class |
|
:ivar files.SearchV2Arg.query: The string to search for. May match across multiple fields based on the request arguments. :ivar files.SearchV2Arg.options: Options for more targeted search results. ... |
Class |
|
:ivar files.SearchV2ContinueArg.cursor: The cursor returned by your last call to :meth:`dropbox.dropbox_client.Dropbox.files_search`. Used to fetch the next page of results. |
Class |
|
:ivar files.SearchV2Result.matches: A list (possibly empty) of matches for the query. :ivar files.SearchV2Result.has_more: Used for paging. If true, indicates there is another page of results available that can be fetched by calling :meth:`dropbox... |
Class |
|
:ivar files.SharedLink.url: Shared link url. :ivar files.SharedLink.password: Password for the shared link. |
Class |
|
:ivar 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... |
Class |
|
Sharing info for a file or folder. |
Class |
|
:ivar files.SingleUserLock.created: The time the lock was created. :ivar files.SingleUserLock.lock_holder_account_id: The account ID of the lock holder if known. :ivar files.SingleUserLock.lock_holder_team_id: The id of the team of the account holder if it exists. |
Class |
|
:ivar files.SymlinkInfo.target: The target this symlink points to. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
Tag that can be added in multiple ways. |
Class |
|
:ivar files.ThumbnailArg.path: The path to the image file you want to thumbnail. :ivar 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... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar 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... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.UnlockFileArg.path: Path in the user's Dropbox to a file. |
Class |
|
:ivar 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. |
Class |
|
:ivar 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 <https://www... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.UploadSessionAppendArg.cursor: Contains the upload session ID and the offset. :ivar files.UploadSessionAppendArg.close: If true, the current session will be closed, at which point you won't be able to call :meth:`dropbox... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.UploadSessionCursor.session_id: The upload session ID (returned by :meth:`dropbox.dropbox_client.Dropbox.files_upload_session_start`). :ivar files.UploadSessionCursor.offset: Offset in bytes at which data should be appended... |
Class |
|
:ivar files.UploadSessionFinishArg.cursor: Contains the upload session ID and the offset. :ivar files.UploadSessionFinishArg.commit: Contains the path and other optional modifiers for the commit... |
Class |
|
:ivar files.UploadSessionFinishBatchArg.entries: Commit information for each file in the batch. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
Result returned by :meth:`dropbox.dropbox_client.Dropbox.files_upload_session_finish_batch` that may either launch an asynchronous job or complete synchronously. |
Class |
|
:ivar files.UploadSessionFinishBatchResult.entries: Each entry in ``UploadSessionFinishBatchArg.entries`` will appear at the same position inside ``UploadSessionFinishBatchResult.entries``. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.UploadSessionOffsetError.correct_offset: The offset up to which data has been collected. |
Class |
|
:ivar files.UploadSessionStartArg.close: If true, the current session will be closed, at which point you won't be able to call :meth:`dropbox.dropbox_client.Dropbox.files_upload_session_append` anymore with the current session... |
Class |
|
:ivar files.UploadSessionStartBatchArg.session_type: Type of upload session you want to start. If not specified, default is ``UploadSessionType.sequential``. :ivar files.UploadSessionStartBatchArg... |
Class |
|
:ivar files.UploadSessionStartBatchResult.session_ids: A List of unique identifiers for the upload session. Pass each session_id to :meth:`dropbox.dropbox_client.Dropbox.files_upload_session_append` and :meth:`dropbox... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.UploadSessionStartResult.session_id: A unique identifier for the upload session. Pass this to :meth:`dropbox.dropbox_client.Dropbox.files_upload_session_append` and :meth:`dropbox... |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
:ivar files.UploadWriteFailed.reason: The reason why the file couldn't be saved. :ivar 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 :meth:`dropbox... |
Class |
|
Undocumented |
Class |
|
Metadata for a video. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. |
Class |
|
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... |
Constant | ROUTES |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | alpha |
Undocumented |
Variable | alpha |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | copy |
Undocumented |
Variable | copy |
Undocumented |
Variable | copy |
Undocumented |
Variable | copy |
Undocumented |
Variable | copy |
Undocumented |
Variable | copy |
Undocumented |
Variable | copy |
Undocumented |
Variable | copy |
Undocumented |
Variable | create |
Undocumented |
Variable | create |
Undocumented |
Variable | create |
Undocumented |
Variable | create |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | delete |
Undocumented |
Variable | delete |
Undocumented |
Variable | delete |
Undocumented |
Variable | delete |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | download |
Undocumented |
Variable | download |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | export |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | get |
Undocumented |
Variable | get |
Undocumented |
Variable | get |
Undocumented |
Variable | get |
Undocumented |
Variable | get |
Undocumented |
Variable | get |
Undocumented |
Variable | get |
Undocumented |
Variable | get |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | list |
Undocumented |
Variable | list |
Undocumented |
Variable | list |
Undocumented |
Variable | list |
Undocumented |
Variable | list |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | lock |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | move |
Undocumented |
Variable | move |
Undocumented |
Variable | move |
Undocumented |
Variable | move |
Undocumented |
Variable | move |
Undocumented |
Variable | move |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | paper |
Undocumented |
Variable | paper |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | permanently |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | properties |
Undocumented |
Variable | properties |
Undocumented |
Variable | properties |
Undocumented |
Variable | properties |
Undocumented |
Variable | properties |
Undocumented |
Variable | properties |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | restore |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | save |
Undocumented |
Variable | save |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | search |
Undocumented |
Variable | search |
Undocumented |
Variable | search |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | tags |
Undocumented |
Variable | tags |
Undocumented |
Variable | tags |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | unlock |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable | upload |
Undocumented |
Variable | upload |
Undocumented |
Variable | upload |
Undocumented |
Variable | upload |
Undocumented |
Variable | upload |
Undocumented |
Variable | upload |
Undocumented |
Variable | upload |
Undocumented |
Variable | upload |
Undocumented |
Variable | upload |
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Variable |
|
Undocumented |
Undocumented
Value |
|