Class SharingUserRoutes

The routes for the Dropbox.Api.Sharing namespace

Inheritance

System.Object

SharingUserRoutes

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

Assembly: Dropbox.Api.dll

Syntax

public class SharingUserRoutes

Methods

AddFileMemberAsync(AddFileMemberArgs)

Adds specified members to a file.

Declaration

public Task<List<FileMemberActionResult>> AddFileMemberAsync(AddFileMemberArgs addFileMemberArgs)

Parameters

Type	Name	Description
AddFileMemberArgs	addFileMemberArgs	The request parameters

Returns

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

AddFileMemberAsync(String, IEnumerable<MemberSelector>, String, Boolean, AccessLevel, Boolean)

Adds specified members to a file.

Declaration

public Task<List<FileMemberActionResult>> AddFileMemberAsync(string file, IEnumerable<MemberSelector> members, string customMessage = null, bool quiet = false, AccessLevel accessLevel = null, bool addMessageAsComment = false)

Parameters

Type	Name	Description
System.String	file	File to which to add members.
System.Collections.Generic.IEnumerable<MemberSelector>	members	Members to add. Note that even an email address is given, this may result in a user being directly added to the membership if that email is the user's main account email.
System.String	customMessage	Message to send to added members in their invitation.
System.Boolean	quiet	Whether added members should be notified via email and device notifications of their invitation.
AccessLevel	accessLevel	AccessLevel union object, describing what access level we want to give new members.
System.Boolean	addMessageAsComment	If the custom message should be added as a comment on the file.

Returns

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

AddFolderMemberAsync(AddFolderMemberArg)

Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member.

For the new member to get access to all the functionality for this folder, you will need to call MountFolderAsync(MountFolderArg) on their behalf.

Declaration

public Task AddFolderMemberAsync(AddFolderMemberArg addFolderMemberArg)

Parameters

Type	Name	Description
AddFolderMemberArg	addFolderMemberArg	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 AddFolderMemberError.

AddFolderMemberAsync(String, IEnumerable<AddMember>, Boolean, String)

Allows an owner or editor (if the ACL update policy allows) of a shared folder to add another member.

For the new member to get access to all the functionality for this folder, you will need to call MountFolderAsync(MountFolderArg) on their behalf.

Declaration

public Task AddFolderMemberAsync(string sharedFolderId, IEnumerable<AddMember> members, bool quiet = false, string customMessage = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
System.Collections.Generic.IEnumerable<AddMember>	members	The intended list of members to add. Added members will receive invites to join the shared folder.
System.Boolean	quiet	Whether added members should be notified via email and device notifications of their invite.
System.String	customMessage	Optional message to display to added members in their invitation.

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

BeginAddFileMember(AddFileMemberArgs, AsyncCallback, Object)

Begins an asynchronous send to the add file member route.

Declaration

public IAsyncResult BeginAddFileMember(AddFileMemberArgs addFileMemberArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
AddFileMemberArgs	addFileMemberArgs	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.

BeginAddFileMember(String, IEnumerable<MemberSelector>, String, Boolean, AccessLevel, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the add file member route.

Declaration

public IAsyncResult BeginAddFileMember(string file, IEnumerable<MemberSelector> members, string customMessage = null, bool quiet = false, AccessLevel accessLevel = null, bool addMessageAsComment = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	file	File to which to add members.
System.Collections.Generic.IEnumerable<MemberSelector>	members	Members to add. Note that even an email address is given, this may result in a user being directly added to the membership if that email is the user's main account email.
System.String	customMessage	Message to send to added members in their invitation.
System.Boolean	quiet	Whether added members should be notified via email and device notifications of their invitation.
AccessLevel	accessLevel	AccessLevel union object, describing what access level we want to give new members.
System.Boolean	addMessageAsComment	If the custom message should be added as a comment on the file.
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.

BeginAddFolderMember(AddFolderMemberArg, AsyncCallback, Object)

Begins an asynchronous send to the add folder member route.

Declaration

public IAsyncResult BeginAddFolderMember(AddFolderMemberArg addFolderMemberArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
AddFolderMemberArg	addFolderMemberArg	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.

BeginAddFolderMember(String, IEnumerable<AddMember>, Boolean, String, AsyncCallback, Object)

Begins an asynchronous send to the add folder member route.

Declaration

public IAsyncResult BeginAddFolderMember(string sharedFolderId, IEnumerable<AddMember> members, bool quiet = false, string customMessage = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
System.Collections.Generic.IEnumerable<AddMember>	members	The intended list of members to add. Added members will receive invites to join the shared folder.
System.Boolean	quiet	Whether added members should be notified via email and device notifications of their invite.
System.String	customMessage	Optional message to display to added members in their invitation.
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.

BeginCheckJobStatus(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the check job status route.

Declaration

public IAsyncResult BeginCheckJobStatus(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	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.

BeginCheckJobStatus(String, AsyncCallback, Object)

Begins an asynchronous send to the check job status route.

Declaration

public IAsyncResult BeginCheckJobStatus(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
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.

BeginCheckRemoveMemberJobStatus(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the check remove member job status route.

Declaration

public IAsyncResult BeginCheckRemoveMemberJobStatus(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	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.

BeginCheckRemoveMemberJobStatus(String, AsyncCallback, Object)

Begins an asynchronous send to the check remove member job status route.

Declaration

public IAsyncResult BeginCheckRemoveMemberJobStatus(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
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.

BeginCheckShareJobStatus(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the check share job status route.

Declaration

public IAsyncResult BeginCheckShareJobStatus(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	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.

BeginCheckShareJobStatus(String, AsyncCallback, Object)

Begins an asynchronous send to the check share job status route.

Declaration

public IAsyncResult BeginCheckShareJobStatus(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
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.

BeginCreateSharedLink(CreateSharedLinkArg, AsyncCallback, Object)

Begins an asynchronous send to the create shared link route.

Declaration

[Obsolete("This function is deprecated, please use BeginCreateSharedLinkWithSettings instead.")]
public IAsyncResult BeginCreateSharedLink(CreateSharedLinkArg createSharedLinkArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
CreateSharedLinkArg	createSharedLinkArg	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.

BeginCreateSharedLink(String, Boolean, PendingUploadMode, AsyncCallback, Object)

Begins an asynchronous send to the create shared link route.

Declaration

[Obsolete("This function is deprecated, please use BeginCreateSharedLinkWithSettings instead.")]
public IAsyncResult BeginCreateSharedLink(string path, bool shortUrl = false, PendingUploadMode pendingUpload = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path to share.
System.Boolean	shortUrl	The short url
PendingUploadMode	pendingUpload	If it's okay to share a path that does not yet exist, set this to either PendingUploadMode.File or PendingUploadMode.Folder to indicate whether to assume it's a file or folder.
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.

BeginCreateSharedLinkWithSettings(CreateSharedLinkWithSettingsArg, AsyncCallback, Object)

Begins an asynchronous send to the create shared link with settings route.

Declaration

public IAsyncResult BeginCreateSharedLinkWithSettings(CreateSharedLinkWithSettingsArg createSharedLinkWithSettingsArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
CreateSharedLinkWithSettingsArg	createSharedLinkWithSettingsArg	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.

BeginCreateSharedLinkWithSettings(String, SharedLinkSettings, AsyncCallback, Object)

Begins an asynchronous send to the create shared link with settings route.

Declaration

public IAsyncResult BeginCreateSharedLinkWithSettings(string path, SharedLinkSettings settings = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path to be shared by the shared link.
SharedLinkSettings	settings	The requested settings for the newly created shared link.
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.

BeginGetFileMetadata(GetFileMetadataArg, AsyncCallback, Object)

Begins an asynchronous send to the get file metadata route.

Declaration

public IAsyncResult BeginGetFileMetadata(GetFileMetadataArg getFileMetadataArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetFileMetadataArg	getFileMetadataArg	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.

BeginGetFileMetadata(String, IEnumerable<FileAction>, AsyncCallback, Object)

Begins an asynchronous send to the get file metadata route.

Declaration

public IAsyncResult BeginGetFileMetadata(string file, IEnumerable<FileAction> actions = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	file	The file to query.
System.Collections.Generic.IEnumerable<FileAction>	actions	A list of FileActions corresponding to FilePermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the file.
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.

BeginGetFileMetadataBatch(GetFileMetadataBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the get file metadata batch route.

Declaration

public IAsyncResult BeginGetFileMetadataBatch(GetFileMetadataBatchArg getFileMetadataBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetFileMetadataBatchArg	getFileMetadataBatchArg	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.

BeginGetFileMetadataBatch(IEnumerable<String>, IEnumerable<FileAction>, AsyncCallback, Object)

Begins an asynchronous send to the get file metadata batch route.

Declaration

public IAsyncResult BeginGetFileMetadataBatch(IEnumerable<string> files, IEnumerable<FileAction> actions = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	files	The files to query.
System.Collections.Generic.IEnumerable<FileAction>	actions	A list of FileActions corresponding to FilePermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the file.
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.

BeginGetFolderMetadata(GetMetadataArgs, AsyncCallback, Object)

Begins an asynchronous send to the get folder metadata route.

Declaration

public IAsyncResult BeginGetFolderMetadata(GetMetadataArgs getMetadataArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetMetadataArgs	getMetadataArgs	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.

BeginGetFolderMetadata(String, IEnumerable<FolderAction>, AsyncCallback, Object)

Begins an asynchronous send to the get folder metadata route.

Declaration

public IAsyncResult BeginGetFolderMetadata(string sharedFolderId, IEnumerable<FolderAction> actions = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
System.Collections.Generic.IEnumerable<FolderAction>	actions	A list of FolderActions corresponding to FolderPermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the folder.
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.

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

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
System.String	url	URL of the shared link.
System.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.
System.String	linkPassword	If the shared link has a password, this parameter can be used.
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.

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

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
System.String	url	URL of the shared link.
System.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.
System.String	linkPassword	If the shared link has a password, this parameter can be used.
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.

BeginGetSharedLinks(GetSharedLinksArg, AsyncCallback, Object)

Begins an asynchronous send to the get shared links route.

Declaration

[Obsolete("This function is deprecated, please use BeginListSharedLinks instead.")]
public IAsyncResult BeginGetSharedLinks(GetSharedLinksArg getSharedLinksArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetSharedLinksArg	getSharedLinksArg	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.

BeginGetSharedLinks(String, AsyncCallback, Object)

Begins an asynchronous send to the get shared links route.

Declaration

[Obsolete("This function is deprecated, please use BeginListSharedLinks instead.")]
public IAsyncResult BeginGetSharedLinks(string path = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	See GetSharedLinksAsync(GetSharedLinksArg) description.
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.

BeginListFileMembers(ListFileMembersArg, AsyncCallback, Object)

Begins an asynchronous send to the list file members route.

Declaration

public IAsyncResult BeginListFileMembers(ListFileMembersArg listFileMembersArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFileMembersArg	listFileMembersArg	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.

BeginListFileMembers(String, IEnumerable<MemberAction>, Boolean, UInt32, AsyncCallback, Object)

Begins an asynchronous send to the list file members route.

Declaration

public IAsyncResult BeginListFileMembers(string file, IEnumerable<MemberAction> actions = null, bool includeInherited = true, uint limit = 100U, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	file	The file for which you want to see members.
System.Collections.Generic.IEnumerable<MemberAction>	actions	The actions for which to return permissions on a member.
System.Boolean	includeInherited	Whether to include members who only have access from a parent shared folder.
System.UInt32	limit	Number of members to return max per query. Defaults to 100 if no limit is specified.
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.

BeginListFileMembersBatch(ListFileMembersBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the list file members batch route.

Declaration

public IAsyncResult BeginListFileMembersBatch(ListFileMembersBatchArg listFileMembersBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFileMembersBatchArg	listFileMembersBatchArg	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.

BeginListFileMembersBatch(IEnumerable<String>, UInt32, AsyncCallback, Object)

Begins an asynchronous send to the list file members batch route.

Declaration

public IAsyncResult BeginListFileMembersBatch(IEnumerable<string> files, uint limit = 10U, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	files	Files for which to return members.
System.UInt32	limit	Number of members to return max per query. Defaults to 10 if no limit is specified.
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.

BeginListFileMembersContinue(ListFileMembersContinueArg, AsyncCallback, Object)

Begins an asynchronous send to the list file members continue route.

Declaration

public IAsyncResult BeginListFileMembersContinue(ListFileMembersContinueArg listFileMembersContinueArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFileMembersContinueArg	listFileMembersContinueArg	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.

BeginListFileMembersContinue(String, AsyncCallback, Object)

Begins an asynchronous send to the list file members continue route.

Declaration

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

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by your last call to ListFileMembersAsync(ListFileMembersArg), ListFileMembersContinueAsync(ListFileMembersContinueArg), or ListFileMembersBatchAsync(ListFileMembersBatchArg).
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.

BeginListFolderMembers(ListFolderMembersArgs, AsyncCallback, Object)

Begins an asynchronous send to the list folder members route.

Declaration

public IAsyncResult BeginListFolderMembers(ListFolderMembersArgs listFolderMembersArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFolderMembersArgs	listFolderMembersArgs	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.

BeginListFolderMembers(String, IEnumerable<MemberAction>, UInt32, AsyncCallback, Object)

Begins an asynchronous send to the list folder members route.

Declaration

public IAsyncResult BeginListFolderMembers(string sharedFolderId, IEnumerable<MemberAction> actions = null, uint limit = 1000U, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
System.Collections.Generic.IEnumerable<MemberAction>	actions	This is a list indicating whether each returned member will include a boolean value Allow that describes whether the current user can perform the MemberAction on the member.
System.UInt32	limit	The maximum number of results that include members, groups and invitees to return per request.
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.

BeginListFolderMembersContinue(ListFolderMembersContinueArg, AsyncCallback, Object)

Begins an asynchronous send to the list folder members continue route.

Declaration

public IAsyncResult BeginListFolderMembersContinue(ListFolderMembersContinueArg listFolderMembersContinueArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFolderMembersContinueArg	listFolderMembersContinueArg	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.

BeginListFolderMembersContinue(String, AsyncCallback, Object)

Begins an asynchronous send to the list folder members continue route.

Declaration

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

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by your last call to ListFolderMembersAsync(ListFolderMembersArgs) or ListFolderMembersContinueAsync(ListFolderMembersContinueArg).
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.

BeginListFolders(ListFoldersArgs, AsyncCallback, Object)

Begins an asynchronous send to the list folders route.

Declaration

public IAsyncResult BeginListFolders(ListFoldersArgs listFoldersArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFoldersArgs	listFoldersArgs	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.

BeginListFolders(UInt32, IEnumerable<FolderAction>, AsyncCallback, Object)

Begins an asynchronous send to the list folders route.

Declaration

public IAsyncResult BeginListFolders(uint limit = 1000U, IEnumerable<FolderAction> actions = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.UInt32	limit	The maximum number of results to return per request.
System.Collections.Generic.IEnumerable<FolderAction>	actions	A list of FolderActions corresponding to FolderPermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the folder.
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.

BeginListFoldersContinue(ListFoldersContinueArg, AsyncCallback, Object)

Begins an asynchronous send to the list folders continue route.

Declaration

public IAsyncResult BeginListFoldersContinue(ListFoldersContinueArg listFoldersContinueArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFoldersContinueArg	listFoldersContinueArg	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.

BeginListFoldersContinue(String, AsyncCallback, Object)

Begins an asynchronous send to the list folders continue route.

Declaration

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

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by the previous API call specified in the endpoint description.
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.

BeginListMountableFolders(ListFoldersArgs, AsyncCallback, Object)

Begins an asynchronous send to the list mountable folders route.

Declaration

public IAsyncResult BeginListMountableFolders(ListFoldersArgs listFoldersArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFoldersArgs	listFoldersArgs	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.

BeginListMountableFolders(UInt32, IEnumerable<FolderAction>, AsyncCallback, Object)

Begins an asynchronous send to the list mountable folders route.

Declaration

public IAsyncResult BeginListMountableFolders(uint limit = 1000U, IEnumerable<FolderAction> actions = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.UInt32	limit	The maximum number of results to return per request.
System.Collections.Generic.IEnumerable<FolderAction>	actions	A list of FolderActions corresponding to FolderPermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the folder.
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.

BeginListMountableFoldersContinue(ListFoldersContinueArg, AsyncCallback, Object)

Begins an asynchronous send to the list mountable folders continue route.

Declaration

public IAsyncResult BeginListMountableFoldersContinue(ListFoldersContinueArg listFoldersContinueArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFoldersContinueArg	listFoldersContinueArg	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.

BeginListMountableFoldersContinue(String, AsyncCallback, Object)

Begins an asynchronous send to the list mountable folders continue route.

Declaration

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

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by the previous API call specified in the endpoint description.
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.

BeginListReceivedFiles(ListFilesArg, AsyncCallback, Object)

Begins an asynchronous send to the list received files route.

Declaration

public IAsyncResult BeginListReceivedFiles(ListFilesArg listFilesArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFilesArg	listFilesArg	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.

BeginListReceivedFiles(UInt32, IEnumerable<FileAction>, AsyncCallback, Object)

Begins an asynchronous send to the list received files route.

Declaration

public IAsyncResult BeginListReceivedFiles(uint limit = 100U, IEnumerable<FileAction> actions = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.UInt32	limit	Number of files to return max per query. Defaults to 100 if no limit is specified.
System.Collections.Generic.IEnumerable<FileAction>	actions	A list of FileActions corresponding to FilePermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the file.
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.

BeginListReceivedFilesContinue(ListFilesContinueArg, AsyncCallback, Object)

Begins an asynchronous send to the list received files continue route.

Declaration

public IAsyncResult BeginListReceivedFilesContinue(ListFilesContinueArg listFilesContinueArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFilesContinueArg	listFilesContinueArg	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.

BeginListReceivedFilesContinue(String, AsyncCallback, Object)

Begins an asynchronous send to the list received files continue route.

Declaration

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

Parameters

Type	Name	Description
System.String	cursor	Cursor in Cursor.
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.

BeginListSharedLinks(ListSharedLinksArg, AsyncCallback, Object)

Begins an asynchronous send to the list shared links route.

Declaration

public IAsyncResult BeginListSharedLinks(ListSharedLinksArg listSharedLinksArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListSharedLinksArg	listSharedLinksArg	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.

BeginListSharedLinks(String, String, Nullable<Boolean>, AsyncCallback, Object)

Begins an asynchronous send to the list shared links route.

Declaration

public IAsyncResult BeginListSharedLinks(string path = null, string cursor = null, bool? directOnly = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	See ListSharedLinksAsync(ListSharedLinksArg) description.
System.String	cursor	The cursor returned by your last call to ListSharedLinksAsync(ListSharedLinksArg).
System.Nullable<System.Boolean>	directOnly	See ListSharedLinksAsync(ListSharedLinksArg) description.
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.

BeginModifySharedLinkSettings(ModifySharedLinkSettingsArgs, AsyncCallback, Object)

Begins an asynchronous send to the modify shared link settings route.

Declaration

public IAsyncResult BeginModifySharedLinkSettings(ModifySharedLinkSettingsArgs modifySharedLinkSettingsArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ModifySharedLinkSettingsArgs	modifySharedLinkSettingsArgs	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.

BeginModifySharedLinkSettings(String, SharedLinkSettings, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the modify shared link settings route.

Declaration

public IAsyncResult BeginModifySharedLinkSettings(string url, SharedLinkSettings settings, bool removeExpiration = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	url	URL of the shared link to change its settings.
SharedLinkSettings	settings	Set of settings for the shared link.
System.Boolean	removeExpiration	If set to true, removes the expiration of the shared link.
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.

BeginMountFolder(MountFolderArg, AsyncCallback, Object)

Begins an asynchronous send to the mount folder route.

Declaration

public IAsyncResult BeginMountFolder(MountFolderArg mountFolderArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
MountFolderArg	mountFolderArg	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.

BeginMountFolder(String, AsyncCallback, Object)

Begins an asynchronous send to the mount folder route.

Declaration

public IAsyncResult BeginMountFolder(string sharedFolderId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID of the shared folder to mount.
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.

BeginRelinquishFileMembership(RelinquishFileMembershipArg, AsyncCallback, Object)

Begins an asynchronous send to the relinquish file membership route.

Declaration

public IAsyncResult BeginRelinquishFileMembership(RelinquishFileMembershipArg relinquishFileMembershipArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RelinquishFileMembershipArg	relinquishFileMembershipArg	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.

BeginRelinquishFileMembership(String, AsyncCallback, Object)

Begins an asynchronous send to the relinquish file membership route.

Declaration

public IAsyncResult BeginRelinquishFileMembership(string file, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	file	The path or id for the file.
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.

BeginRelinquishFolderMembership(RelinquishFolderMembershipArg, AsyncCallback, Object)

Begins an asynchronous send to the relinquish folder membership route.

Declaration

public IAsyncResult BeginRelinquishFolderMembership(RelinquishFolderMembershipArg relinquishFolderMembershipArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RelinquishFolderMembershipArg	relinquishFolderMembershipArg	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.

BeginRelinquishFolderMembership(String, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the relinquish folder membership route.

Declaration

public IAsyncResult BeginRelinquishFolderMembership(string sharedFolderId, bool leaveACopy = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
System.Boolean	leaveACopy	Keep a copy of the folder's contents upon relinquishing membership. This must be set to false when the folder is within a team folder or another shared folder.
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.

BeginRemoveFileMember(RemoveFileMemberArg, AsyncCallback, Object)

Begins an asynchronous send to the remove file member route.

Declaration

[Obsolete("This function is deprecated, please use BeginRemoveFileMember2 instead.")]
public IAsyncResult BeginRemoveFileMember(RemoveFileMemberArg removeFileMemberArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RemoveFileMemberArg	removeFileMemberArg	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.

BeginRemoveFileMember(String, MemberSelector, AsyncCallback, Object)

Begins an asynchronous send to the remove file member route.

Declaration

[Obsolete("This function is deprecated, please use BeginRemoveFileMember2 instead.")]
public IAsyncResult BeginRemoveFileMember(string file, MemberSelector member, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	file	File from which to remove members.
MemberSelector	member	Member to remove from this file. Note that even if an email is specified, it may result in the removal of a user (not an invitee) if the user's main account corresponds to that email address.
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.

BeginRemoveFileMember2(RemoveFileMemberArg, AsyncCallback, Object)

Begins an asynchronous send to the remove file member 2 route.

Declaration

public IAsyncResult BeginRemoveFileMember2(RemoveFileMemberArg removeFileMemberArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RemoveFileMemberArg	removeFileMemberArg	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.

BeginRemoveFileMember2(String, MemberSelector, AsyncCallback, Object)

Begins an asynchronous send to the remove file member 2 route.

Declaration

public IAsyncResult BeginRemoveFileMember2(string file, MemberSelector member, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	file	File from which to remove members.
MemberSelector	member	Member to remove from this file. Note that even if an email is specified, it may result in the removal of a user (not an invitee) if the user's main account corresponds to that email address.
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.

BeginRemoveFolderMember(RemoveFolderMemberArg, AsyncCallback, Object)

Begins an asynchronous send to the remove folder member route.

Declaration

public IAsyncResult BeginRemoveFolderMember(RemoveFolderMemberArg removeFolderMemberArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RemoveFolderMemberArg	removeFolderMemberArg	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.

BeginRemoveFolderMember(String, MemberSelector, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the remove folder member route.

Declaration

public IAsyncResult BeginRemoveFolderMember(string sharedFolderId, MemberSelector member, bool leaveACopy, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
MemberSelector	member	The member to remove from the folder.
System.Boolean	leaveACopy	If true, the removed user will keep their copy of the folder after it's unshared, assuming it was mounted. Otherwise, it will be removed from their Dropbox. This must be set to false when removing a group, or when the folder is within a team folder or another shared folder.
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.

BeginRevokeSharedLink(RevokeSharedLinkArg, AsyncCallback, Object)

Begins an asynchronous send to the revoke shared link route.

Declaration

public IAsyncResult BeginRevokeSharedLink(RevokeSharedLinkArg revokeSharedLinkArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RevokeSharedLinkArg	revokeSharedLinkArg	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.

BeginRevokeSharedLink(String, AsyncCallback, Object)

Begins an asynchronous send to the revoke shared link route.

Declaration

public IAsyncResult BeginRevokeSharedLink(string url, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	url	URL of the shared link.
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.

BeginSetAccessInheritance(SetAccessInheritanceArg, AsyncCallback, Object)

Begins an asynchronous send to the set access inheritance route.

Declaration

public IAsyncResult BeginSetAccessInheritance(SetAccessInheritanceArg setAccessInheritanceArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
SetAccessInheritanceArg	setAccessInheritanceArg	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.

BeginSetAccessInheritance(String, AccessInheritance, AsyncCallback, Object)

Begins an asynchronous send to the set access inheritance route.

Declaration

public IAsyncResult BeginSetAccessInheritance(string sharedFolderId, AccessInheritance accessInheritance = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
AccessInheritance	accessInheritance	The access inheritance settings for the folder.
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.

BeginShareFolder(ShareFolderArg, AsyncCallback, Object)

Begins an asynchronous send to the share folder route.

Declaration

public IAsyncResult BeginShareFolder(ShareFolderArg shareFolderArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ShareFolderArg	shareFolderArg	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.

BeginShareFolder(String, AclUpdatePolicy, Boolean, MemberPolicy, SharedLinkPolicy, ViewerInfoPolicy, AccessInheritance, IEnumerable<FolderAction>, LinkSettings, AsyncCallback, Object)

Begins an asynchronous send to the share folder route.

Declaration

public IAsyncResult BeginShareFolder(string path, AclUpdatePolicy aclUpdatePolicy = null, bool forceAsync = false, MemberPolicy memberPolicy = null, SharedLinkPolicy sharedLinkPolicy = null, ViewerInfoPolicy viewerInfoPolicy = null, AccessInheritance accessInheritance = null, IEnumerable<FolderAction> actions = null, LinkSettings linkSettings = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path to the folder to share. If it does not exist, then a new one is created.
AclUpdatePolicy	aclUpdatePolicy	Who can add and remove members of this shared folder.
System.Boolean	forceAsync	Whether to force the share to happen asynchronously.
MemberPolicy	memberPolicy	Who can be a member of this shared folder. Only applicable if the current user is on a team.
SharedLinkPolicy	sharedLinkPolicy	The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.Members.
ViewerInfoPolicy	viewerInfoPolicy	Who can enable/disable viewer info for this shared folder.
AccessInheritance	accessInheritance	The access inheritance settings for the folder.
System.Collections.Generic.IEnumerable<FolderAction>	actions	A list of FolderActions corresponding to FolderPermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the folder.
LinkSettings	linkSettings	Settings on the link for this folder.
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.

BeginTransferFolder(TransferFolderArg, AsyncCallback, Object)

Begins an asynchronous send to the transfer folder route.

Declaration

public IAsyncResult BeginTransferFolder(TransferFolderArg transferFolderArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
TransferFolderArg	transferFolderArg	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.

BeginTransferFolder(String, String, AsyncCallback, Object)

Begins an asynchronous send to the transfer folder route.

Declaration

public IAsyncResult BeginTransferFolder(string sharedFolderId, string toDropboxId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
System.String	toDropboxId	A account or team member ID to transfer ownership to.
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.

BeginUnmountFolder(UnmountFolderArg, AsyncCallback, Object)

Begins an asynchronous send to the unmount folder route.

Declaration

public IAsyncResult BeginUnmountFolder(UnmountFolderArg unmountFolderArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UnmountFolderArg	unmountFolderArg	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.

BeginUnmountFolder(String, AsyncCallback, Object)

Begins an asynchronous send to the unmount folder route.

Declaration

public IAsyncResult BeginUnmountFolder(string sharedFolderId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
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.

BeginUnshareFile(UnshareFileArg, AsyncCallback, Object)

Begins an asynchronous send to the unshare file route.

Declaration

public IAsyncResult BeginUnshareFile(UnshareFileArg unshareFileArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UnshareFileArg	unshareFileArg	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.

BeginUnshareFile(String, AsyncCallback, Object)

Begins an asynchronous send to the unshare file route.

Declaration

public IAsyncResult BeginUnshareFile(string file, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	file	The file to unshare.
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.

BeginUnshareFolder(UnshareFolderArg, AsyncCallback, Object)

Begins an asynchronous send to the unshare folder route.

Declaration

public IAsyncResult BeginUnshareFolder(UnshareFolderArg unshareFolderArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UnshareFolderArg	unshareFolderArg	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.

BeginUnshareFolder(String, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the unshare folder route.

Declaration

public IAsyncResult BeginUnshareFolder(string sharedFolderId, bool leaveACopy = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
System.Boolean	leaveACopy	If true, members of this shared folder will get a copy of this folder after it's unshared. Otherwise, it will be removed from their Dropbox. The current user, who is an owner, will always retain their copy.
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.

BeginUpdateFileMember(UpdateFileMemberArgs, AsyncCallback, Object)

Begins an asynchronous send to the update file member route.

Declaration

public IAsyncResult BeginUpdateFileMember(UpdateFileMemberArgs updateFileMemberArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UpdateFileMemberArgs	updateFileMemberArgs	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.

BeginUpdateFileMember(String, MemberSelector, AccessLevel, AsyncCallback, Object)

Begins an asynchronous send to the update file member route.

Declaration

public IAsyncResult BeginUpdateFileMember(string file, MemberSelector member, AccessLevel accessLevel, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	file	File for which we are changing a member's access.
MemberSelector	member	The member whose access we are changing.
AccessLevel	accessLevel	The new access level for the member.
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.

BeginUpdateFolderMember(UpdateFolderMemberArg, AsyncCallback, Object)

Begins an asynchronous send to the update folder member route.

Declaration

public IAsyncResult BeginUpdateFolderMember(UpdateFolderMemberArg updateFolderMemberArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UpdateFolderMemberArg	updateFolderMemberArg	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.

BeginUpdateFolderMember(String, MemberSelector, AccessLevel, AsyncCallback, Object)

Begins an asynchronous send to the update folder member route.

Declaration

public IAsyncResult BeginUpdateFolderMember(string sharedFolderId, MemberSelector member, AccessLevel accessLevel, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
MemberSelector	member	The member of the shared folder to update. Only the MemberSelector.DropboxId may be set at this time.
AccessLevel	accessLevel	The new access level for member. AccessLevel.Owner is disallowed.
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.

BeginUpdateFolderPolicy(UpdateFolderPolicyArg, AsyncCallback, Object)

Begins an asynchronous send to the update folder policy route.

Declaration

public IAsyncResult BeginUpdateFolderPolicy(UpdateFolderPolicyArg updateFolderPolicyArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UpdateFolderPolicyArg	updateFolderPolicyArg	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.

BeginUpdateFolderPolicy(String, MemberPolicy, AclUpdatePolicy, ViewerInfoPolicy, SharedLinkPolicy, LinkSettings, IEnumerable<FolderAction>, AsyncCallback, Object)

Begins an asynchronous send to the update folder policy route.

Declaration

public IAsyncResult BeginUpdateFolderPolicy(string sharedFolderId, MemberPolicy memberPolicy = null, AclUpdatePolicy aclUpdatePolicy = null, ViewerInfoPolicy viewerInfoPolicy = null, SharedLinkPolicy sharedLinkPolicy = null, LinkSettings linkSettings = null, IEnumerable<FolderAction> actions = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
MemberPolicy	memberPolicy	Who can be a member of this shared folder. Only applicable if the current user is on a team.
AclUpdatePolicy	aclUpdatePolicy	Who can add and remove members of this shared folder.
ViewerInfoPolicy	viewerInfoPolicy	Who can enable/disable viewer info for this shared folder.
SharedLinkPolicy	sharedLinkPolicy	The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.Members.
LinkSettings	linkSettings	Settings on the link for this folder.
System.Collections.Generic.IEnumerable<FolderAction>	actions	A list of FolderActions corresponding to FolderPermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the folder.
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.

CheckJobStatusAsync(PollArg)

Returns the status of an asynchronous job.

Declaration

public Task<JobStatus> CheckJobStatusAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<JobStatus>	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 PollError.

CheckJobStatusAsync(String)

Returns the status of an asynchronous job.

Declaration

public Task<JobStatus> CheckJobStatusAsync(string asyncJobId)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
System.Threading.Tasks.Task<JobStatus>	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 PollError.

CheckRemoveMemberJobStatusAsync(PollArg)

Returns the status of an asynchronous job for sharing a folder.

Declaration

public Task<RemoveMemberJobStatus> CheckRemoveMemberJobStatusAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<RemoveMemberJobStatus>	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 PollError.

CheckRemoveMemberJobStatusAsync(String)

Returns the status of an asynchronous job for sharing a folder.

Declaration

public Task<RemoveMemberJobStatus> CheckRemoveMemberJobStatusAsync(string asyncJobId)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
System.Threading.Tasks.Task<RemoveMemberJobStatus>	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 PollError.

CheckShareJobStatusAsync(PollArg)

Returns the status of an asynchronous job for sharing a folder.

Declaration

public Task<ShareFolderJobStatus> CheckShareJobStatusAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ShareFolderJobStatus>	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 PollError.

CheckShareJobStatusAsync(String)

Returns the status of an asynchronous job for sharing a folder.

Declaration

public Task<ShareFolderJobStatus> CheckShareJobStatusAsync(string asyncJobId)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
System.Threading.Tasks.Task<ShareFolderJobStatus>	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 PollError.

CreateSharedLinkAsync(CreateSharedLinkArg)

Create a shared link.

If a shared link already exists for the given path, that link is returned.

Previously, it was technically possible to break a shared link by moving or renaming the corresponding file or folder. In the future, this will no longer be the case, so your app shouldn't rely on this behavior. Instead, if your app needs to revoke a shared link, use RevokeSharedLinkAsync(RevokeSharedLinkArg).

Declaration

[Obsolete("This function is deprecated, please use CreateSharedLinkWithSettingsAsync instead.")]
public Task<PathLinkMetadata> CreateSharedLinkAsync(CreateSharedLinkArg createSharedLinkArg)

Parameters

Type	Name	Description
CreateSharedLinkArg	createSharedLinkArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<PathLinkMetadata>	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 CreateSharedLinkError.

CreateSharedLinkAsync(String, Boolean, PendingUploadMode)

Create a shared link.

If a shared link already exists for the given path, that link is returned.

Previously, it was technically possible to break a shared link by moving or renaming the corresponding file or folder. In the future, this will no longer be the case, so your app shouldn't rely on this behavior. Instead, if your app needs to revoke a shared link, use RevokeSharedLinkAsync(RevokeSharedLinkArg).

Declaration

[Obsolete("This function is deprecated, please use CreateSharedLinkWithSettingsAsync instead.")]
public Task<PathLinkMetadata> CreateSharedLinkAsync(string path, bool shortUrl = false, PendingUploadMode pendingUpload = null)

Parameters

Type	Name	Description
System.String	path	The path to share.
System.Boolean	shortUrl	The short url
PendingUploadMode	pendingUpload	If it's okay to share a path that does not yet exist, set this to either PendingUploadMode.File or PendingUploadMode.Folder to indicate whether to assume it's a file or folder.

Returns

Type	Description
System.Threading.Tasks.Task<PathLinkMetadata>	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 CreateSharedLinkError.

CreateSharedLinkWithSettingsAsync(CreateSharedLinkWithSettingsArg)

Create a shared link with custom settings. If no settings are given then the default visibility is RequestedVisibility.Public (The resolved visibility, though, may depend on other aspects such as team and shared folder settings).

Declaration

public Task<SharedLinkMetadata> CreateSharedLinkWithSettingsAsync(CreateSharedLinkWithSettingsArg createSharedLinkWithSettingsArg)

Parameters

Type	Name	Description
CreateSharedLinkWithSettingsArg	createSharedLinkWithSettingsArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.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 CreateSharedLinkWithSettingsError.

CreateSharedLinkWithSettingsAsync(String, SharedLinkSettings)

Create a shared link with custom settings. If no settings are given then the default visibility is RequestedVisibility.Public (The resolved visibility, though, may depend on other aspects such as team and shared folder settings).

Declaration

public Task<SharedLinkMetadata> CreateSharedLinkWithSettingsAsync(string path, SharedLinkSettings settings = null)

Parameters

Type	Name	Description
System.String	path	The path to be shared by the shared link.
SharedLinkSettings	settings	The requested settings for the newly created shared link.

Returns

Type	Description
System.Threading.Tasks.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 CreateSharedLinkWithSettingsError.

EndAddFileMember(IAsyncResult)

Waits for the pending asynchronous send to the add file member route to complete

Declaration

public List<FileMemberActionResult> EndAddFileMember(IAsyncResult asyncResult)

Parameters

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

Returns

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

Exceptions

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

EndAddFolderMember(IAsyncResult)

Waits for the pending asynchronous send to the add folder member route to complete

Declaration

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

EndCheckJobStatus(IAsyncResult)

Waits for the pending asynchronous send to the check job status route to complete

Declaration

public JobStatus EndCheckJobStatus(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
JobStatus	The response to the send request

Exceptions

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

EndCheckRemoveMemberJobStatus(IAsyncResult)

Waits for the pending asynchronous send to the check remove member job status route to complete

Declaration

public RemoveMemberJobStatus EndCheckRemoveMemberJobStatus(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
RemoveMemberJobStatus	The response to the send request

Exceptions

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

EndCheckShareJobStatus(IAsyncResult)

Waits for the pending asynchronous send to the check share job status route to complete

Declaration

public ShareFolderJobStatus EndCheckShareJobStatus(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ShareFolderJobStatus	The response to the send request

Exceptions

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

EndCreateSharedLink(IAsyncResult)

Waits for the pending asynchronous send to the create shared link route to complete

Declaration

[Obsolete("This function is deprecated, please use EndCreateSharedLinkWithSettings instead.")]
public PathLinkMetadata EndCreateSharedLink(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
PathLinkMetadata	The response to the send request

Exceptions

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

EndCreateSharedLinkWithSettings(IAsyncResult)

Waits for the pending asynchronous send to the create shared link with settings route to complete

Declaration

public SharedLinkMetadata EndCreateSharedLinkWithSettings(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.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 CreateSharedLinkWithSettingsError.

EndGetFileMetadata(IAsyncResult)

Waits for the pending asynchronous send to the get file metadata route to complete

Declaration

public SharedFileMetadata EndGetFileMetadata(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
SharedFileMetadata	The response to the send request

Exceptions

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

EndGetFileMetadataBatch(IAsyncResult)

Waits for the pending asynchronous send to the get file metadata batch route to complete

Declaration

public List<GetFileMetadataBatchResult> EndGetFileMetadataBatch(IAsyncResult asyncResult)

Parameters

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

Returns

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

Exceptions

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

EndGetFolderMetadata(IAsyncResult)

Waits for the pending asynchronous send to the get folder metadata route to complete

Declaration

public SharedFolderMetadata EndGetFolderMetadata(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
SharedFolderMetadata	The response to the send request

Exceptions

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

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

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
System.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 SharedLinkError.

EndGetSharedLinks(IAsyncResult)

Waits for the pending asynchronous send to the get shared links route to complete

Declaration

[Obsolete("This function is deprecated, please use EndListSharedLinks instead.")]
public GetSharedLinksResult EndGetSharedLinks(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
GetSharedLinksResult	The response to the send request

Exceptions

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

EndListFileMembers(IAsyncResult)

Waits for the pending asynchronous send to the list file members route to complete

Declaration

public SharedFileMembers EndListFileMembers(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
SharedFileMembers	The response to the send request

Exceptions

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

EndListFileMembersBatch(IAsyncResult)

Waits for the pending asynchronous send to the list file members batch route to complete

Declaration

public List<ListFileMembersBatchResult> EndListFileMembersBatch(IAsyncResult asyncResult)

Parameters

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

Returns

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

Exceptions

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

EndListFileMembersContinue(IAsyncResult)

Waits for the pending asynchronous send to the list file members continue route to complete

Declaration

public SharedFileMembers EndListFileMembersContinue(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
SharedFileMembers	The response to the send request

Exceptions

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

EndListFolderMembers(IAsyncResult)

Waits for the pending asynchronous send to the list folder members route to complete

Declaration

public SharedFolderMembers EndListFolderMembers(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
SharedFolderMembers	The response to the send request

Exceptions

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

EndListFolderMembersContinue(IAsyncResult)

Waits for the pending asynchronous send to the list folder members continue route to complete

Declaration

public SharedFolderMembers EndListFolderMembersContinue(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
SharedFolderMembers	The response to the send request

Exceptions

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

EndListFolders(IAsyncResult)

Waits for the pending asynchronous send to the list folders route to complete

Declaration

public ListFoldersResult EndListFolders(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListFoldersResult	The response to the send request

EndListFoldersContinue(IAsyncResult)

Waits for the pending asynchronous send to the list folders continue route to complete

Declaration

public ListFoldersResult EndListFoldersContinue(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListFoldersResult	The response to the send request

Exceptions

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

EndListMountableFolders(IAsyncResult)

Waits for the pending asynchronous send to the list mountable folders route to complete

Declaration

public ListFoldersResult EndListMountableFolders(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListFoldersResult	The response to the send request

EndListMountableFoldersContinue(IAsyncResult)

Waits for the pending asynchronous send to the list mountable folders continue route to complete

Declaration

public ListFoldersResult EndListMountableFoldersContinue(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListFoldersResult	The response to the send request

Exceptions

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

EndListReceivedFiles(IAsyncResult)

Waits for the pending asynchronous send to the list received files route to complete

Declaration

public ListFilesResult EndListReceivedFiles(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListFilesResult	The response to the send request

Exceptions

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

EndListReceivedFilesContinue(IAsyncResult)

Waits for the pending asynchronous send to the list received files continue route to complete

Declaration

public ListFilesResult EndListReceivedFilesContinue(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListFilesResult	The response to the send request

Exceptions

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

EndListSharedLinks(IAsyncResult)

Waits for the pending asynchronous send to the list shared links route to complete

Declaration

public ListSharedLinksResult EndListSharedLinks(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListSharedLinksResult	The response to the send request

Exceptions

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

EndModifySharedLinkSettings(IAsyncResult)

Waits for the pending asynchronous send to the modify shared link settings route to complete

Declaration

public SharedLinkMetadata EndModifySharedLinkSettings(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.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 ModifySharedLinkSettingsError.

EndMountFolder(IAsyncResult)

Waits for the pending asynchronous send to the mount folder route to complete

Declaration

public SharedFolderMetadata EndMountFolder(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
SharedFolderMetadata	The response to the send request

Exceptions

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

EndRelinquishFileMembership(IAsyncResult)

Waits for the pending asynchronous send to the relinquish file membership route to complete

Declaration

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

EndRelinquishFolderMembership(IAsyncResult)

Waits for the pending asynchronous send to the relinquish folder membership route to complete

Declaration

public LaunchEmptyResult EndRelinquishFolderMembership(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
LaunchEmptyResult	The response to the send request

Exceptions

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

EndRemoveFileMember(IAsyncResult)

Waits for the pending asynchronous send to the remove file member route to complete

Declaration

[Obsolete("This function is deprecated, please use EndRemoveFileMember2 instead.")]
public FileMemberActionIndividualResult EndRemoveFileMember(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
FileMemberActionIndividualResult	The response to the send request

Exceptions

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

EndRemoveFileMember2(IAsyncResult)

Waits for the pending asynchronous send to the remove file member 2 route to complete

Declaration

public FileMemberRemoveActionResult EndRemoveFileMember2(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
FileMemberRemoveActionResult	The response to the send request

Exceptions

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

EndRemoveFolderMember(IAsyncResult)

Waits for the pending asynchronous send to the remove folder member route to complete

Declaration

public LaunchResultBase EndRemoveFolderMember(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
LaunchResultBase	The response to the send request

Exceptions

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

EndRevokeSharedLink(IAsyncResult)

Waits for the pending asynchronous send to the revoke shared link route to complete

Declaration

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

EndSetAccessInheritance(IAsyncResult)

Waits for the pending asynchronous send to the set access inheritance route to complete

Declaration

public ShareFolderLaunch EndSetAccessInheritance(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ShareFolderLaunch	The response to the send request

Exceptions

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

EndShareFolder(IAsyncResult)

Waits for the pending asynchronous send to the share folder route to complete

Declaration

public ShareFolderLaunch EndShareFolder(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ShareFolderLaunch	The response to the send request

Exceptions

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

EndTransferFolder(IAsyncResult)

Waits for the pending asynchronous send to the transfer folder route to complete

Declaration

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

EndUnmountFolder(IAsyncResult)

Waits for the pending asynchronous send to the unmount folder route to complete

Declaration

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

EndUnshareFile(IAsyncResult)

Waits for the pending asynchronous send to the unshare file route to complete

Declaration

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

EndUnshareFolder(IAsyncResult)

Waits for the pending asynchronous send to the unshare folder route to complete

Declaration

public LaunchEmptyResult EndUnshareFolder(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
LaunchEmptyResult	The response to the send request

Exceptions

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

EndUpdateFileMember(IAsyncResult)

Waits for the pending asynchronous send to the update file member route to complete

Declaration

public MemberAccessLevelResult EndUpdateFileMember(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
MemberAccessLevelResult	The response to the send request

Exceptions

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

EndUpdateFolderMember(IAsyncResult)

Waits for the pending asynchronous send to the update folder member route to complete

Declaration

public MemberAccessLevelResult EndUpdateFolderMember(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
MemberAccessLevelResult	The response to the send request

Exceptions

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

EndUpdateFolderPolicy(IAsyncResult)

Waits for the pending asynchronous send to the update folder policy route to complete

Declaration

public SharedFolderMetadata EndUpdateFolderPolicy(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
SharedFolderMetadata	The response to the send request

Exceptions

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

GetFileMetadataAsync(GetFileMetadataArg)

Returns shared file metadata.

Declaration

public Task<SharedFileMetadata> GetFileMetadataAsync(GetFileMetadataArg getFileMetadataArg)

Parameters

Type	Name	Description
GetFileMetadataArg	getFileMetadataArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SharedFileMetadata>	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 GetFileMetadataError.

GetFileMetadataAsync(String, IEnumerable<FileAction>)

Returns shared file metadata.

Declaration

public Task<SharedFileMetadata> GetFileMetadataAsync(string file, IEnumerable<FileAction> actions = null)

Parameters

Type	Name	Description
System.String	file	The file to query.
System.Collections.Generic.IEnumerable<FileAction>	actions	A list of FileActions corresponding to FilePermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the file.

Returns

Type	Description
System.Threading.Tasks.Task<SharedFileMetadata>	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 GetFileMetadataError.

GetFileMetadataBatchAsync(GetFileMetadataBatchArg)

Returns shared file metadata.

Declaration

public Task<List<GetFileMetadataBatchResult>> GetFileMetadataBatchAsync(GetFileMetadataBatchArg getFileMetadataBatchArg)

Parameters

Type	Name	Description
GetFileMetadataBatchArg	getFileMetadataBatchArg	The request parameters

Returns

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

GetFileMetadataBatchAsync(IEnumerable<String>, IEnumerable<FileAction>)

Returns shared file metadata.

Declaration

public Task<List<GetFileMetadataBatchResult>> GetFileMetadataBatchAsync(IEnumerable<string> files, IEnumerable<FileAction> actions = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	files	The files to query.
System.Collections.Generic.IEnumerable<FileAction>	actions	A list of FileActions corresponding to FilePermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the file.

Returns

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

GetFolderMetadataAsync(GetMetadataArgs)

Returns shared folder metadata by its folder ID.

Declaration

public Task<SharedFolderMetadata> GetFolderMetadataAsync(GetMetadataArgs getMetadataArgs)

Parameters

Type	Name	Description
GetMetadataArgs	getMetadataArgs	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SharedFolderMetadata>	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 SharedFolderAccessError.

GetFolderMetadataAsync(String, IEnumerable<FolderAction>)

Returns shared folder metadata by its folder ID.

Declaration

public Task<SharedFolderMetadata> GetFolderMetadataAsync(string sharedFolderId, IEnumerable<FolderAction> actions = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
System.Collections.Generic.IEnumerable<FolderAction>	actions	A list of FolderActions corresponding to FolderPermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the folder.

Returns

Type	Description
System.Threading.Tasks.Task<SharedFolderMetadata>	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 SharedFolderAccessError.

GetSharedLinkFileAsync(GetSharedLinkMetadataArg)

Download the shared link's file from a user's Dropbox.

Declaration

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

Parameters

Type	Name	Description
GetSharedLinkMetadataArg	getSharedLinkMetadataArg	The request parameters

Returns

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

GetSharedLinkFileAsync(String, String, String)

Download the shared link's file from a user's Dropbox.

Declaration

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

Parameters

Type	Name	Description
System.String	url	URL of the shared link.
System.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.
System.String	linkPassword	If the shared link has a password, this parameter can be used.

Returns

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

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
System.Threading.Tasks.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 SharedLinkError.

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
System.String	url	URL of the shared link.
System.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.
System.String	linkPassword	If the shared link has a password, this parameter can be used.

Returns

Type	Description
System.Threading.Tasks.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 SharedLinkError.

GetSharedLinksAsync(GetSharedLinksArg)

Returns a list of LinkMetadata objects for this user, including collection links.

If no path is given, returns a list of all shared links for the current user, including collection links, up to a maximum of 1000 links.

If a non-empty path is given, returns a list of all shared links that allow access to the given path. Collection links are never returned in this case.

Declaration

[Obsolete("This function is deprecated, please use ListSharedLinksAsync instead.")]
public Task<GetSharedLinksResult> GetSharedLinksAsync(GetSharedLinksArg getSharedLinksArg)

Parameters

Type	Name	Description
GetSharedLinksArg	getSharedLinksArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<GetSharedLinksResult>	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 GetSharedLinksError.

GetSharedLinksAsync(String)

Returns a list of LinkMetadata objects for this user, including collection links.

If no path is given, returns a list of all shared links for the current user, including collection links, up to a maximum of 1000 links.

If a non-empty path is given, returns a list of all shared links that allow access to the given path. Collection links are never returned in this case.

Declaration

[Obsolete("This function is deprecated, please use ListSharedLinksAsync instead.")]
public Task<GetSharedLinksResult> GetSharedLinksAsync(string path = null)

Parameters

Type	Name	Description
System.String	path	See GetSharedLinksAsync(GetSharedLinksArg) description.

Returns

Type	Description
System.Threading.Tasks.Task<GetSharedLinksResult>	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 GetSharedLinksError.

ListFileMembersAsync(ListFileMembersArg)

Use to obtain the members who have been invited to a file, both inherited and uninherited members.

Declaration

public Task<SharedFileMembers> ListFileMembersAsync(ListFileMembersArg listFileMembersArg)

Parameters

Type	Name	Description
ListFileMembersArg	listFileMembersArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SharedFileMembers>	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 ListFileMembersError.

ListFileMembersAsync(String, IEnumerable<MemberAction>, Boolean, UInt32)

Use to obtain the members who have been invited to a file, both inherited and uninherited members.

Declaration

public Task<SharedFileMembers> ListFileMembersAsync(string file, IEnumerable<MemberAction> actions = null, bool includeInherited = true, uint limit = 100U)

Parameters

Type	Name	Description
System.String	file	The file for which you want to see members.
System.Collections.Generic.IEnumerable<MemberAction>	actions	The actions for which to return permissions on a member.
System.Boolean	includeInherited	Whether to include members who only have access from a parent shared folder.
System.UInt32	limit	Number of members to return max per query. Defaults to 100 if no limit is specified.

Returns

Type	Description
System.Threading.Tasks.Task<SharedFileMembers>	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 ListFileMembersError.

ListFileMembersBatchAsync(ListFileMembersBatchArg)

Get members of multiple files at once. The arguments to this route are more limited, and the limit on query result size per file is more strict. To customize the results more, use the individual file endpoint.

Inherited users and groups are not included in the result, and permissions are not returned for this endpoint.

Declaration

public Task<List<ListFileMembersBatchResult>> ListFileMembersBatchAsync(ListFileMembersBatchArg listFileMembersBatchArg)

Parameters

Type	Name	Description
ListFileMembersBatchArg	listFileMembersBatchArg	The request parameters

Returns

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

ListFileMembersBatchAsync(IEnumerable<String>, UInt32)

Get members of multiple files at once. The arguments to this route are more limited, and the limit on query result size per file is more strict. To customize the results more, use the individual file endpoint.

Inherited users and groups are not included in the result, and permissions are not returned for this endpoint.

Declaration

public Task<List<ListFileMembersBatchResult>> ListFileMembersBatchAsync(IEnumerable<string> files, uint limit = 10U)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	files	Files for which to return members.
System.UInt32	limit	Number of members to return max per query. Defaults to 10 if no limit is specified.

Returns

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

ListFileMembersContinueAsync(ListFileMembersContinueArg)

Once a cursor has been retrieved from ListFileMembersAsync(ListFileMembersArg) or ListFileMembersBatchAsync(ListFileMembersBatchArg), use this to paginate through all shared file members.

Declaration

public Task<SharedFileMembers> ListFileMembersContinueAsync(ListFileMembersContinueArg listFileMembersContinueArg)

Parameters

Type	Name	Description
ListFileMembersContinueArg	listFileMembersContinueArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SharedFileMembers>	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 ListFileMembersContinueError.

ListFileMembersContinueAsync(String)

Once a cursor has been retrieved from ListFileMembersAsync(ListFileMembersArg) or ListFileMembersBatchAsync(ListFileMembersBatchArg), use this to paginate through all shared file members.

Declaration

public Task<SharedFileMembers> ListFileMembersContinueAsync(string cursor)

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by your last call to ListFileMembersAsync(ListFileMembersArg), ListFileMembersContinueAsync(ListFileMembersContinueArg), or ListFileMembersBatchAsync(ListFileMembersBatchArg).

Returns

Type	Description
System.Threading.Tasks.Task<SharedFileMembers>	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 ListFileMembersContinueError.

ListFolderMembersAsync(ListFolderMembersArgs)

Returns shared folder membership by its folder ID.

Declaration

public Task<SharedFolderMembers> ListFolderMembersAsync(ListFolderMembersArgs listFolderMembersArgs)

Parameters

Type	Name	Description
ListFolderMembersArgs	listFolderMembersArgs	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SharedFolderMembers>	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 SharedFolderAccessError.

ListFolderMembersAsync(String, IEnumerable<MemberAction>, UInt32)

Returns shared folder membership by its folder ID.

Declaration

public Task<SharedFolderMembers> ListFolderMembersAsync(string sharedFolderId, IEnumerable<MemberAction> actions = null, uint limit = 1000U)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
System.Collections.Generic.IEnumerable<MemberAction>	actions	This is a list indicating whether each returned member will include a boolean value Allow that describes whether the current user can perform the MemberAction on the member.
System.UInt32	limit	The maximum number of results that include members, groups and invitees to return per request.

Returns

Type	Description
System.Threading.Tasks.Task<SharedFolderMembers>	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 SharedFolderAccessError.

ListFolderMembersContinueAsync(ListFolderMembersContinueArg)

Once a cursor has been retrieved from ListFolderMembersAsync(ListFolderMembersArgs), use this to paginate through all shared folder members.

Declaration

public Task<SharedFolderMembers> ListFolderMembersContinueAsync(ListFolderMembersContinueArg listFolderMembersContinueArg)

Parameters

Type	Name	Description
ListFolderMembersContinueArg	listFolderMembersContinueArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SharedFolderMembers>	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 ListFolderMembersContinueError.

ListFolderMembersContinueAsync(String)

Once a cursor has been retrieved from ListFolderMembersAsync(ListFolderMembersArgs), use this to paginate through all shared folder members.

Declaration

public Task<SharedFolderMembers> ListFolderMembersContinueAsync(string cursor)

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by your last call to ListFolderMembersAsync(ListFolderMembersArgs) or ListFolderMembersContinueAsync(ListFolderMembersContinueArg).

Returns

Type	Description
System.Threading.Tasks.Task<SharedFolderMembers>	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 ListFolderMembersContinueError.

ListFoldersAsync(ListFoldersArgs)

Return the list of all shared folders the current user has access to.

Declaration

public Task<ListFoldersResult> ListFoldersAsync(ListFoldersArgs listFoldersArgs)

Parameters

Type	Name	Description
ListFoldersArgs	listFoldersArgs	The request parameters

Returns

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

ListFoldersAsync(UInt32, IEnumerable<FolderAction>)

Return the list of all shared folders the current user has access to.

Declaration

public Task<ListFoldersResult> ListFoldersAsync(uint limit = 1000U, IEnumerable<FolderAction> actions = null)

Parameters

Type	Name	Description
System.UInt32	limit	The maximum number of results to return per request.
System.Collections.Generic.IEnumerable<FolderAction>	actions	A list of FolderActions corresponding to FolderPermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the folder.

Returns

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

ListFoldersContinueAsync(ListFoldersContinueArg)

Once a cursor has been retrieved from ListFoldersAsync(ListFoldersArgs), use this to paginate through all shared folders. The cursor must come from a previous call to ListFoldersAsync(ListFoldersArgs) or ListFoldersContinueAsync(ListFoldersContinueArg).

Declaration

public Task<ListFoldersResult> ListFoldersContinueAsync(ListFoldersContinueArg listFoldersContinueArg)

Parameters

Type	Name	Description
ListFoldersContinueArg	listFoldersContinueArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ListFoldersResult>	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 ListFoldersContinueError.

ListFoldersContinueAsync(String)

Once a cursor has been retrieved from ListFoldersAsync(ListFoldersArgs), use this to paginate through all shared folders. The cursor must come from a previous call to ListFoldersAsync(ListFoldersArgs) or ListFoldersContinueAsync(ListFoldersContinueArg).

Declaration

public Task<ListFoldersResult> ListFoldersContinueAsync(string cursor)

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by the previous API call specified in the endpoint description.

Returns

Type	Description
System.Threading.Tasks.Task<ListFoldersResult>	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 ListFoldersContinueError.

ListMountableFoldersAsync(ListFoldersArgs)

Return the list of all shared folders the current user can mount or unmount.

Declaration

public Task<ListFoldersResult> ListMountableFoldersAsync(ListFoldersArgs listFoldersArgs)

Parameters

Type	Name	Description
ListFoldersArgs	listFoldersArgs	The request parameters

Returns

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

ListMountableFoldersAsync(UInt32, IEnumerable<FolderAction>)

Return the list of all shared folders the current user can mount or unmount.

Declaration

public Task<ListFoldersResult> ListMountableFoldersAsync(uint limit = 1000U, IEnumerable<FolderAction> actions = null)

Parameters

Type	Name	Description
System.UInt32	limit	The maximum number of results to return per request.
System.Collections.Generic.IEnumerable<FolderAction>	actions	A list of FolderActions corresponding to FolderPermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the folder.

Returns

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

ListMountableFoldersContinueAsync(ListFoldersContinueArg)

Once a cursor has been retrieved from ListMountableFoldersAsync(ListFoldersArgs), use this to paginate through all mountable shared folders. The cursor must come from a previous call to ListMountableFoldersAsync(ListFoldersArgs) or ListMountableFoldersContinueAsync(ListFoldersContinueArg).

Declaration

public Task<ListFoldersResult> ListMountableFoldersContinueAsync(ListFoldersContinueArg listFoldersContinueArg)

Parameters

Type	Name	Description
ListFoldersContinueArg	listFoldersContinueArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ListFoldersResult>	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 ListFoldersContinueError.

ListMountableFoldersContinueAsync(String)

Once a cursor has been retrieved from ListMountableFoldersAsync(ListFoldersArgs), use this to paginate through all mountable shared folders. The cursor must come from a previous call to ListMountableFoldersAsync(ListFoldersArgs) or ListMountableFoldersContinueAsync(ListFoldersContinueArg).

Declaration

public Task<ListFoldersResult> ListMountableFoldersContinueAsync(string cursor)

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by the previous API call specified in the endpoint description.

Returns

Type	Description
System.Threading.Tasks.Task<ListFoldersResult>	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 ListFoldersContinueError.

ListReceivedFilesAsync(ListFilesArg)

Returns a list of all files shared with current user.

Does not include files the user has received via shared folders, and does not include unclaimed invitations.

Declaration

public Task<ListFilesResult> ListReceivedFilesAsync(ListFilesArg listFilesArg)

Parameters

Type	Name	Description
ListFilesArg	listFilesArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ListFilesResult>	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 SharingUserError.

ListReceivedFilesAsync(UInt32, IEnumerable<FileAction>)

Returns a list of all files shared with current user.

Does not include files the user has received via shared folders, and does not include unclaimed invitations.

Declaration

public Task<ListFilesResult> ListReceivedFilesAsync(uint limit = 100U, IEnumerable<FileAction> actions = null)

Parameters

Type	Name	Description
System.UInt32	limit	Number of files to return max per query. Defaults to 100 if no limit is specified.
System.Collections.Generic.IEnumerable<FileAction>	actions	A list of FileActions corresponding to FilePermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the file.

Returns

Type	Description
System.Threading.Tasks.Task<ListFilesResult>	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 SharingUserError.

ListReceivedFilesContinueAsync(ListFilesContinueArg)

Get more results with a cursor from ListReceivedFilesAsync(ListFilesArg).

Declaration

public Task<ListFilesResult> ListReceivedFilesContinueAsync(ListFilesContinueArg listFilesContinueArg)

Parameters

Type	Name	Description
ListFilesContinueArg	listFilesContinueArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ListFilesResult>	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 ListFilesContinueError.

ListReceivedFilesContinueAsync(String)

Get more results with a cursor from ListReceivedFilesAsync(ListFilesArg).

Declaration

public Task<ListFilesResult> ListReceivedFilesContinueAsync(string cursor)

Parameters

Type	Name	Description
System.String	cursor	Cursor in Cursor.

Returns

Type	Description
System.Threading.Tasks.Task<ListFilesResult>	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 ListFilesContinueError.

ListSharedLinksAsync(ListSharedLinksArg)

List shared links of this user.

If no path is given, returns a list of all shared links for the current user. For members of business teams using team space and member folders, returns all shared links in the team member's home folder unless the team space ID is specified in the request header. For more information, refer to the Namespace Guide.

If a non-empty path is given, returns a list of all shared links that allow access to the given path - direct links to the given path and links to parent folders of the given path. Links to parent folders can be suppressed by setting direct_only to true.

Declaration

public Task<ListSharedLinksResult> ListSharedLinksAsync(ListSharedLinksArg listSharedLinksArg)

Parameters

Type	Name	Description
ListSharedLinksArg	listSharedLinksArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ListSharedLinksResult>	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 ListSharedLinksError.

ListSharedLinksAsync(String, String, Nullable<Boolean>)

List shared links of this user.

If no path is given, returns a list of all shared links for the current user. For members of business teams using team space and member folders, returns all shared links in the team member's home folder unless the team space ID is specified in the request header. For more information, refer to the Namespace Guide.

If a non-empty path is given, returns a list of all shared links that allow access to the given path - direct links to the given path and links to parent folders of the given path. Links to parent folders can be suppressed by setting direct_only to true.

Declaration

public Task<ListSharedLinksResult> ListSharedLinksAsync(string path = null, string cursor = null, bool? directOnly = null)

Parameters

Type	Name	Description
System.String	path	See ListSharedLinksAsync(ListSharedLinksArg) description.
System.String	cursor	The cursor returned by your last call to ListSharedLinksAsync(ListSharedLinksArg).
System.Nullable<System.Boolean>	directOnly	See ListSharedLinksAsync(ListSharedLinksArg) description.

Returns

Type	Description
System.Threading.Tasks.Task<ListSharedLinksResult>	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 ListSharedLinksError.

ModifySharedLinkSettingsAsync(ModifySharedLinkSettingsArgs)

Modify the shared link's settings.

If the requested visibility conflict with the shared links policy of the team or the shared folder (in case the linked file is part of a shared folder) then the ResolvedVisibility of the returned SharedLinkMetadata will reflect the actual visibility of the shared link and the RequestedVisibility will reflect the requested visibility.

Declaration

public Task<SharedLinkMetadata> ModifySharedLinkSettingsAsync(ModifySharedLinkSettingsArgs modifySharedLinkSettingsArgs)

Parameters

Type	Name	Description
ModifySharedLinkSettingsArgs	modifySharedLinkSettingsArgs	The request parameters

Returns

Type	Description
System.Threading.Tasks.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 ModifySharedLinkSettingsError.

ModifySharedLinkSettingsAsync(String, SharedLinkSettings, Boolean)

Modify the shared link's settings.

If the requested visibility conflict with the shared links policy of the team or the shared folder (in case the linked file is part of a shared folder) then the ResolvedVisibility of the returned SharedLinkMetadata will reflect the actual visibility of the shared link and the RequestedVisibility will reflect the requested visibility.

Declaration

public Task<SharedLinkMetadata> ModifySharedLinkSettingsAsync(string url, SharedLinkSettings settings, bool removeExpiration = false)

Parameters

Type	Name	Description
System.String	url	URL of the shared link to change its settings.
SharedLinkSettings	settings	Set of settings for the shared link.
System.Boolean	removeExpiration	If set to true, removes the expiration of the shared link.

Returns

Type	Description
System.Threading.Tasks.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 ModifySharedLinkSettingsError.

MountFolderAsync(MountFolderArg)

The current user mounts the designated folder.

Mount a shared folder for a user after they have been added as a member. Once mounted, the shared folder will appear in their Dropbox.

Declaration

public Task<SharedFolderMetadata> MountFolderAsync(MountFolderArg mountFolderArg)

Parameters

Type	Name	Description
MountFolderArg	mountFolderArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SharedFolderMetadata>	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 MountFolderError.

MountFolderAsync(String)

The current user mounts the designated folder.

Mount a shared folder for a user after they have been added as a member. Once mounted, the shared folder will appear in their Dropbox.

Declaration

public Task<SharedFolderMetadata> MountFolderAsync(string sharedFolderId)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID of the shared folder to mount.

Returns

Type	Description
System.Threading.Tasks.Task<SharedFolderMetadata>	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 MountFolderError.

RelinquishFileMembershipAsync(RelinquishFileMembershipArg)

The current user relinquishes their membership in the designated file. Note that the current user may still have inherited access to this file through the parent folder.

Declaration

public Task RelinquishFileMembershipAsync(RelinquishFileMembershipArg relinquishFileMembershipArg)

Parameters

Type	Name	Description
RelinquishFileMembershipArg	relinquishFileMembershipArg	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 RelinquishFileMembershipError.

RelinquishFileMembershipAsync(String)

The current user relinquishes their membership in the designated file. Note that the current user may still have inherited access to this file through the parent folder.

Declaration

public Task RelinquishFileMembershipAsync(string file)

Parameters

Type	Name	Description
System.String	file	The path or id for the file.

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

RelinquishFolderMembershipAsync(RelinquishFolderMembershipArg)

The current user relinquishes their membership in the designated shared folder and will no longer have access to the folder. A folder owner cannot relinquish membership in their own folder.

This will run synchronously if leave_a_copy is false, and asynchronously if leave_a_copy is true.

Declaration

public Task<LaunchEmptyResult> RelinquishFolderMembershipAsync(RelinquishFolderMembershipArg relinquishFolderMembershipArg)

Parameters

Type	Name	Description
RelinquishFolderMembershipArg	relinquishFolderMembershipArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<LaunchEmptyResult>	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 RelinquishFolderMembershipError.

RelinquishFolderMembershipAsync(String, Boolean)

The current user relinquishes their membership in the designated shared folder and will no longer have access to the folder. A folder owner cannot relinquish membership in their own folder.

This will run synchronously if leave_a_copy is false, and asynchronously if leave_a_copy is true.

Declaration

public Task<LaunchEmptyResult> RelinquishFolderMembershipAsync(string sharedFolderId, bool leaveACopy = false)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
System.Boolean	leaveACopy	Keep a copy of the folder's contents upon relinquishing membership. This must be set to false when the folder is within a team folder or another shared folder.

Returns

Type	Description
System.Threading.Tasks.Task<LaunchEmptyResult>	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 RelinquishFolderMembershipError.

RemoveFileMember2Async(RemoveFileMemberArg)

Removes a specified member from the file.

Declaration

public Task<FileMemberRemoveActionResult> RemoveFileMember2Async(RemoveFileMemberArg removeFileMemberArg)

Parameters

Type	Name	Description
RemoveFileMemberArg	removeFileMemberArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<FileMemberRemoveActionResult>	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 RemoveFileMemberError.

RemoveFileMember2Async(String, MemberSelector)

Removes a specified member from the file.

Declaration

public Task<FileMemberRemoveActionResult> RemoveFileMember2Async(string file, MemberSelector member)

Parameters

Type	Name	Description
System.String	file	File from which to remove members.
MemberSelector	member	Member to remove from this file. Note that even if an email is specified, it may result in the removal of a user (not an invitee) if the user's main account corresponds to that email address.

Returns

Type	Description
System.Threading.Tasks.Task<FileMemberRemoveActionResult>	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 RemoveFileMemberError.

RemoveFileMemberAsync(RemoveFileMemberArg)

Identical to remove_file_member_2 but with less information returned.

Declaration

[Obsolete("This function is deprecated, please use RemoveFileMember2Async instead.")]
public Task<FileMemberActionIndividualResult> RemoveFileMemberAsync(RemoveFileMemberArg removeFileMemberArg)

Parameters

Type	Name	Description
RemoveFileMemberArg	removeFileMemberArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<FileMemberActionIndividualResult>	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 RemoveFileMemberError.

RemoveFileMemberAsync(String, MemberSelector)

Identical to remove_file_member_2 but with less information returned.

Declaration

[Obsolete("This function is deprecated, please use RemoveFileMember2Async instead.")]
public Task<FileMemberActionIndividualResult> RemoveFileMemberAsync(string file, MemberSelector member)

Parameters

Type	Name	Description
System.String	file	File from which to remove members.
MemberSelector	member	Member to remove from this file. Note that even if an email is specified, it may result in the removal of a user (not an invitee) if the user's main account corresponds to that email address.

Returns

Type	Description
System.Threading.Tasks.Task<FileMemberActionIndividualResult>	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 RemoveFileMemberError.

RemoveFolderMemberAsync(RemoveFolderMemberArg)

Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member.

Declaration

public Task<LaunchResultBase> RemoveFolderMemberAsync(RemoveFolderMemberArg removeFolderMemberArg)

Parameters

Type	Name	Description
RemoveFolderMemberArg	removeFolderMemberArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<LaunchResultBase>	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 RemoveFolderMemberError.

RemoveFolderMemberAsync(String, MemberSelector, Boolean)

Allows an owner or editor (if the ACL update policy allows) of a shared folder to remove another member.

Declaration

public Task<LaunchResultBase> RemoveFolderMemberAsync(string sharedFolderId, MemberSelector member, bool leaveACopy)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
MemberSelector	member	The member to remove from the folder.
System.Boolean	leaveACopy	If true, the removed user will keep their copy of the folder after it's unshared, assuming it was mounted. Otherwise, it will be removed from their Dropbox. This must be set to false when removing a group, or when the folder is within a team folder or another shared folder.

Returns

Type	Description
System.Threading.Tasks.Task<LaunchResultBase>	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 RemoveFolderMemberError.

RevokeSharedLinkAsync(RevokeSharedLinkArg)

Revoke a shared link.

Note that even after revoking a shared link to a file, the file may be accessible if there are shared links leading to any of the file parent folders. To list all shared links that enable access to a specific file, you can use the ListSharedLinksAsync(ListSharedLinksArg) with the file as the Path argument.

Declaration

public Task RevokeSharedLinkAsync(RevokeSharedLinkArg revokeSharedLinkArg)

Parameters

Type	Name	Description
RevokeSharedLinkArg	revokeSharedLinkArg	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 RevokeSharedLinkError.

RevokeSharedLinkAsync(String)

Revoke a shared link.

Note that even after revoking a shared link to a file, the file may be accessible if there are shared links leading to any of the file parent folders. To list all shared links that enable access to a specific file, you can use the ListSharedLinksAsync(ListSharedLinksArg) with the file as the Path argument.

Declaration

public Task RevokeSharedLinkAsync(string url)

Parameters

Type	Name	Description
System.String	url	URL of the shared link.

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

SetAccessInheritanceAsync(SetAccessInheritanceArg)

Change the inheritance policy of an existing Shared Folder. Only permitted for shared folders in a shared team root.

If a ShareFolderLaunch.AsyncJobId is returned, you'll need to call CheckShareJobStatusAsync(PollArg) until the action completes to get the metadata for the folder.

Declaration

public Task<ShareFolderLaunch> SetAccessInheritanceAsync(SetAccessInheritanceArg setAccessInheritanceArg)

Parameters

Type	Name	Description
SetAccessInheritanceArg	setAccessInheritanceArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ShareFolderLaunch>	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 SetAccessInheritanceError.

SetAccessInheritanceAsync(String, AccessInheritance)

Change the inheritance policy of an existing Shared Folder. Only permitted for shared folders in a shared team root.

If a ShareFolderLaunch.AsyncJobId is returned, you'll need to call CheckShareJobStatusAsync(PollArg) until the action completes to get the metadata for the folder.

Declaration

public Task<ShareFolderLaunch> SetAccessInheritanceAsync(string sharedFolderId, AccessInheritance accessInheritance = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
AccessInheritance	accessInheritance	The access inheritance settings for the folder.

Returns

Type	Description
System.Threading.Tasks.Task<ShareFolderLaunch>	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 SetAccessInheritanceError.

ShareFolderAsync(ShareFolderArg)

Share a folder with collaborators.

Most sharing will be completed synchronously. Large folders will be completed asynchronously. To make testing the async case repeatable, set ShareFolderArg.force_async.

If a ShareFolderLaunch.AsyncJobId is returned, you'll need to call CheckShareJobStatusAsync(PollArg) until the action completes to get the metadata for the folder.

Declaration

public Task<ShareFolderLaunch> ShareFolderAsync(ShareFolderArg shareFolderArg)

Parameters

Type	Name	Description
ShareFolderArg	shareFolderArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ShareFolderLaunch>	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 ShareFolderError.

ShareFolderAsync(String, AclUpdatePolicy, Boolean, MemberPolicy, SharedLinkPolicy, ViewerInfoPolicy, AccessInheritance, IEnumerable<FolderAction>, LinkSettings)

Share a folder with collaborators.

Most sharing will be completed synchronously. Large folders will be completed asynchronously. To make testing the async case repeatable, set ShareFolderArg.force_async.

If a ShareFolderLaunch.AsyncJobId is returned, you'll need to call CheckShareJobStatusAsync(PollArg) until the action completes to get the metadata for the folder.

Declaration

public Task<ShareFolderLaunch> ShareFolderAsync(string path, AclUpdatePolicy aclUpdatePolicy = null, bool forceAsync = false, MemberPolicy memberPolicy = null, SharedLinkPolicy sharedLinkPolicy = null, ViewerInfoPolicy viewerInfoPolicy = null, AccessInheritance accessInheritance = null, IEnumerable<FolderAction> actions = null, LinkSettings linkSettings = null)

Parameters

Type	Name	Description
System.String	path	The path to the folder to share. If it does not exist, then a new one is created.
AclUpdatePolicy	aclUpdatePolicy	Who can add and remove members of this shared folder.
System.Boolean	forceAsync	Whether to force the share to happen asynchronously.
MemberPolicy	memberPolicy	Who can be a member of this shared folder. Only applicable if the current user is on a team.
SharedLinkPolicy	sharedLinkPolicy	The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.Members.
ViewerInfoPolicy	viewerInfoPolicy	Who can enable/disable viewer info for this shared folder.
AccessInheritance	accessInheritance	The access inheritance settings for the folder.
System.Collections.Generic.IEnumerable<FolderAction>	actions	A list of FolderActions corresponding to FolderPermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the folder.
LinkSettings	linkSettings	Settings on the link for this folder.

Returns

Type	Description
System.Threading.Tasks.Task<ShareFolderLaunch>	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 ShareFolderError.

TransferFolderAsync(TransferFolderArg)

Transfer ownership of a shared folder to a member of the shared folder.

User must have AccessLevel.Owner access to the shared folder to perform a transfer.

Declaration

public Task TransferFolderAsync(TransferFolderArg transferFolderArg)

Parameters

Type	Name	Description
TransferFolderArg	transferFolderArg	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 TransferFolderError.

TransferFolderAsync(String, String)

Transfer ownership of a shared folder to a member of the shared folder.

User must have AccessLevel.Owner access to the shared folder to perform a transfer.

Declaration

public Task TransferFolderAsync(string sharedFolderId, string toDropboxId)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
System.String	toDropboxId	A account or team member ID to transfer ownership to.

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

UnmountFolderAsync(UnmountFolderArg)

The current user unmounts the designated folder. They can re-mount the folder at a later time using MountFolderAsync(MountFolderArg).

Declaration

public Task UnmountFolderAsync(UnmountFolderArg unmountFolderArg)

Parameters

Type	Name	Description
UnmountFolderArg	unmountFolderArg	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 UnmountFolderError.

UnmountFolderAsync(String)

The current user unmounts the designated folder. They can re-mount the folder at a later time using MountFolderAsync(MountFolderArg).

Declaration

public Task UnmountFolderAsync(string sharedFolderId)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.

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

UnshareFileAsync(UnshareFileArg)

Remove all members from this file. Does not remove inherited members.

Declaration

public Task UnshareFileAsync(UnshareFileArg unshareFileArg)

Parameters

Type	Name	Description
UnshareFileArg	unshareFileArg	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 UnshareFileError.

UnshareFileAsync(String)

Remove all members from this file. Does not remove inherited members.

Declaration

public Task UnshareFileAsync(string file)

Parameters

Type	Name	Description
System.String	file	The file to unshare.

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

UnshareFolderAsync(UnshareFolderArg)

Allows a shared folder owner to unshare the folder.

You'll need to call CheckJobStatusAsync(PollArg) to determine if the action has completed successfully.

Declaration

public Task<LaunchEmptyResult> UnshareFolderAsync(UnshareFolderArg unshareFolderArg)

Parameters

Type	Name	Description
UnshareFolderArg	unshareFolderArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<LaunchEmptyResult>	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 UnshareFolderError.

UnshareFolderAsync(String, Boolean)

Allows a shared folder owner to unshare the folder.

You'll need to call CheckJobStatusAsync(PollArg) to determine if the action has completed successfully.

Declaration

public Task<LaunchEmptyResult> UnshareFolderAsync(string sharedFolderId, bool leaveACopy = false)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
System.Boolean	leaveACopy	If true, members of this shared folder will get a copy of this folder after it's unshared. Otherwise, it will be removed from their Dropbox. The current user, who is an owner, will always retain their copy.

Returns

Type	Description
System.Threading.Tasks.Task<LaunchEmptyResult>	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 UnshareFolderError.

UpdateFileMemberAsync(UpdateFileMemberArgs)

Changes a member's access on a shared file.

Declaration

public Task<MemberAccessLevelResult> UpdateFileMemberAsync(UpdateFileMemberArgs updateFileMemberArgs)

Parameters

Type	Name	Description
UpdateFileMemberArgs	updateFileMemberArgs	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<MemberAccessLevelResult>	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 FileMemberActionError.

UpdateFileMemberAsync(String, MemberSelector, AccessLevel)

Changes a member's access on a shared file.

Declaration

public Task<MemberAccessLevelResult> UpdateFileMemberAsync(string file, MemberSelector member, AccessLevel accessLevel)

Parameters

Type	Name	Description
System.String	file	File for which we are changing a member's access.
MemberSelector	member	The member whose access we are changing.
AccessLevel	accessLevel	The new access level for the member.

Returns

Type	Description
System.Threading.Tasks.Task<MemberAccessLevelResult>	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 FileMemberActionError.

UpdateFolderMemberAsync(UpdateFolderMemberArg)

Allows an owner or editor of a shared folder to update another member's permissions.

Declaration

public Task<MemberAccessLevelResult> UpdateFolderMemberAsync(UpdateFolderMemberArg updateFolderMemberArg)

Parameters

Type	Name	Description
UpdateFolderMemberArg	updateFolderMemberArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<MemberAccessLevelResult>	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 UpdateFolderMemberError.

UpdateFolderMemberAsync(String, MemberSelector, AccessLevel)

Allows an owner or editor of a shared folder to update another member's permissions.

Declaration

public Task<MemberAccessLevelResult> UpdateFolderMemberAsync(string sharedFolderId, MemberSelector member, AccessLevel accessLevel)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
MemberSelector	member	The member of the shared folder to update. Only the MemberSelector.DropboxId may be set at this time.
AccessLevel	accessLevel	The new access level for member. AccessLevel.Owner is disallowed.

Returns

Type	Description
System.Threading.Tasks.Task<MemberAccessLevelResult>	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 UpdateFolderMemberError.

UpdateFolderPolicyAsync(UpdateFolderPolicyArg)

Update the sharing policies for a shared folder.

User must have AccessLevel.Owner access to the shared folder to update its policies.

Declaration

public Task<SharedFolderMetadata> UpdateFolderPolicyAsync(UpdateFolderPolicyArg updateFolderPolicyArg)

Parameters

Type	Name	Description
UpdateFolderPolicyArg	updateFolderPolicyArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SharedFolderMetadata>	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 UpdateFolderPolicyError.

UpdateFolderPolicyAsync(String, MemberPolicy, AclUpdatePolicy, ViewerInfoPolicy, SharedLinkPolicy, LinkSettings, IEnumerable<FolderAction>)

Update the sharing policies for a shared folder.

User must have AccessLevel.Owner access to the shared folder to update its policies.

Declaration

public Task<SharedFolderMetadata> UpdateFolderPolicyAsync(string sharedFolderId, MemberPolicy memberPolicy = null, AclUpdatePolicy aclUpdatePolicy = null, ViewerInfoPolicy viewerInfoPolicy = null, SharedLinkPolicy sharedLinkPolicy = null, LinkSettings linkSettings = null, IEnumerable<FolderAction> actions = null)

Parameters

Type	Name	Description
System.String	sharedFolderId	The ID for the shared folder.
MemberPolicy	memberPolicy	Who can be a member of this shared folder. Only applicable if the current user is on a team.
AclUpdatePolicy	aclUpdatePolicy	Who can add and remove members of this shared folder.
ViewerInfoPolicy	viewerInfoPolicy	Who can enable/disable viewer info for this shared folder.
SharedLinkPolicy	sharedLinkPolicy	The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.Members.
LinkSettings	linkSettings	Settings on the link for this folder.
System.Collections.Generic.IEnumerable<FolderAction>	actions	A list of FolderActions corresponding to FolderPermissions that should appear in the response's Permissions field describing the actions the authenticated user can perform on the folder.

Returns

Type	Description
System.Threading.Tasks.Task<SharedFolderMetadata>	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 UpdateFolderPolicyError.