Package com.dropbox.core.v2.fileproperties

Class DbxUserFilePropertiesRequests

java.lang.Object

com.dropbox.core.v2.fileproperties.DbxUserFilePropertiesRequests

public class DbxUserFilePropertiesRequests
extends Object

Routes in namespace "file_properties".

Constructor Summary

Constructors

Constructor	Description
DbxUserFilePropertiesRequests(DbxRawClientV2 client)

Method Summary

Modifier and Type	Method	Description
void	propertiesAdd(String path, List<PropertyGroup> propertyGroups)	Add property groups to a Dropbox file.
void	propertiesOverwrite(String path, List<PropertyGroup> propertyGroups)	Overwrite property groups associated with a file.
void	propertiesRemove(String path, List<String> propertyTemplateIds)	Permanently removes the specified property group from the file.
PropertiesSearchResult	propertiesSearch(List<PropertiesSearchQuery> queries)	Search across property templates for particular property field values.
PropertiesSearchResult	propertiesSearch(List<PropertiesSearchQuery> queries, TemplateFilter templateFilter)	Search across property templates for particular property field values.
PropertiesSearchResult	propertiesSearchContinue(String cursor)	Once a cursor has been retrieved from propertiesSearch(List,TemplateFilter), use this to paginate through all search results.
void	propertiesUpdate(String path, List<PropertyGroupUpdate> updatePropertyGroups)	Add, update or remove properties associated with the supplied file and templates.
AddTemplateResult	templatesAddForUser(String name, String description, List<PropertyFieldTemplate> fields)	Add a template associated with a user.
GetTemplateResult	templatesGetForUser(String templateId)	Get the schema for a specified template.
ListTemplateResult	templatesListForUser()	Get the template identifiers for a team.
void	templatesRemoveForUser(String templateId)	Permanently removes the specified template created from templatesAddForUser(String,String,List).
UpdateTemplateResult	templatesUpdateForUser(String templateId)	Update a template associated with a user.
TemplatesUpdateForUserBuilder	templatesUpdateForUserBuilder(String templateId)	Update a template associated with a user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DbxUserFilePropertiesRequests

public DbxUserFilePropertiesRequests(DbxRawClientV2 client)

Method Details

propertiesAdd

public void propertiesAdd(String path,
 List<PropertyGroup> propertyGroups)
                   throws AddPropertiesErrorException,
DbxException

Add property groups to a Dropbox file. See templatesAddForUser(String,String,List) or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List) to create new templates.

Parameters:

path - A unique identifier for the file or folder. Must match pattern "/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)" and not be null.

propertyGroups - The property groups which are to be added to a Dropbox file. No two groups in the input should refer to the same template. Must not contain a null item and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

AddPropertiesErrorException

DbxException

propertiesOverwrite

public void propertiesOverwrite(String path,
 List<PropertyGroup> propertyGroups)
                         throws InvalidPropertyGroupErrorException,
DbxException

Overwrite property groups associated with a file. This endpoint should be used instead of propertiesUpdate(String,List) when property groups are being updated via a "snapshot" instead of via a "delta". In other words, this endpoint will delete all omitted fields from a property group, whereas propertiesUpdate(String,List) will only delete fields that are explicitly marked for deletion.

Parameters:

path - A unique identifier for the file or folder. Must match pattern "/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)" and not be null.

propertyGroups - The property groups "snapshot" updates to force apply. No two groups in the input should refer to the same template. Must contain at least 1 items, not contain a null item, and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

InvalidPropertyGroupErrorException

DbxException

propertiesRemove

public void propertiesRemove(String path,
 List<String> propertyTemplateIds)
                      throws RemovePropertiesErrorException,
DbxException

Permanently removes the specified property group from the file. To remove specific property field key value pairs, see propertiesUpdate(String,List). To update a template, see templatesUpdateForUser(String) or DbxTeamFilePropertiesRequests.templatesUpdateForTeam(String). To remove a template, see templatesRemoveForUser(String) or DbxTeamFilePropertiesRequests.templatesRemoveForTeam(String).

Parameters:

path - A unique identifier for the file or folder. Must match pattern "/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)" and not be null.

propertyTemplateIds - A list of identifiers for a template created by templatesAddForUser(String,String,List) or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List). Must not contain a null item and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

RemovePropertiesErrorException

DbxException

propertiesSearch

public PropertiesSearchResult propertiesSearch(List<PropertiesSearchQuery> queries)
                                        throws PropertiesSearchErrorException,
DbxException

Search across property templates for particular property field values.

The templateFilter request parameter will default to TemplateFilter.FILTER_NONE (see propertiesSearch(List,TemplateFilter)).

Parameters:

queries - Queries to search. Must contain at least 1 items, not contain a null item, and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

PropertiesSearchErrorException

DbxException

propertiesSearch

public PropertiesSearchResult propertiesSearch(List<PropertiesSearchQuery> queries,
 TemplateFilter templateFilter)
                                        throws PropertiesSearchErrorException,
DbxException

Search across property templates for particular property field values.

Parameters:

queries - Queries to search. Must contain at least 1 items, not contain a null item, and not be null.

templateFilter - Filter results to contain only properties associated with these template IDs. Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

PropertiesSearchErrorException

DbxException

propertiesSearchContinue

public PropertiesSearchResult propertiesSearchContinue(String cursor)
                                                throws PropertiesSearchContinueErrorException,
DbxException

Once a cursor has been retrieved from propertiesSearch(List,TemplateFilter), use this to paginate through all search results.

Parameters:

cursor - The cursor returned by your last call to propertiesSearch(List,TemplateFilter) or propertiesSearchContinue(String). Must have length of at least 1 and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

PropertiesSearchContinueErrorException

DbxException

propertiesUpdate

public void propertiesUpdate(String path,
 List<PropertyGroupUpdate> updatePropertyGroups)
                      throws UpdatePropertiesErrorException,
DbxException

Add, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of propertiesOverwrite(String,List) when property groups are being updated via a "delta" instead of via a "snapshot" . In other words, this endpoint will not delete any omitted fields from a property group, whereas propertiesOverwrite(String,List) will delete any fields that are omitted from a property group.

Parameters:

path - A unique identifier for the file or folder. Must match pattern "/(.|[\\r\\n])*|id:.*|(ns:[0-9]+(/.*)?)" and not be null.

updatePropertyGroups - The property groups "delta" updates to apply. Must not contain a null item and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

UpdatePropertiesErrorException

DbxException

templatesAddForUser

public AddTemplateResult templatesAddForUser(String name,
 String description,
 List<PropertyFieldTemplate> fields)
                                      throws ModifyTemplateErrorException,
DbxException

Add a template associated with a user. See propertiesAdd(String,List) to add properties to a file. This endpoint can't be called on a team member or admin's behalf.

Parameters:

name - Display name for the template. Template names can be up to 256 bytes. Must not be null.

description - Description for the template. Template descriptions can be up to 1024 bytes. Must not be null.

fields - Definitions of the property fields associated with this template. There can be up to 32 properties in a single template. Must not contain a null item and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

ModifyTemplateErrorException

DbxException

templatesGetForUser

public GetTemplateResult templatesGetForUser(String templateId)
                                      throws TemplateErrorException,
DbxException

Get the schema for a specified template. This endpoint can't be called on a team member or admin's behalf.

Parameters:

templateId - An identifier for template added by route See templatesAddForUser(String,String,List) or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List). Must have length of at least 1, match pattern "(/|ptid:).*", and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

TemplateErrorException

DbxException

templatesListForUser

public ListTemplateResult templatesListForUser()
                                        throws TemplateErrorException,
DbxException

Get the template identifiers for a team. To get the schema of each template use templatesGetForUser(String). This endpoint can't be called on a team member or admin's behalf.

Throws:

TemplateErrorException

DbxException

templatesRemoveForUser

public void templatesRemoveForUser(String templateId)
                            throws TemplateErrorException,
DbxException

Permanently removes the specified template created from templatesAddForUser(String,String,List). All properties associated with the template will also be removed. This action cannot be undone.

Parameters:

templateId - An identifier for a template created by templatesAddForUser(String,String,List) or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List). Must have length of at least 1, match pattern "(/|ptid:).*", and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

TemplateErrorException

DbxException

templatesUpdateForUser

public UpdateTemplateResult templatesUpdateForUser(String templateId)
                                            throws ModifyTemplateErrorException,
DbxException

Update a template associated with a user. This route can update the template name, the template description and add optional properties to templates. This endpoint can't be called on a team member or admin's behalf.

Parameters:

templateId - An identifier for template added by See templatesAddForUser(String,String,List) or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List). Must have length of at least 1, match pattern "(/|ptid:).*", and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

ModifyTemplateErrorException

DbxException

templatesUpdateForUserBuilder

public TemplatesUpdateForUserBuilder templatesUpdateForUserBuilder(String templateId)

Update a template associated with a user. This route can update the template name, the template description and add optional properties to templates. This endpoint can't be called on a team member or admin's behalf.

Parameters:

templateId - An identifier for template added by See templatesAddForUser(String,String,List) or DbxTeamFilePropertiesRequests.templatesAddForTeam(String,String,List). Must have length of at least 1, match pattern "(/|ptid:).*", and not be null.

Returns:

Request builder for configuring request parameters and completing the request.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.