class documentation

class FileMetadata(Metadata): (source)

View In Hierarchy

: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. 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. :ivar files.FileMetadata.server_modified: The last time the file was modified on Dropbox. :ivar 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. :ivar files.FileMetadata.size: The file size in bytes. :ivar files.FileMetadata.media_info: Additional information if the file is a photo or video. This field will not be set on entries returned by :meth:`dropbox.dropbox_client.Dropbox.files_list_folder`, :meth:`dropbox.dropbox_client.Dropbox.files_list_folder_continue`, or :meth:`dropbox.dropbox_client.Dropbox.files_get_thumbnail_batch`, starting December 2, 2019. :ivar files.FileMetadata.symlink_info: Set if this file is a symlink. :ivar files.FileMetadata.sharing_info: Set if this file is contained in a shared folder. :ivar files.FileMetadata.is_downloadable: If true, file can be downloaded directly; else the file must be exported. :ivar 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. :ivar files.FileMetadata.property_groups: Additional information if the file has custom properties with the property template specified. :ivar files.FileMetadata.has_explicit_shared_members: This flag will only be present if include_has_explicit_shared_members is true in :meth:`dropbox.dropbox_client.Dropbox.files_list_folder` or :meth:`dropbox.dropbox_client.Dropbox.files_get_metadata`. If this flag is present, it will be true if this file has any explicit shared members. This is different from sharing_info in that this could be true in the case where a file has explicit members but is not contained within a shared folder. :ivar 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 <https://www.dropbox.com/developers/reference/content-hash>`_ page. :ivar files.FileMetadata.file_lock_info: If present, the metadata associated with the file's current lock.

Method __init__ Undocumented
Class Variable __slots__ Undocumented
Instance Variable client_modified Undocumented
Instance Variable content_hash Undocumented
Instance Variable export_info Undocumented
Instance Variable file_lock_info Undocumented
Instance Variable has_explicit_shared_members Undocumented
Instance Variable id Undocumented
Instance Variable is_downloadable Undocumented
Instance Variable media_info Undocumented
Instance Variable property_groups Undocumented
Instance Variable rev Undocumented
Instance Variable server_modified Undocumented
Instance Variable sharing_info Undocumented
Instance Variable size Undocumented
Instance Variable symlink_info Undocumented
Method _process_custom_annotations Undocumented
Class Variable _has_required_fields Undocumented
Instance Variable _client_modified_value Undocumented
Instance Variable _content_hash_value Undocumented
Instance Variable _export_info_value Undocumented
Instance Variable _file_lock_info_value Undocumented
Instance Variable _has_explicit_shared_members_value Undocumented
Instance Variable _id_value Undocumented
Instance Variable _is_downloadable_value Undocumented
Instance Variable _media_info_value Undocumented
Instance Variable _property_groups_value Undocumented
Instance Variable _rev_value Undocumented
Instance Variable _server_modified_value Undocumented
Instance Variable _sharing_info_value Undocumented
Instance Variable _size_value Undocumented
Instance Variable _symlink_info_value Undocumented

Inherited from Metadata:

Instance Variable name Undocumented
Instance Variable parent_shared_folder_id Undocumented
Instance Variable path_display Undocumented
Instance Variable path_lower Undocumented
Instance Variable preview_url Undocumented
Instance Variable _name_value Undocumented
Instance Variable _parent_shared_folder_id_value Undocumented
Instance Variable _path_display_value Undocumented
Instance Variable _path_lower_value Undocumented
Instance Variable _preview_url_value Undocumented
def __init__(self, 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): (source)

Undocumented

__slots__: list[str] = (source)

Undocumented

client_modified = (source)

Undocumented

content_hash = (source)

Undocumented

export_info = (source)

Undocumented

file_lock_info = (source)

Undocumented

has_explicit_shared_members = (source)

Undocumented

Undocumented

is_downloadable = (source)

Undocumented

media_info = (source)

Undocumented

property_groups = (source)

Undocumented

Undocumented

server_modified = (source)

Undocumented

sharing_info = (source)

Undocumented

Undocumented

symlink_info = (source)

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)
_has_required_fields: bool = (source)
_client_modified_value = (source)

Undocumented

_content_hash_value = (source)

Undocumented

_export_info_value = (source)

Undocumented

_file_lock_info_value = (source)

Undocumented

_has_explicit_shared_members_value = (source)

Undocumented

_id_value = (source)

Undocumented

_is_downloadable_value = (source)

Undocumented

_media_info_value = (source)

Undocumented

_property_groups_value = (source)

Undocumented

_rev_value = (source)

Undocumented

_server_modified_value = (source)

Undocumented

_sharing_info_value = (source)

Undocumented

_size_value = (source)

Undocumented

_symlink_info_value = (source)

Undocumented