Class FilePropertiesTeamRoutes

The routes for the Dropbox.Api.FileProperties namespace

Inheritance

System.Object

FilePropertiesTeamRoutes

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dropbox.Api.FileProperties.Routes

Assembly: Dropbox.Api.dll

Syntax

public class FilePropertiesTeamRoutes

Methods

| Improve this Doc View Source

BeginTemplatesAddForTeam(AddTemplateArg, AsyncCallback, Object)

Begins an asynchronous send to the templates add for team route.

Declaration

public IAsyncResult BeginTemplatesAddForTeam(AddTemplateArg addTemplateArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
AddTemplateArg	addTemplateArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

BeginTemplatesAddForTeam(String, String, IEnumerable<PropertyFieldTemplate>, AsyncCallback, Object)

Begins an asynchronous send to the templates add for team route.

Declaration

public IAsyncResult BeginTemplatesAddForTeam(string name, string description, IEnumerable<PropertyFieldTemplate> fields, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	name	Display name for the template. Template names can be up to 256 bytes.
System.String	description	Description for the template. Template descriptions can be up to 1024 bytes.
System.Collections.Generic.IEnumerable<PropertyFieldTemplate>	fields	Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

BeginTemplatesGetForTeam(GetTemplateArg, AsyncCallback, Object)

Begins an asynchronous send to the templates get for team route.

Declaration

public IAsyncResult BeginTemplatesGetForTeam(GetTemplateArg getTemplateArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetTemplateArg	getTemplateArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

BeginTemplatesGetForTeam(String, AsyncCallback, Object)

Begins an asynchronous send to the templates get for team route.

Declaration

public IAsyncResult BeginTemplatesGetForTeam(string templateId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	templateId	An identifier for template added by route See TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg).
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

BeginTemplatesListForTeam(AsyncCallback, Object)

Begins an asynchronous send to the templates list for team route.

Declaration

public IAsyncResult BeginTemplatesListForTeam(AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

BeginTemplatesRemoveForTeam(RemoveTemplateArg, AsyncCallback, Object)

Begins an asynchronous send to the templates remove for team route.

Declaration

public IAsyncResult BeginTemplatesRemoveForTeam(RemoveTemplateArg removeTemplateArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RemoveTemplateArg	removeTemplateArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

BeginTemplatesRemoveForTeam(String, AsyncCallback, Object)

Begins an asynchronous send to the templates remove for team route.

Declaration

public IAsyncResult BeginTemplatesRemoveForTeam(string templateId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	templateId	An identifier for a template created by TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg).
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

BeginTemplatesUpdateForTeam(UpdateTemplateArg, AsyncCallback, Object)

Begins an asynchronous send to the templates update for team route.

Declaration

public IAsyncResult BeginTemplatesUpdateForTeam(UpdateTemplateArg updateTemplateArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UpdateTemplateArg	updateTemplateArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

BeginTemplatesUpdateForTeam(String, String, String, IEnumerable<PropertyFieldTemplate>, AsyncCallback, Object)

Begins an asynchronous send to the templates update for team route.

Declaration

public IAsyncResult BeginTemplatesUpdateForTeam(string templateId, string name = null, string description = null, IEnumerable<PropertyFieldTemplate> addFields = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	templateId	An identifier for template added by See TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg).
System.String	name	A display name for the template. template names can be up to 256 bytes.
System.String	description	Description for the new template. Template descriptions can be up to 1024 bytes.
System.Collections.Generic.IEnumerable<PropertyFieldTemplate>	addFields	Property field templates to be added to the group template. There can be up to 32 properties in a single template.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

| Improve this Doc View Source

EndTemplatesAddForTeam(IAsyncResult)

Waits for the pending asynchronous send to the templates add for team route to complete

Declaration

public AddTemplateResult EndTemplatesAddForTeam(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
AddTemplateResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ModifyTemplateError.

| Improve this Doc View Source

EndTemplatesGetForTeam(IAsyncResult)

Waits for the pending asynchronous send to the templates get for team route to complete

Declaration

public GetTemplateResult EndTemplatesGetForTeam(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetTemplateResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

| Improve this Doc View Source

EndTemplatesListForTeam(IAsyncResult)

Waits for the pending asynchronous send to the templates list for team route to complete

Declaration

public ListTemplateResult EndTemplatesListForTeam(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
ListTemplateResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

| Improve this Doc View Source

EndTemplatesRemoveForTeam(IAsyncResult)

Waits for the pending asynchronous send to the templates remove for team route to complete

Declaration

public void EndTemplatesRemoveForTeam(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

| Improve this Doc View Source

EndTemplatesUpdateForTeam(IAsyncResult)

Waits for the pending asynchronous send to the templates update for team route to complete

Declaration

public UpdateTemplateResult EndTemplatesUpdateForTeam(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
UpdateTemplateResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ModifyTemplateError.

| Improve this Doc View Source

TemplatesAddForTeamAsync(AddTemplateArg)

Add a template associated with a team. See PropertiesAddAsync(AddPropertiesArg) to add properties to a file or folder.

Note: this endpoint will create team-owned templates.

Declaration

public Task<AddTemplateResult> TemplatesAddForTeamAsync(AddTemplateArg addTemplateArg)

Parameters

Type	Name	Description
AddTemplateArg	addTemplateArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<AddTemplateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ModifyTemplateError.

| Improve this Doc View Source

TemplatesAddForTeamAsync(String, String, IEnumerable<PropertyFieldTemplate>)

Add a template associated with a team. See PropertiesAddAsync(AddPropertiesArg) to add properties to a file or folder.

Note: this endpoint will create team-owned templates.

Declaration

public Task<AddTemplateResult> TemplatesAddForTeamAsync(string name, string description, IEnumerable<PropertyFieldTemplate> fields)

Parameters

Type	Name	Description
System.String	name	Display name for the template. Template names can be up to 256 bytes.
System.String	description	Description for the template. Template descriptions can be up to 1024 bytes.
System.Collections.Generic.IEnumerable<PropertyFieldTemplate>	fields	Definitions of the property fields associated with this template. There can be up to 32 properties in a single template.

Returns

Type	Description
System.Threading.Tasks.Task<AddTemplateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ModifyTemplateError.

| Improve this Doc View Source

TemplatesGetForTeamAsync(GetTemplateArg)

Get the schema for a specified template.

Declaration

public Task<GetTemplateResult> TemplatesGetForTeamAsync(GetTemplateArg getTemplateArg)

Parameters

Type	Name	Description
GetTemplateArg	getTemplateArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<GetTemplateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

| Improve this Doc View Source

TemplatesGetForTeamAsync(String)

Get the schema for a specified template.

Declaration

public Task<GetTemplateResult> TemplatesGetForTeamAsync(string templateId)

Parameters

Type	Name	Description
System.String	templateId	An identifier for template added by route See TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg).

Returns

Type	Description
System.Threading.Tasks.Task<GetTemplateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

| Improve this Doc View Source

TemplatesListForTeamAsync()

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

Declaration

public Task<ListTemplateResult> TemplatesListForTeamAsync()

Returns

Type	Description
System.Threading.Tasks.Task<ListTemplateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

| Improve this Doc View Source

TemplatesRemoveForTeamAsync(RemoveTemplateArg)

Permanently removes the specified template created from TemplatesAddForUserAsync(AddTemplateArg). All properties associated with the template will also be removed. This action cannot be undone.

Declaration

public Task TemplatesRemoveForTeamAsync(RemoveTemplateArg removeTemplateArg)

Parameters

Type	Name	Description
RemoveTemplateArg	removeTemplateArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

| Improve this Doc View Source

TemplatesRemoveForTeamAsync(String)

Permanently removes the specified template created from TemplatesAddForUserAsync(AddTemplateArg). All properties associated with the template will also be removed. This action cannot be undone.

Declaration

public Task TemplatesRemoveForTeamAsync(string templateId)

Parameters

Type	Name	Description
System.String	templateId	An identifier for a template created by TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg).

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

| Improve this Doc View Source

TemplatesUpdateForTeamAsync(UpdateTemplateArg)

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

Declaration

public Task<UpdateTemplateResult> TemplatesUpdateForTeamAsync(UpdateTemplateArg updateTemplateArg)

Parameters

Type	Name	Description
UpdateTemplateArg	updateTemplateArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<UpdateTemplateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ModifyTemplateError.

| Improve this Doc View Source

TemplatesUpdateForTeamAsync(String, String, String, IEnumerable<PropertyFieldTemplate>)

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

Declaration

public Task<UpdateTemplateResult> TemplatesUpdateForTeamAsync(string templateId, string name = null, string description = null, IEnumerable<PropertyFieldTemplate> addFields = null)

Parameters

Type	Name	Description
System.String	templateId	An identifier for template added by See TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg).
System.String	name	A display name for the template. template names can be up to 256 bytes.
System.String	description	Description for the new template. Template descriptions can be up to 1024 bytes.
System.Collections.Generic.IEnumerable<PropertyFieldTemplate>	addFields	Property field templates to be added to the group template. There can be up to 32 properties in a single template.

Returns

Type	Description
System.Threading.Tasks.Task<UpdateTemplateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ModifyTemplateError.