dbx_file_properties only.Expand description
This namespace contains helpers for property and template metadata endpoints.
These endpoints enable you to tag arbitrary key/value data to Dropbox files.
The most basic unit in this namespace is the PropertyField. These fields encapsulate the
actual key/value data.
Fields are added to a Dropbox file using a PropertyGroup. Property groups contain a
reference to a Dropbox file and a PropertyGroupTemplate. Property groups are uniquely
identified by the combination of their associated Dropbox file and template.
The PropertyGroupTemplate is a way of restricting the possible key names and value types of
the data within a property group. The possible key names and value types are explicitly
enumerated using PropertyFieldTemplate objects.
You can think of a property group template as a class definition for a particular key/value metadata object, and the property groups themselves as the instantiations of these objects.
Templates are owned either by a user/app pair or team/app pair. Templates and their associated properties can’t be accessed by any app other than the app that created them, and even then, only when the app is linked with the owner of the template (either a user or team).
User-owned templates are accessed via the user-auth file_properties/templates/_for_user endpoints, while team-owned templates are accessed via the team-auth file_properties/templates/_for_team endpoints. Properties associated with either type of template can be accessed via the user-auth properties/* endpoints.
Finally, properties can be accessed from a number of endpoints that return metadata, including
files/get_metadata, and files/list_folder. Properties can also be added during upload, using
files/upload.
Structs§
- AddProperties
Arg - AddTemplate
Arg - AddTemplate
Result - GetTemplate
Arg - GetTemplate
Result - List
Template Result - Overwrite
Property Group Arg - Properties
Search Arg - Properties
Search Continue Arg - Properties
Search Match - Properties
Search Query - Properties
Search Result - Property
Field - Raw key/value data to be associated with a Dropbox file. Property fields are added to Dropbox
files as a
PropertyGroup. - Property
Field Template - Defines how a single property field may be structured. Used exclusively by
PropertyGroupTemplate. - Property
Group - A subset of the property fields described by the corresponding
PropertyGroupTemplate. Properties are always added to a Dropbox file as aPropertyGroup. The possible key names and value types in this group are defined by the correspondingPropertyGroupTemplate. - Property
Group Template - Defines how a property group may be structured.
- Property
Group Update - Remove
Properties Arg - Remove
Template Arg - Update
Properties Arg - Update
Template Arg - Update
Template Result
Enums§
- AddProperties
Error - Invalid
Property Group Error - Logical
Operator - Logical operator to join search queries together.
- Look
UpProperties Error - Lookup
Error - Modify
Template Error - Properties
Error - Properties
Search Continue Error - Properties
Search Error - Properties
Search Mode - Property
Type - Data type of the given property field added.
- Remove
Properties Error - Template
Error - Template
Filter - Template
Filter Base - Template
Owner Type - Update
Properties Error