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.
-
ClassDescriptionFor internal use only.This class is a tagged union.For internal use only.Discriminating tag type for
AddPropertiesError.Exception thrown when the server responds with aAddPropertiesErrorerror.For internal use only.For internal use only.Routes in namespace "file_properties".Routes in namespace "file_properties".For internal use only.For internal use only.This class is a tagged union.For internal use only.Discriminating tag type forInvalidPropertyGroupError.Exception thrown when the server responds with aInvalidPropertyGroupErrorerror.For internal use only.Logical operator to join search queries together.This class is an open tagged union.Discriminating tag type forLookupError.For internal use only.This class is a tagged union.For internal use only.Discriminating tag type forModifyTemplateError.Exception thrown when the server responds with aModifyTemplateErrorerror.For internal use only.Exception thrown when the server responds with aPropertiesSearchContinueErrorerror.This class is an open tagged union.Discriminating tag type forPropertiesSearchError.Exception thrown when the server responds with aPropertiesSearchErrorerror.This class is an open tagged union.Discriminating tag type forPropertiesSearchMode.Raw key/value data to be associated with a Dropbox file.Defines how a single property field may be structured.A subset of the property fields described by the correspondingPropertyGroupTemplate.For internal use only.Defines how a property group may be structured.Property routesBuilder forPropertyGroupUpdate.Data type of the given property field added.For internal use only.This class is a tagged union.For internal use only.Discriminating tag type forRemovePropertiesError.Exception thrown when the server responds with aRemovePropertiesErrorerror.This class is an open tagged union.For internal use only.Discriminating tag type forTemplateError.Exception thrown when the server responds with aTemplateErrorerror.This class is a tagged union.Discriminating tag type forTemplateFilter.This class is an open tagged union.For internal use only.Discriminating tag type forTemplateFilterBase.The request builder returned byDbxTeamFilePropertiesRequests.templatesUpdateForTeamBuilder(java.lang.String).The request builder returned byDbxUserFilePropertiesRequests.templatesUpdateForUserBuilder(java.lang.String).For internal use only.This class is a tagged union.For internal use only.Discriminating tag type forUpdatePropertiesError.Exception thrown when the server responds with aUpdatePropertiesErrorerror.Builder forUpdateTemplateArg.For internal use only.For internal use only.