com.dropbox.core.v2.fileproperties (Official Dropbox Java SDK 3.0.11 API)

Class Summary
Class	Description
AddPropertiesArg
AddPropertiesArg.Serializer	For internal use only.
AddPropertiesError	This class is a tagged union.
AddPropertiesError.Serializer	For internal use only.
AddTemplateArg
AddTemplateArg.Serializer	For internal use only.
AddTemplateResult
AddTemplateResult.Serializer	For internal use only.
DbxTeamFilePropertiesRequests	Routes in namespace "file_properties".
DbxUserFilePropertiesRequests	Routes in namespace "file_properties".
GetTemplateArg
GetTemplateArg.Serializer	For internal use only.
GetTemplateResult
GetTemplateResult.Serializer	For internal use only.
InvalidPropertyGroupError	This class is a tagged union.
InvalidPropertyGroupError.Serializer	For internal use only.
ListTemplateResult
ListTemplateResult.Serializer	For internal use only.
LookupError	This class is an open tagged union.
LookUpPropertiesError.Serializer	For internal use only.
ModifyTemplateError	This class is a tagged union.
ModifyTemplateError.Serializer	For internal use only.
OverwritePropertyGroupArg
OverwritePropertyGroupArg.Serializer	For internal use only.
PropertiesSearchError	This class is an open tagged union.
PropertiesSearchMatch
PropertiesSearchMode	This class is an open tagged union.
PropertiesSearchQuery
PropertiesSearchResult
PropertyField	Raw key/value data to be associated with a Dropbox file.
PropertyFieldTemplate	Defines how a single property field may be structured.
PropertyGroup	A subset of the property fields described by the corresponding `PropertyGroupTemplate`.
PropertyGroup.Serializer	For internal use only.
PropertyGroupTemplate	Defines how a property group may be structured.
PropertyGroupUpdate
PropertyGroupUpdate.Builder	Builder for `PropertyGroupUpdate`.
RemovePropertiesArg
RemovePropertiesArg.Serializer	For internal use only.
RemovePropertiesError	This class is a tagged union.
RemovePropertiesError.Serializer	For internal use only.
TemplateError	This class is an open tagged union.
TemplateError.Serializer	For internal use only.
TemplateFilter	This class is a tagged union.
TemplateFilterBase	This class is an open tagged union.
TemplateFilterBase.Serializer	For internal use only.
TemplatesUpdateForTeamBuilder	The request builder returned by `DbxTeamFilePropertiesRequests.templatesUpdateForTeamBuilder(java.lang.String)`.
TemplatesUpdateForUserBuilder	The request builder returned by `DbxUserFilePropertiesRequests.templatesUpdateForUserBuilder(java.lang.String)`.
UpdatePropertiesArg
UpdatePropertiesArg.Serializer	For internal use only.
UpdatePropertiesError	This class is a tagged union.
UpdatePropertiesError.Serializer	For internal use only.
UpdateTemplateArg
UpdateTemplateArg.Builder	Builder for `UpdateTemplateArg`.
UpdateTemplateArg.Serializer	For internal use only.
UpdateTemplateResult
UpdateTemplateResult.Serializer	For internal use only.

Enum Summary
Enum	Description
AddPropertiesError.Tag	Discriminating tag type for `AddPropertiesError`.
InvalidPropertyGroupError.Tag	Discriminating tag type for `InvalidPropertyGroupError`.
LogicalOperator	Logical operator to join search queries together.
LookupError.Tag	Discriminating tag type for `LookupError`.
LookUpPropertiesError
ModifyTemplateError.Tag	Discriminating tag type for `ModifyTemplateError`.
PropertiesSearchContinueError
PropertiesSearchError.Tag	Discriminating tag type for `PropertiesSearchError`.
PropertiesSearchMode.Tag	Discriminating tag type for `PropertiesSearchMode`.
PropertyType	Data type of the given property field added.
RemovePropertiesError.Tag	Discriminating tag type for `RemovePropertiesError`.
TemplateError.Tag	Discriminating tag type for `TemplateError`.
TemplateFilter.Tag	Discriminating tag type for `TemplateFilter`.
TemplateFilterBase.Tag	Discriminating tag type for `TemplateFilterBase`.
UpdatePropertiesError.Tag	Discriminating tag type for `UpdatePropertiesError`.

Exception Summary
Exception	Description
AddPropertiesErrorException	Exception thrown when the server responds with a `AddPropertiesError` error.
InvalidPropertyGroupErrorException	Exception thrown when the server responds with a `InvalidPropertyGroupError` error.
ModifyTemplateErrorException	Exception thrown when the server responds with a `ModifyTemplateError` error.
PropertiesSearchContinueErrorException	Exception thrown when the server responds with a `PropertiesSearchContinueError` error.
PropertiesSearchErrorException	Exception thrown when the server responds with a `PropertiesSearchError` error.
RemovePropertiesErrorException	Exception thrown when the server responds with a `RemovePropertiesError` error.
TemplateErrorException	Exception thrown when the server responds with a `TemplateError` error.
UpdatePropertiesErrorException	Exception thrown when the server responds with a `UpdatePropertiesError` error.

Package com.dropbox.core.v2.fileproperties 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`.

See DbxUserFilePropertiesRequests, DbxTeamFilePropertiesRequests for a list of possible requests for this namespace.