Class FilePropertiesUserRoutes

The routes for the Dropbox.Api.FileProperties namespace

Inheritance

System.Object

FilePropertiesUserRoutes

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 FilePropertiesUserRoutes

Methods

BeginPropertiesAdd(AddPropertiesArg, AsyncCallback, Object)

Begins an asynchronous send to the properties add route.

Declaration

public IAsyncResult BeginPropertiesAdd(AddPropertiesArg addPropertiesArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
AddPropertiesArg	addPropertiesArg	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.

BeginPropertiesAdd(String, IEnumerable<PropertyGroup>, AsyncCallback, Object)

Begins an asynchronous send to the properties add route.

Declaration

public IAsyncResult BeginPropertiesAdd(string path, IEnumerable<PropertyGroup> propertyGroups, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<PropertyGroup>	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.
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.

BeginPropertiesOverwrite(OverwritePropertyGroupArg, AsyncCallback, Object)

Begins an asynchronous send to the properties overwrite route.

Declaration

public IAsyncResult BeginPropertiesOverwrite(OverwritePropertyGroupArg overwritePropertyGroupArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
OverwritePropertyGroupArg	overwritePropertyGroupArg	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.

BeginPropertiesOverwrite(String, IEnumerable<PropertyGroup>, AsyncCallback, Object)

Begins an asynchronous send to the properties overwrite route.

Declaration

public IAsyncResult BeginPropertiesOverwrite(string path, IEnumerable<PropertyGroup> propertyGroups, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<PropertyGroup>	propertyGroups	The property groups "snapshot" updates to force apply. No two groups in the input should refer to the same 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.

BeginPropertiesRemove(RemovePropertiesArg, AsyncCallback, Object)

Begins an asynchronous send to the properties remove route.

Declaration

public IAsyncResult BeginPropertiesRemove(RemovePropertiesArg removePropertiesArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RemovePropertiesArg	removePropertiesArg	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.

BeginPropertiesRemove(String, IEnumerable<String>, AsyncCallback, Object)

Begins an asynchronous send to the properties remove route.

Declaration

public IAsyncResult BeginPropertiesRemove(string path, IEnumerable<string> propertyTemplateIds, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<System.String>	propertyTemplateIds	A list of identifiers 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.

BeginPropertiesSearch(PropertiesSearchArg, AsyncCallback, Object)

Begins an asynchronous send to the properties search route.

Declaration

public IAsyncResult BeginPropertiesSearch(PropertiesSearchArg propertiesSearchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PropertiesSearchArg	propertiesSearchArg	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.

BeginPropertiesSearch(IEnumerable<PropertiesSearchQuery>, TemplateFilter, AsyncCallback, Object)

Begins an asynchronous send to the properties search route.

Declaration

public IAsyncResult BeginPropertiesSearch(IEnumerable<PropertiesSearchQuery> queries, TemplateFilter templateFilter = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<PropertiesSearchQuery>	queries	Queries to search.
TemplateFilter	templateFilter	Filter results to contain only properties associated with these template IDs.
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.

BeginPropertiesSearchContinue(PropertiesSearchContinueArg, AsyncCallback, Object)

Begins an asynchronous send to the properties search continue route.

Declaration

public IAsyncResult BeginPropertiesSearchContinue(PropertiesSearchContinueArg propertiesSearchContinueArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PropertiesSearchContinueArg	propertiesSearchContinueArg	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.

BeginPropertiesSearchContinue(String, AsyncCallback, Object)

Begins an asynchronous send to the properties search continue route.

Declaration

public IAsyncResult BeginPropertiesSearchContinue(string cursor, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by your last call to PropertiesSearchAsync(PropertiesSearchArg) or PropertiesSearchContinueAsync(PropertiesSearchContinueArg).
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.

BeginPropertiesUpdate(UpdatePropertiesArg, AsyncCallback, Object)

Begins an asynchronous send to the properties update route.

Declaration

public IAsyncResult BeginPropertiesUpdate(UpdatePropertiesArg updatePropertiesArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UpdatePropertiesArg	updatePropertiesArg	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.

BeginPropertiesUpdate(String, IEnumerable<PropertyGroupUpdate>, AsyncCallback, Object)

Begins an asynchronous send to the properties update route.

Declaration

public IAsyncResult BeginPropertiesUpdate(string path, IEnumerable<PropertyGroupUpdate> updatePropertyGroups, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<PropertyGroupUpdate>	updatePropertyGroups	The property groups "delta" updates to apply.
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.

BeginTemplatesAddForUser(AddTemplateArg, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginTemplatesAddForUser(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.

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

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

Declaration

public IAsyncResult BeginTemplatesAddForUser(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.

BeginTemplatesGetForUser(GetTemplateArg, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginTemplatesGetForUser(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.

BeginTemplatesGetForUser(String, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginTemplatesGetForUser(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.

BeginTemplatesListForUser(AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginTemplatesListForUser(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.

BeginTemplatesRemoveForUser(RemoveTemplateArg, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginTemplatesRemoveForUser(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.

BeginTemplatesRemoveForUser(String, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginTemplatesRemoveForUser(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.

BeginTemplatesUpdateForUser(UpdateTemplateArg, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginTemplatesUpdateForUser(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.

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

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

Declaration

public IAsyncResult BeginTemplatesUpdateForUser(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.

EndPropertiesAdd(IAsyncResult)

Waits for the pending asynchronous send to the properties add route to complete

Declaration

public void EndPropertiesAdd(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 AddPropertiesError.

EndPropertiesOverwrite(IAsyncResult)

Waits for the pending asynchronous send to the properties overwrite route to complete

Declaration

public void EndPropertiesOverwrite(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 InvalidPropertyGroupError.

EndPropertiesRemove(IAsyncResult)

Waits for the pending asynchronous send to the properties remove route to complete

Declaration

public void EndPropertiesRemove(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 RemovePropertiesError.

EndPropertiesSearch(IAsyncResult)

Waits for the pending asynchronous send to the properties search route to complete

Declaration

public PropertiesSearchResult EndPropertiesSearch(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
PropertiesSearchResult	The response to the send request

Exceptions

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

EndPropertiesSearchContinue(IAsyncResult)

Waits for the pending asynchronous send to the properties search continue route to complete

Declaration

public PropertiesSearchResult EndPropertiesSearchContinue(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
PropertiesSearchResult	The response to the send request

Exceptions

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

EndPropertiesUpdate(IAsyncResult)

Waits for the pending asynchronous send to the properties update route to complete

Declaration

public void EndPropertiesUpdate(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 UpdatePropertiesError.

EndTemplatesAddForUser(IAsyncResult)

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

Declaration

public AddTemplateResult EndTemplatesAddForUser(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.

EndTemplatesGetForUser(IAsyncResult)

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

Declaration

public GetTemplateResult EndTemplatesGetForUser(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.

EndTemplatesListForUser(IAsyncResult)

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

Declaration

public ListTemplateResult EndTemplatesListForUser(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.

EndTemplatesRemoveForUser(IAsyncResult)

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

Declaration

public void EndTemplatesRemoveForUser(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.

EndTemplatesUpdateForUser(IAsyncResult)

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

Declaration

public UpdateTemplateResult EndTemplatesUpdateForUser(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.

PropertiesAddAsync(AddPropertiesArg)

Add property groups to a Dropbox file. See TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg) to create new templates.

Declaration

public Task PropertiesAddAsync(AddPropertiesArg addPropertiesArg)

Parameters

Type	Name	Description
AddPropertiesArg	addPropertiesArg	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 AddPropertiesError.

PropertiesAddAsync(String, IEnumerable<PropertyGroup>)

Add property groups to a Dropbox file. See TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg) to create new templates.

Declaration

public Task PropertiesAddAsync(string path, IEnumerable<PropertyGroup> propertyGroups)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<PropertyGroup>	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.

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 AddPropertiesError.

PropertiesOverwriteAsync(OverwritePropertyGroupArg)

Overwrite property groups associated with a file. This endpoint should be used instead of PropertiesUpdateAsync(UpdatePropertiesArg) 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 PropertiesUpdateAsync(UpdatePropertiesArg) will only delete fields that are explicitly marked for deletion.

Declaration

public Task PropertiesOverwriteAsync(OverwritePropertyGroupArg overwritePropertyGroupArg)

Parameters

Type	Name	Description
OverwritePropertyGroupArg	overwritePropertyGroupArg	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 InvalidPropertyGroupError.

PropertiesOverwriteAsync(String, IEnumerable<PropertyGroup>)

Overwrite property groups associated with a file. This endpoint should be used instead of PropertiesUpdateAsync(UpdatePropertiesArg) 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 PropertiesUpdateAsync(UpdatePropertiesArg) will only delete fields that are explicitly marked for deletion.

Declaration

public Task PropertiesOverwriteAsync(string path, IEnumerable<PropertyGroup> propertyGroups)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<PropertyGroup>	propertyGroups	The property groups "snapshot" updates to force apply. No two groups in the input should refer to the same template.

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 InvalidPropertyGroupError.

PropertiesRemoveAsync(RemovePropertiesArg)

Permanently removes the specified property group from the file. To remove specific property field key value pairs, see PropertiesUpdateAsync(UpdatePropertiesArg). To update a template, see TemplatesUpdateForUserAsync(UpdateTemplateArg) or TemplatesUpdateForTeamAsync(UpdateTemplateArg). To remove a template, see TemplatesRemoveForUserAsync(RemoveTemplateArg) or TemplatesRemoveForTeamAsync(RemoveTemplateArg).

Declaration

public Task PropertiesRemoveAsync(RemovePropertiesArg removePropertiesArg)

Parameters

Type	Name	Description
RemovePropertiesArg	removePropertiesArg	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 RemovePropertiesError.

PropertiesRemoveAsync(String, IEnumerable<String>)

Permanently removes the specified property group from the file. To remove specific property field key value pairs, see PropertiesUpdateAsync(UpdatePropertiesArg). To update a template, see TemplatesUpdateForUserAsync(UpdateTemplateArg) or TemplatesUpdateForTeamAsync(UpdateTemplateArg). To remove a template, see TemplatesRemoveForUserAsync(RemoveTemplateArg) or TemplatesRemoveForTeamAsync(RemoveTemplateArg).

Declaration

public Task PropertiesRemoveAsync(string path, IEnumerable<string> propertyTemplateIds)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<System.String>	propertyTemplateIds	A list of identifiers 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 RemovePropertiesError.

PropertiesSearchAsync(PropertiesSearchArg)

Search across property templates for particular property field values.

Declaration

public Task<PropertiesSearchResult> PropertiesSearchAsync(PropertiesSearchArg propertiesSearchArg)

Parameters

Type	Name	Description
PropertiesSearchArg	propertiesSearchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<PropertiesSearchResult>	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 PropertiesSearchError.

PropertiesSearchAsync(IEnumerable<PropertiesSearchQuery>, TemplateFilter)

Search across property templates for particular property field values.

Declaration

public Task<PropertiesSearchResult> PropertiesSearchAsync(IEnumerable<PropertiesSearchQuery> queries, TemplateFilter templateFilter = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<PropertiesSearchQuery>	queries	Queries to search.
TemplateFilter	templateFilter	Filter results to contain only properties associated with these template IDs.

Returns

Type	Description
System.Threading.Tasks.Task<PropertiesSearchResult>	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 PropertiesSearchError.

PropertiesSearchContinueAsync(PropertiesSearchContinueArg)

Once a cursor has been retrieved from PropertiesSearchAsync(PropertiesSearchArg), use this to paginate through all search results.

Declaration

public Task<PropertiesSearchResult> PropertiesSearchContinueAsync(PropertiesSearchContinueArg propertiesSearchContinueArg)

Parameters

Type	Name	Description
PropertiesSearchContinueArg	propertiesSearchContinueArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<PropertiesSearchResult>	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 PropertiesSearchContinueError.

PropertiesSearchContinueAsync(String)

Once a cursor has been retrieved from PropertiesSearchAsync(PropertiesSearchArg), use this to paginate through all search results.

Declaration

public Task<PropertiesSearchResult> PropertiesSearchContinueAsync(string cursor)

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by your last call to PropertiesSearchAsync(PropertiesSearchArg) or PropertiesSearchContinueAsync(PropertiesSearchContinueArg).

Returns

Type	Description
System.Threading.Tasks.Task<PropertiesSearchResult>	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 PropertiesSearchContinueError.

PropertiesUpdateAsync(UpdatePropertiesArg)

Add, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of PropertiesOverwriteAsync(OverwritePropertyGroupArg) 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 PropertiesOverwriteAsync(OverwritePropertyGroupArg) will delete any fields that are omitted from a property group.

Declaration

public Task PropertiesUpdateAsync(UpdatePropertiesArg updatePropertiesArg)

Parameters

Type	Name	Description
UpdatePropertiesArg	updatePropertiesArg	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 UpdatePropertiesError.

PropertiesUpdateAsync(String, IEnumerable<PropertyGroupUpdate>)

Add, update or remove properties associated with the supplied file and templates. This endpoint should be used instead of PropertiesOverwriteAsync(OverwritePropertyGroupArg) 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 PropertiesOverwriteAsync(OverwritePropertyGroupArg) will delete any fields that are omitted from a property group.

Declaration

public Task PropertiesUpdateAsync(string path, IEnumerable<PropertyGroupUpdate> updatePropertyGroups)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<PropertyGroupUpdate>	updatePropertyGroups	The property groups "delta" updates to apply.

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 UpdatePropertiesError.

TemplatesAddForUserAsync(AddTemplateArg)

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

Declaration

public Task<AddTemplateResult> TemplatesAddForUserAsync(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.

TemplatesAddForUserAsync(String, String, IEnumerable<PropertyFieldTemplate>)

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

Declaration

public Task<AddTemplateResult> TemplatesAddForUserAsync(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.

TemplatesGetForUserAsync(GetTemplateArg)

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

Declaration

public Task<GetTemplateResult> TemplatesGetForUserAsync(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.

TemplatesGetForUserAsync(String)

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

Declaration

public Task<GetTemplateResult> TemplatesGetForUserAsync(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.

TemplatesListForUserAsync()

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

Declaration

public Task<ListTemplateResult> TemplatesListForUserAsync()

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.

TemplatesRemoveForUserAsync(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 TemplatesRemoveForUserAsync(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.

TemplatesRemoveForUserAsync(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 TemplatesRemoveForUserAsync(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.

TemplatesUpdateForUserAsync(UpdateTemplateArg)

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.

Declaration

public Task<UpdateTemplateResult> TemplatesUpdateForUserAsync(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.

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

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.

Declaration

public Task<UpdateTemplateResult> TemplatesUpdateForUserAsync(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.