Package com.dropbox.core.v2.fileproperties
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`.
See DbxTeamFilePropertiesRequests
, DbxUserFilePropertiesRequests
for a list
of possible requests for this namespace.
-
Enum Summary Enum Description AddPropertiesError.Tag Discriminating tag type forAddPropertiesError
.InvalidPropertyGroupError.Tag Discriminating tag type forInvalidPropertyGroupError
.LogicalOperator Logical operator to join search queries together.LookupError.Tag Discriminating tag type forLookupError
.LookUpPropertiesError ModifyTemplateError.Tag Discriminating tag type forModifyTemplateError
.PropertiesSearchContinueError PropertiesSearchError.Tag Discriminating tag type forPropertiesSearchError
.PropertiesSearchMode.Tag Discriminating tag type forPropertiesSearchMode
.PropertyType Data type of the given property field added.RemovePropertiesError.Tag Discriminating tag type forRemovePropertiesError
.TemplateError.Tag Discriminating tag type forTemplateError
.TemplateFilter.Tag Discriminating tag type forTemplateFilter
.TemplateFilterBase.Tag Discriminating tag type forTemplateFilterBase
.UpdatePropertiesError.Tag Discriminating tag type forUpdatePropertiesError
. -
Exception Summary Exception Description AddPropertiesErrorException Exception thrown when the server responds with aAddPropertiesError
error.InvalidPropertyGroupErrorException Exception thrown when the server responds with aInvalidPropertyGroupError
error.ModifyTemplateErrorException Exception thrown when the server responds with aModifyTemplateError
error.PropertiesSearchContinueErrorException Exception thrown when the server responds with aPropertiesSearchContinueError
error.PropertiesSearchErrorException Exception thrown when the server responds with aPropertiesSearchError
error.RemovePropertiesErrorException Exception thrown when the server responds with aRemovePropertiesError
error.TemplateErrorException Exception thrown when the server responds with aTemplateError
error.UpdatePropertiesErrorException Exception thrown when the server responds with aUpdatePropertiesError
error.