Class SharingAppRoutes

The routes for the Dropbox.Api.Sharing namespace

Inheritance

object

SharingAppRoutes

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Dropbox.Api.Sharing.Routes

Assembly: Dropbox.Api.dll

Syntax

public class SharingAppRoutes

Methods

View Source

BeginGetSharedLinkFile(GetSharedLinkMetadataArg, AsyncCallback, object)

Begins an asynchronous send to the get shared link file route.

Declaration

public IAsyncResult BeginGetSharedLinkFile(GetSharedLinkMetadataArg getSharedLinkMetadataArg, AsyncCallback callback, object state = null)

Parameters

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

Returns

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

View Source

BeginGetSharedLinkFile(string, string, string, AsyncCallback, object)

Begins an asynchronous send to the get shared link file route.

Declaration

public IAsyncResult BeginGetSharedLinkFile(string url, string path = null, string linkPassword = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
string	url	URL of the shared link.
string	path	If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.
string	linkPassword	If the shared link has a password, this parameter can be used.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

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

View Source

BeginGetSharedLinkMetadata(GetSharedLinkMetadataArg, AsyncCallback, object)

Begins an asynchronous send to the get shared link metadata route.

Declaration

public IAsyncResult BeginGetSharedLinkMetadata(GetSharedLinkMetadataArg getSharedLinkMetadataArg, AsyncCallback callback, object state = null)

Parameters

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

Returns

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

View Source

BeginGetSharedLinkMetadata(string, string, string, AsyncCallback, object)

Begins an asynchronous send to the get shared link metadata route.

Declaration

public IAsyncResult BeginGetSharedLinkMetadata(string url, string path = null, string linkPassword = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
string	url	URL of the shared link.
string	path	If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.
string	linkPassword	If the shared link has a password, this parameter can be used.
AsyncCallback	callback	The method to be called when the asynchronous send is completed.
object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

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

View Source

EndGetSharedLinkFile(IAsyncResult)

Waits for the pending asynchronous send to the get shared link file route to complete

Declaration

public IDownloadResponse<SharedLinkMetadata> EndGetSharedLinkFile(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
IDownloadResponse<SharedLinkMetadata>	The response to the send request

Exceptions

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

View Source

EndGetSharedLinkMetadata(IAsyncResult)

Waits for the pending asynchronous send to the get shared link metadata route to complete

Declaration

public SharedLinkMetadata EndGetSharedLinkMetadata(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
SharedLinkMetadata	The response to the send request

Exceptions

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

View Source

GetSharedLinkFileAsync(GetSharedLinkMetadataArg)

Download the shared link's file from a user's Dropbox. This is a download-style endpoint that returns the file content.

Declaration

public Task<IDownloadResponse<SharedLinkMetadata>> GetSharedLinkFileAsync(GetSharedLinkMetadataArg getSharedLinkMetadataArg)

Parameters

Type	Name	Description
GetSharedLinkMetadataArg	getSharedLinkMetadataArg	The request parameters

Returns

Type	Description
Task<IDownloadResponse<SharedLinkMetadata>>	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 GetSharedLinkFileError.

View Source

GetSharedLinkFileAsync(string, string, string)

Download the shared link's file from a user's Dropbox. This is a download-style endpoint that returns the file content.

Declaration

public Task<IDownloadResponse<SharedLinkMetadata>> GetSharedLinkFileAsync(string url, string path = null, string linkPassword = null)

Parameters

Type	Name	Description
string	url	URL of the shared link.
string	path	If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.
string	linkPassword	If the shared link has a password, this parameter can be used.

Returns

Type	Description
Task<IDownloadResponse<SharedLinkMetadata>>	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 GetSharedLinkFileError.

View Source

GetSharedLinkMetadataAsync(GetSharedLinkMetadataArg)

Get the shared link's metadata.

Declaration

public Task<SharedLinkMetadata> GetSharedLinkMetadataAsync(GetSharedLinkMetadataArg getSharedLinkMetadataArg)

Parameters

Type	Name	Description
GetSharedLinkMetadataArg	getSharedLinkMetadataArg	The request parameters

Returns

Type	Description
Task<SharedLinkMetadata>	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 SharedLinkMetadataError.

View Source

GetSharedLinkMetadataAsync(string, string, string)

Get the shared link's metadata.

Declaration

public Task<SharedLinkMetadata> GetSharedLinkMetadataAsync(string url, string path = null, string linkPassword = null)

Parameters

Type	Name	Description
string	url	URL of the shared link.
string	path	If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.
string	linkPassword	If the shared link has a password, this parameter can be used.

Returns

Type	Description
Task<SharedLinkMetadata>	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 SharedLinkMetadataError.