Class UsersUserRoutes

The routes for the Dropbox.Api.Users namespace

Inheritance

System.Object

UsersUserRoutes

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.Users.Routes

Assembly: Dropbox.Api.dll

Syntax

public class UsersUserRoutes

Methods

| Improve this Doc View Source

BeginFeaturesGetValues(UserFeaturesGetValuesBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the features get values route.

Declaration

public IAsyncResult BeginFeaturesGetValues(UserFeaturesGetValuesBatchArg userFeaturesGetValuesBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UserFeaturesGetValuesBatchArg	userFeaturesGetValuesBatchArg	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

BeginFeaturesGetValues(IEnumerable<UserFeature>, AsyncCallback, Object)

Begins an asynchronous send to the features get values route.

Declaration

public IAsyncResult BeginFeaturesGetValues(IEnumerable<UserFeature> features, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UserFeature>	features	A list of features in UserFeature. If the list is empty, this route will return UserFeaturesGetValuesBatchError.
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

BeginGetAccount(GetAccountArg, AsyncCallback, Object)

Begins an asynchronous send to the get account route.

Declaration

public IAsyncResult BeginGetAccount(GetAccountArg getAccountArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetAccountArg	getAccountArg	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

BeginGetAccount(String, AsyncCallback, Object)

Begins an asynchronous send to the get account route.

Declaration

public IAsyncResult BeginGetAccount(string accountId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	accountId	A user's account identifier.
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

BeginGetAccountBatch(GetAccountBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the get account batch route.

Declaration

public IAsyncResult BeginGetAccountBatch(GetAccountBatchArg getAccountBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetAccountBatchArg	getAccountBatchArg	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

BeginGetAccountBatch(IEnumerable<String>, AsyncCallback, Object)

Begins an asynchronous send to the get account batch route.

Declaration

public IAsyncResult BeginGetAccountBatch(IEnumerable<string> accountIds, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	accountIds	List of user account identifiers. Should not contain any duplicate account 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.

| Improve this Doc View Source

BeginGetCurrentAccount(AsyncCallback, Object)

Begins an asynchronous send to the get current account route.

Declaration

public IAsyncResult BeginGetCurrentAccount(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

BeginGetSpaceUsage(AsyncCallback, Object)

Begins an asynchronous send to the get space usage route.

Declaration

public IAsyncResult BeginGetSpaceUsage(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

EndFeaturesGetValues(IAsyncResult)

Waits for the pending asynchronous send to the features get values route to complete

Declaration

public UserFeaturesGetValuesBatchResult EndFeaturesGetValues(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
UserFeaturesGetValuesBatchResult	The response to the send request

Exceptions

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

| Improve this Doc View Source

EndGetAccount(IAsyncResult)

Waits for the pending asynchronous send to the get account route to complete

Declaration

public BasicAccount EndGetAccount(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
BasicAccount	The response to the send request

Exceptions

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

| Improve this Doc View Source

EndGetAccountBatch(IAsyncResult)

Waits for the pending asynchronous send to the get account batch route to complete

Declaration

public List<BasicAccount> EndGetAccountBatch(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
System.Collections.Generic.List<BasicAccount>	The response to the send request

Exceptions

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

| Improve this Doc View Source

EndGetCurrentAccount(IAsyncResult)

Waits for the pending asynchronous send to the get current account route to complete

Declaration

public FullAccount EndGetCurrentAccount(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
FullAccount	The response to the send request

| Improve this Doc View Source

EndGetSpaceUsage(IAsyncResult)

Waits for the pending asynchronous send to the get space usage route to complete

Declaration

public SpaceUsage EndGetSpaceUsage(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
SpaceUsage	The response to the send request

| Improve this Doc View Source

FeaturesGetValuesAsync(UserFeaturesGetValuesBatchArg)

Get a list of feature values that may be configured for the current account.

Declaration

public Task<UserFeaturesGetValuesBatchResult> FeaturesGetValuesAsync(UserFeaturesGetValuesBatchArg userFeaturesGetValuesBatchArg)

Parameters

Type	Name	Description
UserFeaturesGetValuesBatchArg	userFeaturesGetValuesBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<UserFeaturesGetValuesBatchResult>	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 UserFeaturesGetValuesBatchError.

| Improve this Doc View Source

FeaturesGetValuesAsync(IEnumerable<UserFeature>)

Get a list of feature values that may be configured for the current account.

Declaration

public Task<UserFeaturesGetValuesBatchResult> FeaturesGetValuesAsync(IEnumerable<UserFeature> features)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UserFeature>	features	A list of features in UserFeature. If the list is empty, this route will return UserFeaturesGetValuesBatchError.

Returns

Type	Description
System.Threading.Tasks.Task<UserFeaturesGetValuesBatchResult>	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 UserFeaturesGetValuesBatchError.

| Improve this Doc View Source

GetAccountAsync(GetAccountArg)

Get information about a user's account.

Declaration

public Task<BasicAccount> GetAccountAsync(GetAccountArg getAccountArg)

Parameters

Type	Name	Description
GetAccountArg	getAccountArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<BasicAccount>	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 GetAccountError.

| Improve this Doc View Source

GetAccountAsync(String)

Get information about a user's account.

Declaration

public Task<BasicAccount> GetAccountAsync(string accountId)

Parameters

Type	Name	Description
System.String	accountId	A user's account identifier.

Returns

Type	Description
System.Threading.Tasks.Task<BasicAccount>	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 GetAccountError.

| Improve this Doc View Source

GetAccountBatchAsync(GetAccountBatchArg)

Get information about multiple user accounts. At most 300 accounts may be queried per request.

Declaration

public Task<List<BasicAccount>> GetAccountBatchAsync(GetAccountBatchArg getAccountBatchArg)

Parameters

Type	Name	Description
GetAccountBatchArg	getAccountBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<BasicAccount>>	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 GetAccountBatchError.

| Improve this Doc View Source

GetAccountBatchAsync(IEnumerable<String>)

Get information about multiple user accounts. At most 300 accounts may be queried per request.

Declaration

public Task<List<BasicAccount>> GetAccountBatchAsync(IEnumerable<string> accountIds)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	accountIds	List of user account identifiers. Should not contain any duplicate account IDs.

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<BasicAccount>>	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 GetAccountBatchError.

| Improve this Doc View Source

GetCurrentAccountAsync()

Get information about the current user's account.

Declaration

public Task<FullAccount> GetCurrentAccountAsync()

Returns

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

| Improve this Doc View Source

GetSpaceUsageAsync()

Get the space usage information for the current user's account.

Declaration

public Task<SpaceUsage> GetSpaceUsageAsync()

Returns

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