Concepts

Concepts used in Dropbox book.

The following documentation is for Dropbox v1.0.4 (BDK).

Dropbox folder metadata

Metadata for a folder in Dropbox.

Field Name	Description	Type
name	The name of the folder.	text
id	The unique ID of the folder.	text
tag	The type of the metadata object, always ".folder".	optional[text]
path_lower	The lowercased path of the folder in the user's Dropbox (optional).	optional[text]
path_display	The display-friendly path of the folder in the user's Dropbox (optional).	optional[text]
property_groups	A list of property groups associated with the folder (optional).	optional[list of dropbox property group]
sharing_info	Sharing information for the folder (optional).	optional[dropbox folder sharing info]

Dropbox property group

A group of properties associated with a file.

Field Name	Description	Type
template_id	The identifier of the property group template.	text
fields	A list of property fields.	list of dropbox property group field

Dropbox folder sharing info

Sharing information for a folder.

Field Name	Description	Type
read_only	True if the folder is read-only.	boolean
parent_shared_folder_id	The ID of the parent shared folder (optional).	optional[text]
shared_folder_id	The ID of the shared folder (optional).	optional[text]
traverse_only	True if the user can only traverse the folder (optional).	optional[boolean]
no_access	True if the user has no access to the folder (optional).	optional[boolean]

Dropbox file metadata

Metadata for a file in Dropbox.

Field Name	Description	Type
name	The name of the file.	text
id	The unique ID of the file.	text
client_modified	The client's last modification timestamp (ISO 8601 UTC).	text
server_modified	The server's last modification timestamp (ISO 8601 UTC).	text
rev	A unique revision identifier for the file.	text
size	The size of the file in bytes.	number
is_downloadable	True if the file is downloadable.	boolean
tag	The type of the metadata object, always ".file".	optional[text]
path_lower	The lowercased path of the file in the user's Dropbox (optional).	optional[text]
path_display	The display-friendly path of the file in the user's Dropbox (optional).	optional[text]
property_groups	A list of property groups associated with the file (optional).	optional[list of dropbox property group]
sharing_info	Sharing information for the file (optional).	optional[dropbox file sharing info]
has_explicit_shared_members	True if the file has explicitly shared members (optional).	optional[boolean]
content_hash	A hash of the file content (optional).	optional[text]
file_lock_info	File lock information if the file is locked (optional).	optional[dropbox file lock info]

Dropbox file sharing info

Sharing information for a file.

Field Name	Description	Type
read_only	True if the file is read-only.	boolean
parent_shared_folder_id	The ID of the parent shared folder (optional).	optional[text]
modified_by	The ID of the last user to modify the file (optional).	optional[text]

Dropbox file lock info

Metadata for a file lock.

Field Name	Description	Type
is_lockholder	True if the current user is the lockholder.	boolean
lockholder_name	The display name of the lockholder.	text
created	The time the lock was created (optional).	optional[text]

Dropbox deleted metadata

Metadata for a deleted item in Dropbox.

Field Name	Description	Type
name	The name of the deleted item.	text
id	The unique ID of the deleted item.	text
tag	The type of the metadata object, always ".deleted".	optional[text]
path_lower	The lowercased path of the deleted item (optional).	optional[text]
path_display	The display-friendly path of the deleted item (optional).	optional[text]
property_groups	A list of property groups associated with the deleted item (optional).	optional[list of dropbox property group]