Class PaperUserRoutes

The routes for the Dropbox.Api.Paper namespace

Inheritance

System.Object

PaperUserRoutes

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

Assembly: Dropbox.Api.dll

Syntax

public class PaperUserRoutes

Methods

BeginDocsArchive(RefPaperDoc, AsyncCallback, Object)

Begins an asynchronous send to the docs archive route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsArchive(RefPaperDoc refPaperDoc, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RefPaperDoc	refPaperDoc	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.

BeginDocsArchive(String, AsyncCallback, Object)

Begins an asynchronous send to the docs archive route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsArchive(string docId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
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.

BeginDocsCreate(ImportFormat, String, Stream, AsyncCallback, Object)

Begins an asynchronous send to the docs create route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsCreate(ImportFormat importFormat, string parentFolderId = null, Stream body = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
ImportFormat	importFormat	The format of provided data.
System.String	parentFolderId	The Paper folder ID where the Paper document should be created. The API user has to have write access to this folder or error is thrown.
System.IO.Stream	body	The document to upload
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.

BeginDocsCreate(PaperDocCreateArgs, Stream, AsyncCallback, Object)

Begins an asynchronous send to the docs create route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsCreate(PaperDocCreateArgs paperDocCreateArgs, Stream body, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PaperDocCreateArgs	paperDocCreateArgs	The request parameters.
System.IO.Stream	body	The content to upload.
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.

BeginDocsDownload(PaperDocExport, AsyncCallback, Object)

Begins an asynchronous send to the docs download route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsDownload(PaperDocExport paperDocExport, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PaperDocExport	paperDocExport	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.

BeginDocsDownload(String, ExportFormat, AsyncCallback, Object)

Begins an asynchronous send to the docs download route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsDownload(string docId, ExportFormat exportFormat, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
ExportFormat	exportFormat	The export format
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.

BeginDocsFolderUsersList(ListUsersOnFolderArgs, AsyncCallback, Object)

Begins an asynchronous send to the docs folder users list route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsFolderUsersList(ListUsersOnFolderArgs listUsersOnFolderArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListUsersOnFolderArgs	listUsersOnFolderArgs	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.

BeginDocsFolderUsersList(String, Int32, AsyncCallback, Object)

Begins an asynchronous send to the docs folder users list route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsFolderUsersList(string docId, int limit = 1000, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
System.Int32	limit	Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error.
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.

BeginDocsFolderUsersListContinue(ListUsersOnFolderContinueArgs, AsyncCallback, Object)

Begins an asynchronous send to the docs folder users list continue route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsFolderUsersListContinue(ListUsersOnFolderContinueArgs listUsersOnFolderContinueArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListUsersOnFolderContinueArgs	listUsersOnFolderContinueArgs	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.

BeginDocsFolderUsersListContinue(String, String, AsyncCallback, Object)

Begins an asynchronous send to the docs folder users list continue route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsFolderUsersListContinue(string docId, string cursor, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
System.String	cursor	The cursor obtained from DocsFolderUsersListAsync(ListUsersOnFolderArgs) or DocsFolderUsersListContinueAsync(ListUsersOnFolderContinueArgs). Allows for pagination.
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.

BeginDocsGetFolderInfo(RefPaperDoc, AsyncCallback, Object)

Begins an asynchronous send to the docs get folder info route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsGetFolderInfo(RefPaperDoc refPaperDoc, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RefPaperDoc	refPaperDoc	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.

BeginDocsGetFolderInfo(String, AsyncCallback, Object)

Begins an asynchronous send to the docs get folder info route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsGetFolderInfo(string docId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
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.

BeginDocsList(ListPaperDocsArgs, AsyncCallback, Object)

Begins an asynchronous send to the docs list route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsList(ListPaperDocsArgs listPaperDocsArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListPaperDocsArgs	listPaperDocsArgs	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.

BeginDocsList(ListPaperDocsFilterBy, ListPaperDocsSortBy, ListPaperDocsSortOrder, Int32, AsyncCallback, Object)

Begins an asynchronous send to the docs list route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsList(ListPaperDocsFilterBy filterBy = null, ListPaperDocsSortBy sortBy = null, ListPaperDocsSortOrder sortOrder = null, int limit = 1000, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
ListPaperDocsFilterBy	filterBy	Allows user to specify how the Paper docs should be filtered.
ListPaperDocsSortBy	sortBy	Allows user to specify how the Paper docs should be sorted.
ListPaperDocsSortOrder	sortOrder	Allows user to specify the sort order of the result.
System.Int32	limit	Size limit per batch. The maximum number of docs that can be retrieved per batch is 1000. Higher value results in invalid arguments error.
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.

BeginDocsListContinue(ListPaperDocsContinueArgs, AsyncCallback, Object)

Begins an asynchronous send to the docs list continue route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsListContinue(ListPaperDocsContinueArgs listPaperDocsContinueArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListPaperDocsContinueArgs	listPaperDocsContinueArgs	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.

BeginDocsListContinue(String, AsyncCallback, Object)

Begins an asynchronous send to the docs list continue route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsListContinue(string cursor, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	cursor	The cursor obtained from DocsListAsync(ListPaperDocsArgs) or DocsListContinueAsync(ListPaperDocsContinueArgs). Allows for pagination.
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.

BeginDocsPermanentlyDelete(RefPaperDoc, AsyncCallback, Object)

Begins an asynchronous send to the docs permanently delete route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsPermanentlyDelete(RefPaperDoc refPaperDoc, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RefPaperDoc	refPaperDoc	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.

BeginDocsPermanentlyDelete(String, AsyncCallback, Object)

Begins an asynchronous send to the docs permanently delete route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsPermanentlyDelete(string docId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
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.

BeginDocsSharingPolicyGet(RefPaperDoc, AsyncCallback, Object)

Begins an asynchronous send to the docs sharing policy get route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsSharingPolicyGet(RefPaperDoc refPaperDoc, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RefPaperDoc	refPaperDoc	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.

BeginDocsSharingPolicyGet(String, AsyncCallback, Object)

Begins an asynchronous send to the docs sharing policy get route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsSharingPolicyGet(string docId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
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.

BeginDocsSharingPolicySet(PaperDocSharingPolicy, AsyncCallback, Object)

Begins an asynchronous send to the docs sharing policy set route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsSharingPolicySet(PaperDocSharingPolicy paperDocSharingPolicy, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PaperDocSharingPolicy	paperDocSharingPolicy	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.

BeginDocsSharingPolicySet(String, SharingPolicy, AsyncCallback, Object)

Begins an asynchronous send to the docs sharing policy set route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsSharingPolicySet(string docId, SharingPolicy sharingPolicy, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
SharingPolicy	sharingPolicy	The default sharing policy to be set for the Paper doc.
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.

BeginDocsUpdate(PaperDocUpdateArgs, Stream, AsyncCallback, Object)

Begins an asynchronous send to the docs update route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsUpdate(PaperDocUpdateArgs paperDocUpdateArgs, Stream body, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PaperDocUpdateArgs	paperDocUpdateArgs	The request parameters.
System.IO.Stream	body	The content to upload.
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.

BeginDocsUpdate(String, PaperDocUpdatePolicy, Int64, ImportFormat, Stream, AsyncCallback, Object)

Begins an asynchronous send to the docs update route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsUpdate(string docId, PaperDocUpdatePolicy docUpdatePolicy, long revision, ImportFormat importFormat, Stream body, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
PaperDocUpdatePolicy	docUpdatePolicy	The policy used for the current update call.
System.Int64	revision	The latest doc revision. This value must match the head revision or an error code will be returned. This is to prevent colliding writes.
ImportFormat	importFormat	The format of provided data.
System.IO.Stream	body	The document to upload
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.

BeginDocsUsersAdd(AddPaperDocUser, AsyncCallback, Object)

Begins an asynchronous send to the docs users add route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsUsersAdd(AddPaperDocUser addPaperDocUser, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
AddPaperDocUser	addPaperDocUser	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.

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

Begins an asynchronous send to the docs users add route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsUsersAdd(string docId, IEnumerable<AddMember> members, string customMessage = null, bool quiet = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
System.Collections.Generic.IEnumerable<AddMember>	members	User which should be added to the Paper doc. Specify only email address or Dropbox account ID.
System.String	customMessage	A personal message that will be emailed to each successfully added member.
System.Boolean	quiet	Clients should set this to true if no email message shall be sent to added users.
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.

BeginDocsUsersList(ListUsersOnPaperDocArgs, AsyncCallback, Object)

Begins an asynchronous send to the docs users list route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsUsersList(ListUsersOnPaperDocArgs listUsersOnPaperDocArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListUsersOnPaperDocArgs	listUsersOnPaperDocArgs	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.

BeginDocsUsersList(String, Int32, UserOnPaperDocFilter, AsyncCallback, Object)

Begins an asynchronous send to the docs users list route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsUsersList(string docId, int limit = 1000, UserOnPaperDocFilter filterBy = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
System.Int32	limit	Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error.
UserOnPaperDocFilter	filterBy	Specify this attribute if you want to obtain users that have already accessed the Paper doc.
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.

BeginDocsUsersListContinue(ListUsersOnPaperDocContinueArgs, AsyncCallback, Object)

Begins an asynchronous send to the docs users list continue route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsUsersListContinue(ListUsersOnPaperDocContinueArgs listUsersOnPaperDocContinueArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListUsersOnPaperDocContinueArgs	listUsersOnPaperDocContinueArgs	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.

BeginDocsUsersListContinue(String, String, AsyncCallback, Object)

Begins an asynchronous send to the docs users list continue route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsUsersListContinue(string docId, string cursor, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
System.String	cursor	The cursor obtained from DocsUsersListAsync(ListUsersOnPaperDocArgs) or DocsUsersListContinueAsync(ListUsersOnPaperDocContinueArgs). Allows for pagination.
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.

BeginDocsUsersRemove(RemovePaperDocUser, AsyncCallback, Object)

Begins an asynchronous send to the docs users remove route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsUsersRemove(RemovePaperDocUser removePaperDocUser, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RemovePaperDocUser	removePaperDocUser	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.

BeginDocsUsersRemove(String, MemberSelector, AsyncCallback, Object)

Begins an asynchronous send to the docs users remove route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginDocsUsersRemove(string docId, MemberSelector member, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
MemberSelector	member	User which should be removed from the Paper doc. Specify only email address or Dropbox account ID.
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.

BeginFoldersCreate(PaperFolderCreateArg, AsyncCallback, Object)

Begins an asynchronous send to the folders create route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginFoldersCreate(PaperFolderCreateArg paperFolderCreateArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PaperFolderCreateArg	paperFolderCreateArg	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.

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

Begins an asynchronous send to the folders create route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginFoldersCreate(string name, string parentFolderId = null, bool? isTeamFolder = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	name	The name of the new Paper folder.
System.String	parentFolderId	The encrypted Paper folder Id where the new Paper folder should be created. The API user has to have write access to this folder or error is thrown. If not supplied, the new folder will be created at top level.
System.Nullable<System.Boolean>	isTeamFolder	Whether the folder to be created should be a team folder. This value will be ignored if parent_folder_id is supplied, as the new folder will inherit the type (private or team folder) from its parent. We will by default create a top-level private folder if both parent_folder_id and is_team_folder are not supplied.
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.

DocsArchiveAsync(RefPaperDoc)

Marks the given Paper doc as archived.

This action can be performed or undone by anyone with edit permissions to the doc.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

This endpoint will be retired in September 2020. Refer to the Paper Migration Guide for more information.

Declaration

[Obsolete("This function is deprecated")]
public Task DocsArchiveAsync(RefPaperDoc refPaperDoc)

Parameters

Type	Name	Description
RefPaperDoc	refPaperDoc	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 DocLookupError.

DocsArchiveAsync(String)

Marks the given Paper doc as archived.

This action can be performed or undone by anyone with edit permissions to the doc.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

This endpoint will be retired in September 2020. Refer to the Paper Migration Guide for more information.

Declaration

[Obsolete("This function is deprecated")]
public Task DocsArchiveAsync(string docId)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.

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

DocsCreateAsync(ImportFormat, String, Stream)

Creates a new Paper doc with the provided content.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

This endpoint will be retired in September 2020. Refer to the Paper Migration Guide for more information.

Declaration

[Obsolete("This function is deprecated")]
public Task<PaperDocCreateUpdateResult> DocsCreateAsync(ImportFormat importFormat, string parentFolderId = null, Stream body = null)

Parameters

Type	Name	Description
ImportFormat	importFormat	The format of provided data.
System.String	parentFolderId	The Paper folder ID where the Paper document should be created. The API user has to have write access to this folder or error is thrown.
System.IO.Stream	body	The document to upload

Returns

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

DocsCreateAsync(PaperDocCreateArgs, Stream)

Creates a new Paper doc with the provided content.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

This endpoint will be retired in September 2020. Refer to the Paper Migration Guide for more information.

Declaration

[Obsolete("This function is deprecated")]
public Task<PaperDocCreateUpdateResult> DocsCreateAsync(PaperDocCreateArgs paperDocCreateArgs, Stream body)

Parameters

Type	Name	Description
PaperDocCreateArgs	paperDocCreateArgs	The request parameters
System.IO.Stream	body	The content to upload.

Returns

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

DocsDownloadAsync(PaperDocExport)

Exports and downloads Paper doc either as HTML or markdown.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<IDownloadResponse<PaperDocExportResult>> DocsDownloadAsync(PaperDocExport paperDocExport)

Parameters

Type	Name	Description
PaperDocExport	paperDocExport	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<PaperDocExportResult>>	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 DocLookupError.

DocsDownloadAsync(String, ExportFormat)

Exports and downloads Paper doc either as HTML or markdown.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<IDownloadResponse<PaperDocExportResult>> DocsDownloadAsync(string docId, ExportFormat exportFormat)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
ExportFormat	exportFormat	The export format

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<PaperDocExportResult>>	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 DocLookupError.

DocsFolderUsersListAsync(ListUsersOnFolderArgs)

Lists the users who are explicitly invited to the Paper folder in which the Paper doc is contained. For private folders all users (including owner) shared on the folder are listed and for team folders all non-team users shared on the folder are returned.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<ListUsersOnFolderResponse> DocsFolderUsersListAsync(ListUsersOnFolderArgs listUsersOnFolderArgs)

Parameters

Type	Name	Description
ListUsersOnFolderArgs	listUsersOnFolderArgs	The request parameters

Returns

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

DocsFolderUsersListAsync(String, Int32)

Lists the users who are explicitly invited to the Paper folder in which the Paper doc is contained. For private folders all users (including owner) shared on the folder are listed and for team folders all non-team users shared on the folder are returned.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<ListUsersOnFolderResponse> DocsFolderUsersListAsync(string docId, int limit = 1000)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
System.Int32	limit	Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error.

Returns

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

DocsFolderUsersListContinueAsync(ListUsersOnFolderContinueArgs)

Once a cursor has been retrieved from DocsFolderUsersListAsync(ListUsersOnFolderArgs), use this to paginate through all users on the Paper folder.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<ListUsersOnFolderResponse> DocsFolderUsersListContinueAsync(ListUsersOnFolderContinueArgs listUsersOnFolderContinueArgs)

Parameters

Type	Name	Description
ListUsersOnFolderContinueArgs	listUsersOnFolderContinueArgs	The request parameters

Returns

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

DocsFolderUsersListContinueAsync(String, String)

Once a cursor has been retrieved from DocsFolderUsersListAsync(ListUsersOnFolderArgs), use this to paginate through all users on the Paper folder.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<ListUsersOnFolderResponse> DocsFolderUsersListContinueAsync(string docId, string cursor)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
System.String	cursor	The cursor obtained from DocsFolderUsersListAsync(ListUsersOnFolderArgs) or DocsFolderUsersListContinueAsync(ListUsersOnFolderContinueArgs). Allows for pagination.

Returns

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

DocsGetFolderInfoAsync(RefPaperDoc)

Retrieves folder information for the given Paper doc. This includes:

- folder sharing policy; permissions for subfolders are set by the top-level folder.

- full 'filepath', i.e. the list of folders (both folderId and folderName) from the root folder to the folder directly containing the Paper doc.

If the Paper doc is not in any folder (aka unfiled) the response will be empty.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<FoldersContainingPaperDoc> DocsGetFolderInfoAsync(RefPaperDoc refPaperDoc)

Parameters

Type	Name	Description
RefPaperDoc	refPaperDoc	The request parameters

Returns

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

DocsGetFolderInfoAsync(String)

Retrieves folder information for the given Paper doc. This includes:

- folder sharing policy; permissions for subfolders are set by the top-level folder.

- full 'filepath', i.e. the list of folders (both folderId and folderName) from the root folder to the folder directly containing the Paper doc.

If the Paper doc is not in any folder (aka unfiled) the response will be empty.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<FoldersContainingPaperDoc> DocsGetFolderInfoAsync(string docId)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.

Returns

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

DocsListAsync(ListPaperDocsArgs)

Return the list of all Paper docs according to the argument specifications. To iterate over through the full pagination, pass the cursor to DocsListContinueAsync(ListPaperDocsContinueArgs).

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<ListPaperDocsResponse> DocsListAsync(ListPaperDocsArgs listPaperDocsArgs)

Parameters

Type	Name	Description
ListPaperDocsArgs	listPaperDocsArgs	The request parameters

Returns

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

DocsListAsync(ListPaperDocsFilterBy, ListPaperDocsSortBy, ListPaperDocsSortOrder, Int32)

Return the list of all Paper docs according to the argument specifications. To iterate over through the full pagination, pass the cursor to DocsListContinueAsync(ListPaperDocsContinueArgs).

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<ListPaperDocsResponse> DocsListAsync(ListPaperDocsFilterBy filterBy = null, ListPaperDocsSortBy sortBy = null, ListPaperDocsSortOrder sortOrder = null, int limit = 1000)

Parameters

Type	Name	Description
ListPaperDocsFilterBy	filterBy	Allows user to specify how the Paper docs should be filtered.
ListPaperDocsSortBy	sortBy	Allows user to specify how the Paper docs should be sorted.
ListPaperDocsSortOrder	sortOrder	Allows user to specify the sort order of the result.
System.Int32	limit	Size limit per batch. The maximum number of docs that can be retrieved per batch is 1000. Higher value results in invalid arguments error.

Returns

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

DocsListContinueAsync(ListPaperDocsContinueArgs)

Once a cursor has been retrieved from DocsListAsync(ListPaperDocsArgs), use this to paginate through all Paper doc.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<ListPaperDocsResponse> DocsListContinueAsync(ListPaperDocsContinueArgs listPaperDocsContinueArgs)

Parameters

Type	Name	Description
ListPaperDocsContinueArgs	listPaperDocsContinueArgs	The request parameters

Returns

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

DocsListContinueAsync(String)

Once a cursor has been retrieved from DocsListAsync(ListPaperDocsArgs), use this to paginate through all Paper doc.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<ListPaperDocsResponse> DocsListContinueAsync(string cursor)

Parameters

Type	Name	Description
System.String	cursor	The cursor obtained from DocsListAsync(ListPaperDocsArgs) or DocsListContinueAsync(ListPaperDocsContinueArgs). Allows for pagination.

Returns

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

DocsPermanentlyDeleteAsync(RefPaperDoc)

Permanently deletes the given Paper doc. This operation is final as the doc cannot be recovered.

This action can be performed only by the doc owner.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task DocsPermanentlyDeleteAsync(RefPaperDoc refPaperDoc)

Parameters

Type	Name	Description
RefPaperDoc	refPaperDoc	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 DocLookupError.

DocsPermanentlyDeleteAsync(String)

Permanently deletes the given Paper doc. This operation is final as the doc cannot be recovered.

This action can be performed only by the doc owner.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task DocsPermanentlyDeleteAsync(string docId)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.

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

DocsSharingPolicyGetAsync(RefPaperDoc)

Gets the default sharing policy for the given Paper doc.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<SharingPolicy> DocsSharingPolicyGetAsync(RefPaperDoc refPaperDoc)

Parameters

Type	Name	Description
RefPaperDoc	refPaperDoc	The request parameters

Returns

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

DocsSharingPolicyGetAsync(String)

Gets the default sharing policy for the given Paper doc.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<SharingPolicy> DocsSharingPolicyGetAsync(string docId)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.

Returns

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

DocsSharingPolicySetAsync(PaperDocSharingPolicy)

Sets the default sharing policy for the given Paper doc. The default 'team_sharing_policy' can be changed only by teams, omit this field for personal accounts.

The 'public_sharing_policy' policy can't be set to the value 'disabled' because this setting can be changed only via the team admin console.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task DocsSharingPolicySetAsync(PaperDocSharingPolicy paperDocSharingPolicy)

Parameters

Type	Name	Description
PaperDocSharingPolicy	paperDocSharingPolicy	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 DocLookupError.

DocsSharingPolicySetAsync(String, SharingPolicy)

Sets the default sharing policy for the given Paper doc. The default 'team_sharing_policy' can be changed only by teams, omit this field for personal accounts.

The 'public_sharing_policy' policy can't be set to the value 'disabled' because this setting can be changed only via the team admin console.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task DocsSharingPolicySetAsync(string docId, SharingPolicy sharingPolicy)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
SharingPolicy	sharingPolicy	The default sharing policy to be set for the Paper doc.

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

DocsUpdateAsync(PaperDocUpdateArgs, Stream)

Updates an existing Paper doc with the provided content.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

This endpoint will be retired in September 2020. Refer to the Paper Migration Guide for more information.

Declaration

[Obsolete("This function is deprecated")]
public Task<PaperDocCreateUpdateResult> DocsUpdateAsync(PaperDocUpdateArgs paperDocUpdateArgs, Stream body)

Parameters

Type	Name	Description
PaperDocUpdateArgs	paperDocUpdateArgs	The request parameters
System.IO.Stream	body	The content to upload.

Returns

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

DocsUpdateAsync(String, PaperDocUpdatePolicy, Int64, ImportFormat, Stream)

Updates an existing Paper doc with the provided content.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

This endpoint will be retired in September 2020. Refer to the Paper Migration Guide for more information.

Declaration

[Obsolete("This function is deprecated")]
public Task<PaperDocCreateUpdateResult> DocsUpdateAsync(string docId, PaperDocUpdatePolicy docUpdatePolicy, long revision, ImportFormat importFormat, Stream body)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
PaperDocUpdatePolicy	docUpdatePolicy	The policy used for the current update call.
System.Int64	revision	The latest doc revision. This value must match the head revision or an error code will be returned. This is to prevent colliding writes.
ImportFormat	importFormat	The format of provided data.
System.IO.Stream	body	The document to upload

Returns

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

DocsUsersAddAsync(AddPaperDocUser)

Allows an owner or editor to add users to a Paper doc or change their permissions using their email address or Dropbox account ID.

The doc owner's permissions cannot be changed.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<List<AddPaperDocUserMemberResult>> DocsUsersAddAsync(AddPaperDocUser addPaperDocUser)

Parameters

Type	Name	Description
AddPaperDocUser	addPaperDocUser	The request parameters

Returns

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

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

Allows an owner or editor to add users to a Paper doc or change their permissions using their email address or Dropbox account ID.

The doc owner's permissions cannot be changed.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<List<AddPaperDocUserMemberResult>> DocsUsersAddAsync(string docId, IEnumerable<AddMember> members, string customMessage = null, bool quiet = false)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
System.Collections.Generic.IEnumerable<AddMember>	members	User which should be added to the Paper doc. Specify only email address or Dropbox account ID.
System.String	customMessage	A personal message that will be emailed to each successfully added member.
System.Boolean	quiet	Clients should set this to true if no email message shall be sent to added users.

Returns

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

DocsUsersListAsync(ListUsersOnPaperDocArgs)

Lists all users who visited the Paper doc or users with explicit access. This call excludes users who have been removed. The list is sorted by the date of the visit or the share date.

The list will include both users, the explicitly shared ones as well as those who came in using the Paper url link.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<ListUsersOnPaperDocResponse> DocsUsersListAsync(ListUsersOnPaperDocArgs listUsersOnPaperDocArgs)

Parameters

Type	Name	Description
ListUsersOnPaperDocArgs	listUsersOnPaperDocArgs	The request parameters

Returns

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

DocsUsersListAsync(String, Int32, UserOnPaperDocFilter)

Lists all users who visited the Paper doc or users with explicit access. This call excludes users who have been removed. The list is sorted by the date of the visit or the share date.

The list will include both users, the explicitly shared ones as well as those who came in using the Paper url link.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<ListUsersOnPaperDocResponse> DocsUsersListAsync(string docId, int limit = 1000, UserOnPaperDocFilter filterBy = null)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
System.Int32	limit	Size limit per batch. The maximum number of users that can be retrieved per batch is 1000. Higher value results in invalid arguments error.
UserOnPaperDocFilter	filterBy	Specify this attribute if you want to obtain users that have already accessed the Paper doc.

Returns

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

DocsUsersListContinueAsync(ListUsersOnPaperDocContinueArgs)

Once a cursor has been retrieved from DocsUsersListAsync(ListUsersOnPaperDocArgs), use this to paginate through all users on the Paper doc.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<ListUsersOnPaperDocResponse> DocsUsersListContinueAsync(ListUsersOnPaperDocContinueArgs listUsersOnPaperDocContinueArgs)

Parameters

Type	Name	Description
ListUsersOnPaperDocContinueArgs	listUsersOnPaperDocContinueArgs	The request parameters

Returns

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

DocsUsersListContinueAsync(String, String)

Once a cursor has been retrieved from DocsUsersListAsync(ListUsersOnPaperDocArgs), use this to paginate through all users on the Paper doc.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<ListUsersOnPaperDocResponse> DocsUsersListContinueAsync(string docId, string cursor)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
System.String	cursor	The cursor obtained from DocsUsersListAsync(ListUsersOnPaperDocArgs) or DocsUsersListContinueAsync(ListUsersOnPaperDocContinueArgs). Allows for pagination.

Returns

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

DocsUsersRemoveAsync(RemovePaperDocUser)

Allows an owner or editor to remove users from a Paper doc using their email address or Dropbox account ID.

The doc owner cannot be removed.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task DocsUsersRemoveAsync(RemovePaperDocUser removePaperDocUser)

Parameters

Type	Name	Description
RemovePaperDocUser	removePaperDocUser	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 DocLookupError.

DocsUsersRemoveAsync(String, MemberSelector)

Allows an owner or editor to remove users from a Paper doc using their email address or Dropbox account ID.

The doc owner cannot be removed.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task DocsUsersRemoveAsync(string docId, MemberSelector member)

Parameters

Type	Name	Description
System.String	docId	The Paper doc ID.
MemberSelector	member	User which should be removed from the Paper doc. Specify only email address or Dropbox account ID.

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

EndDocsArchive(IAsyncResult)

Waits for the pending asynchronous send to the docs archive route to complete

Declaration

[Obsolete("This function is deprecated")]
public void EndDocsArchive(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 DocLookupError.

EndDocsCreate(IAsyncResult)

Waits for the pending asynchronous send to the docs create route to complete

Declaration

[Obsolete("This function is deprecated")]
public PaperDocCreateUpdateResult EndDocsCreate(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
PaperDocCreateUpdateResult	The response to the send request

Exceptions

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

EndDocsDownload(IAsyncResult)

Waits for the pending asynchronous send to the docs download route to complete

Declaration

[Obsolete("This function is deprecated")]
public IDownloadResponse<PaperDocExportResult> EndDocsDownload(IAsyncResult asyncResult)

Parameters

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

Returns

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

Exceptions

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

EndDocsFolderUsersList(IAsyncResult)

Waits for the pending asynchronous send to the docs folder users list route to complete

Declaration

[Obsolete("This function is deprecated")]
public ListUsersOnFolderResponse EndDocsFolderUsersList(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListUsersOnFolderResponse	The response to the send request

Exceptions

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

EndDocsFolderUsersListContinue(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated")]
public ListUsersOnFolderResponse EndDocsFolderUsersListContinue(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListUsersOnFolderResponse	The response to the send request

Exceptions

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

EndDocsGetFolderInfo(IAsyncResult)

Waits for the pending asynchronous send to the docs get folder info route to complete

Declaration

[Obsolete("This function is deprecated")]
public FoldersContainingPaperDoc EndDocsGetFolderInfo(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
FoldersContainingPaperDoc	The response to the send request

Exceptions

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

EndDocsList(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated")]
public ListPaperDocsResponse EndDocsList(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListPaperDocsResponse	The response to the send request

EndDocsListContinue(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated")]
public ListPaperDocsResponse EndDocsListContinue(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListPaperDocsResponse	The response to the send request

Exceptions

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

EndDocsPermanentlyDelete(IAsyncResult)

Waits for the pending asynchronous send to the docs permanently delete route to complete

Declaration

[Obsolete("This function is deprecated")]
public void EndDocsPermanentlyDelete(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 DocLookupError.

EndDocsSharingPolicyGet(IAsyncResult)

Waits for the pending asynchronous send to the docs sharing policy get route to complete

Declaration

[Obsolete("This function is deprecated")]
public SharingPolicy EndDocsSharingPolicyGet(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
SharingPolicy	The response to the send request

Exceptions

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

EndDocsSharingPolicySet(IAsyncResult)

Waits for the pending asynchronous send to the docs sharing policy set route to complete

Declaration

[Obsolete("This function is deprecated")]
public void EndDocsSharingPolicySet(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 DocLookupError.

EndDocsUpdate(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated")]
public PaperDocCreateUpdateResult EndDocsUpdate(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
PaperDocCreateUpdateResult	The response to the send request

Exceptions

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

EndDocsUsersAdd(IAsyncResult)

Waits for the pending asynchronous send to the docs users add route to complete

Declaration

[Obsolete("This function is deprecated")]
public List<AddPaperDocUserMemberResult> EndDocsUsersAdd(IAsyncResult asyncResult)

Parameters

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

Returns

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

Exceptions

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

EndDocsUsersList(IAsyncResult)

Waits for the pending asynchronous send to the docs users list route to complete

Declaration

[Obsolete("This function is deprecated")]
public ListUsersOnPaperDocResponse EndDocsUsersList(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListUsersOnPaperDocResponse	The response to the send request

Exceptions

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

EndDocsUsersListContinue(IAsyncResult)

Waits for the pending asynchronous send to the docs users list continue route to complete

Declaration

[Obsolete("This function is deprecated")]
public ListUsersOnPaperDocResponse EndDocsUsersListContinue(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListUsersOnPaperDocResponse	The response to the send request

Exceptions

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

EndDocsUsersRemove(IAsyncResult)

Waits for the pending asynchronous send to the docs users remove route to complete

Declaration

[Obsolete("This function is deprecated")]
public void EndDocsUsersRemove(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 DocLookupError.

EndFoldersCreate(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated")]
public PaperFolderCreateResult EndFoldersCreate(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
PaperFolderCreateResult	The response to the send request

Exceptions

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

FoldersCreateAsync(PaperFolderCreateArg)

Create a new Paper folder with the provided info.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<PaperFolderCreateResult> FoldersCreateAsync(PaperFolderCreateArg paperFolderCreateArg)

Parameters

Type	Name	Description
PaperFolderCreateArg	paperFolderCreateArg	The request parameters

Returns

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

FoldersCreateAsync(String, String, Nullable<Boolean>)

Create a new Paper folder with the provided info.

Note that this endpoint will continue to work for content created by users on the older version of Paper. To check which version of Paper a user is on, use /users/features/get_values. If the paper_as_files feature is enabled, then the user is running the new version of Paper.

Refer to the Paper Migration Guide for migration information.

Declaration

[Obsolete("This function is deprecated")]
public Task<PaperFolderCreateResult> FoldersCreateAsync(string name, string parentFolderId = null, bool? isTeamFolder = null)

Parameters

Type	Name	Description
System.String	name	The name of the new Paper folder.
System.String	parentFolderId	The encrypted Paper folder Id where the new Paper folder should be created. The API user has to have write access to this folder or error is thrown. If not supplied, the new folder will be created at top level.
System.Nullable<System.Boolean>	isTeamFolder	Whether the folder to be created should be a team folder. This value will be ignored if parent_folder_id is supplied, as the new folder will inherit the type (private or team folder) from its parent. We will by default create a top-level private folder if both parent_folder_id and is_team_folder are not supplied.

Returns

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