Package com.dropbox.core.v2.fileproperties

Class DbxTeamFilePropertiesRequests

java.lang.Object

com.dropbox.core.v2.fileproperties.DbxTeamFilePropertiesRequests

public class DbxTeamFilePropertiesRequests
extends java.lang.Object

Routes in namespace "file_properties".

Constructor Summary

Constructors

Constructor	Description
DbxTeamFilePropertiesRequests(DbxRawClientV2 client)

Method Summary

Modifier and Type	Method	Description
AddTemplateResult	templatesAddForTeam(java.lang.String name, java.lang.String description, java.util.List<PropertyFieldTemplate> fields)	Add a template associated with a team.
GetTemplateResult	templatesGetForTeam(java.lang.String templateId)	Get the schema for a specified template.
ListTemplateResult	templatesListForTeam()	Get the template identifiers for a team.
void	templatesRemoveForTeam(java.lang.String templateId)	Permanently removes the specified template created from DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List).
UpdateTemplateResult	templatesUpdateForTeam(java.lang.String templateId)	Update a template associated with a team.
TemplatesUpdateForTeamBuilder	templatesUpdateForTeamBuilder(java.lang.String templateId)	Update a template associated with a team.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbxTeamFilePropertiesRequests

public DbxTeamFilePropertiesRequests(DbxRawClientV2 client)

Method Detail

templatesAddForTeam

public AddTemplateResult templatesAddForTeam(java.lang.String name,
                                             java.lang.String description,
                                             java.util.List<PropertyFieldTemplate> fields)
                                      throws ModifyTemplateErrorException,
                                             DbxException

Add a template associated with a team. See DbxUserFilePropertiesRequests.propertiesAdd(String,List) to add properties to a file or folder.

Note: this endpoint will create team-owned templates.

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:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

ModifyTemplateErrorException

DbxException

templatesGetForTeam

public GetTemplateResult templatesGetForTeam(java.lang.String templateId)
                                      throws TemplateErrorException,
                                             DbxException

Get the schema for a specified template.

Parameters:

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

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

TemplateErrorException

DbxException

templatesListForTeam

public ListTemplateResult templatesListForTeam()
                                        throws TemplateErrorException,
                                               DbxException

Get the template identifiers for a team. To get the schema of each template use templatesGetForTeam(String).

Throws:

TemplateErrorException

DbxException

templatesRemoveForTeam

public void templatesRemoveForTeam(java.lang.String templateId)
                            throws TemplateErrorException,
                                   DbxException

Permanently removes the specified template created from DbxUserFilePropertiesRequests.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 DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List) or templatesAddForTeam(String,String,List). Must have length of at least 1, match pattern "(/|ptid:).*", and not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

TemplateErrorException

DbxException

templatesUpdateForTeam

public UpdateTemplateResult templatesUpdateForTeam(java.lang.String templateId)
                                            throws ModifyTemplateErrorException,
                                                   DbxException

Update a template associated with a team. This route can update the template name, the template description and add optional properties to templates.

Parameters:

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

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

ModifyTemplateErrorException

DbxException

templatesUpdateForTeamBuilder

public TemplatesUpdateForTeamBuilder templatesUpdateForTeamBuilder(java.lang.String templateId)

Update a template associated with a team. This route can update the template name, the template description and add optional properties to templates.

Parameters:

templateId - An identifier for template added by See DbxUserFilePropertiesRequests.templatesAddForUser(String,String,List) or 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:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.