Show / Hide Table of Contents

Namespace Dropbox.Api.Paper

Classes

AddMember

The add member object

AddPaperDocUser

The add paper doc user object

AddPaperDocUserMemberResult

Per-member result for DocsUsersAddAsync(AddPaperDocUser).

AddPaperDocUserResult

The add paper doc user result object

AddPaperDocUserResult.DailyLimitReached

The daily limit of how many users can be added to the Paper doc was reached.

AddPaperDocUserResult.FailedUserDataRetrieval

User data could not be retrieved. Clients should retry.

AddPaperDocUserResult.Other

The other object

AddPaperDocUserResult.PermissionAlreadyGranted

This user already has the correct permission to the Paper doc.

AddPaperDocUserResult.SharingOutsideTeamDisabled

The Paper doc can be shared only with team members.

AddPaperDocUserResult.Success

User was successfully added to the Paper doc.

AddPaperDocUserResult.UnknownError

Something unexpected happened when trying to add the user to the Paper doc.

AddPaperDocUserResult.UserIsOwner

Owner's permissions cannot be changed.

Cursor

The cursor object

DocLookupError

The doc lookup error object

DocLookupError.DocNotFound

The required doc was not found.

DocLookupError.InsufficientPermissions

Your account does not have permissions to perform this action. This may be due to it only having access to Paper as files in the Dropbox filesystem. For more information, refer to the Paper Migration Guide.

DocLookupError.Other

The other object

DocSubscriptionLevel

The subscription level of a Paper doc.

DocSubscriptionLevel.Default

No change email messages unless you're the creator.

DocSubscriptionLevel.Every

Subscribed: Shown in pad lists and activity and change email messages are sent.

DocSubscriptionLevel.Ignore

Ignored: Not shown in pad lists or activity and no email message is sent.

DocSubscriptionLevel.NoEmail

Unsubscribed: Shown in pad lists, but not in activity and no change email messages are sent.

ExportFormat

The desired export format of the Paper doc.

ExportFormat.Html

The HTML export format.

ExportFormat.Markdown

The markdown export format.

ExportFormat.Other

The other object

Folder

Data structure representing a Paper folder.

FoldersContainingPaperDoc

Metadata about Paper folders containing the specififed Paper doc.

FolderSharingPolicyType

The sharing policy of a Paper folder.

The sharing policy of subfolders is inherited from the root folder.

FolderSharingPolicyType.InviteOnly

Only people directly invited can access this folder.

FolderSharingPolicyType.Team

Everyone in your team and anyone directly invited can access this folder.

FolderSubscriptionLevel

The subscription level of a Paper folder.

FolderSubscriptionLevel.ActivityOnly

Shown in activity, no email messages.

FolderSubscriptionLevel.DailyEmails

Shown in activity, daily email messages.

FolderSubscriptionLevel.None

Not shown in activity, no email messages.

FolderSubscriptionLevel.WeeklyEmails

Shown in activity, weekly email messages.

ImportFormat

The import format of the incoming data.

ImportFormat.Html

The provided data is interpreted as standard HTML.

ImportFormat.Markdown

The provided data is interpreted as markdown.

The first line of the provided document will be used as the doc title.

ImportFormat.Other

The other object

ImportFormat.PlainText

The provided data is interpreted as plain text.

The first line of the provided document will be used as the doc title.

InviteeInfoWithPermissionLevel

The invitee info with permission level object

ListDocsCursorError

The list docs cursor error object

ListDocsCursorError.CursorError

The cursor error object

ListDocsCursorError.Other

The other object

ListPaperDocsArgs

The list paper docs args object

ListPaperDocsContinueArgs

The list paper docs continue args object

ListPaperDocsFilterBy

The list paper docs filter by object

ListPaperDocsFilterBy.DocsAccessed

Fetches all Paper doc IDs that the user has ever accessed.

ListPaperDocsFilterBy.DocsCreated

Fetches only the Paper doc IDs that the user has created.

ListPaperDocsFilterBy.Other

The other object

ListPaperDocsResponse

The list paper docs response object

ListPaperDocsSortBy

The list paper docs sort by object

ListPaperDocsSortBy.Accessed

Sorts the Paper docs by the time they were last accessed.

ListPaperDocsSortBy.Created

Sorts the Paper docs by the creation time.

ListPaperDocsSortBy.Modified

Sorts the Paper docs by the time they were last modified.

ListPaperDocsSortBy.Other

The other object

ListPaperDocsSortOrder

The list paper docs sort order object

ListPaperDocsSortOrder.Ascending

Sorts the search result in ascending order.

ListPaperDocsSortOrder.Descending

Sorts the search result in descending order.

ListPaperDocsSortOrder.Other

The other object

ListUsersCursorError

The list users cursor error object

ListUsersCursorError.CursorError

The cursor error object

ListUsersCursorError.DocNotFound

The required doc was not found.

ListUsersCursorError.InsufficientPermissions

Your account does not have permissions to perform this action. This may be due to it only having access to Paper as files in the Dropbox filesystem. For more information, refer to the Paper Migration Guide.

ListUsersCursorError.Other

The other object

ListUsersOnFolderArgs

The list users on folder args object

ListUsersOnFolderContinueArgs

The list users on folder continue args object

ListUsersOnFolderResponse

The list users on folder response object

ListUsersOnPaperDocArgs

The list users on paper doc args object

ListUsersOnPaperDocContinueArgs

The list users on paper doc continue args object

ListUsersOnPaperDocResponse

The list users on paper doc response object

PaperApiBaseError

The paper api base error object

PaperApiBaseError.InsufficientPermissions

Your account does not have permissions to perform this action. This may be due to it only having access to Paper as files in the Dropbox filesystem. For more information, refer to the Paper Migration Guide.

PaperApiBaseError.Other

The other object

PaperApiCursorError

The paper api cursor error object

PaperApiCursorError.ExpiredCursor

The provided cursor is expired.

PaperApiCursorError.InvalidCursor

The provided cursor is invalid.

PaperApiCursorError.Other

The other object

PaperApiCursorError.Reset

Indicates that the cursor has been invalidated. Call the corresponding non-continue endpoint to obtain a new cursor.

PaperApiCursorError.WrongUserInCursor

The provided cursor contains invalid user.

PaperDocCreateArgs

The paper doc create args object

PaperDocCreateError

The paper doc create error object

PaperDocCreateError.ContentMalformed

The provided content was malformed and cannot be imported to Paper.

PaperDocCreateError.DocLengthExceeded

The newly created Paper doc would be too large. Please split the content into multiple docs.

PaperDocCreateError.FolderNotFound

The specified Paper folder is cannot be found.

PaperDocCreateError.ImageSizeExceeded

The imported document contains an image that is too large. The current limit is 1MB. This only applies to HTML with data URI.

PaperDocCreateError.InsufficientPermissions

Your account does not have permissions to perform this action. This may be due to it only having access to Paper as files in the Dropbox filesystem. For more information, refer to the Paper Migration Guide.

PaperDocCreateError.Other

The other object

PaperDocCreateUpdateResult

The paper doc create update result object

PaperDocExport

The paper doc export object

PaperDocExportResult

The paper doc export result object

PaperDocPermissionLevel

The paper doc permission level object

PaperDocPermissionLevel.Edit

User will be granted edit permissions.

PaperDocPermissionLevel.Other

The other object

PaperDocPermissionLevel.ViewAndComment

User will be granted view and comment permissions.

PaperDocSharingPolicy

The paper doc sharing policy object

PaperDocUpdateArgs

The paper doc update args object

PaperDocUpdateError

The paper doc update error object

PaperDocUpdateError.ContentMalformed

The provided content was malformed and cannot be imported to Paper.

PaperDocUpdateError.DocArchived

This operation is not allowed on archived Paper docs.

PaperDocUpdateError.DocDeleted

This operation is not allowed on deleted Paper docs.

PaperDocUpdateError.DocLengthExceeded

The newly created Paper doc would be too large, split the content into multiple docs.

PaperDocUpdateError.DocNotFound

The required doc was not found.

PaperDocUpdateError.ImageSizeExceeded

The imported document contains an image that is too large. The current limit is 1MB. This only applies to HTML with data URI.

PaperDocUpdateError.InsufficientPermissions

Your account does not have permissions to perform this action. This may be due to it only having access to Paper as files in the Dropbox filesystem. For more information, refer to the Paper Migration Guide.

PaperDocUpdateError.Other

The other object

PaperDocUpdateError.RevisionMismatch

The provided revision does not match the document head.

PaperDocUpdatePolicy

The paper doc update policy object

PaperDocUpdatePolicy.Append

The content will be appended to the doc.

PaperDocUpdatePolicy.Other

The other object

PaperDocUpdatePolicy.OverwriteAll

The document will be overwitten at the head with the provided content.

PaperDocUpdatePolicy.Prepend

The content will be prepended to the doc.

The doc title will not be affected.

PaperFolderCreateArg

The paper folder create arg object

PaperFolderCreateError

The paper folder create error object

PaperFolderCreateError.FolderNotFound

The specified parent Paper folder cannot be found.

PaperFolderCreateError.InsufficientPermissions

Your account does not have permissions to perform this action. This may be due to it only having access to Paper as files in the Dropbox filesystem. For more information, refer to the Paper Migration Guide.

PaperFolderCreateError.InvalidFolderId

The folder id cannot be decrypted to valid folder id.

PaperFolderCreateError.Other

The other object

PaperFolderCreateResult

The paper folder create result object

RefPaperDoc

The ref paper doc object

RemovePaperDocUser

The remove paper doc user object

SharingPolicy

Sharing policy of Paper doc.

SharingPublicPolicyType

The sharing public policy type object

SharingPublicPolicyType.Disabled

Value used to indicate that doc sharing is enabled only within team.

SharingPublicPolicyType.InviteOnly

Users must be explicitly invited to this doc.

SharingPublicPolicyType.PeopleWithLinkCanEdit

Users who have a link to this doc can edit it.

SharingPublicPolicyType.PeopleWithLinkCanViewAndComment

Users who have a link to this doc can view and comment on it.

SharingTeamPolicyType

The sharing policy type of the Paper doc.

SharingTeamPolicyType.InviteOnly

Users must be explicitly invited to this doc.

SharingTeamPolicyType.PeopleWithLinkCanEdit

Users who have a link to this doc can edit it.

SharingTeamPolicyType.PeopleWithLinkCanViewAndComment

Users who have a link to this doc can view and comment on it.

UserInfoWithPermissionLevel

The user info with permission level object

UserOnPaperDocFilter

The user on paper doc filter object

UserOnPaperDocFilter.Other

The other object

UserOnPaperDocFilter.Shared

All uses who are shared on the Paper doc. This includes all users who have visited the Paper doc as well as those who have not.

UserOnPaperDocFilter.Visited

all users who have visited the Paper doc.

In This Article
  • Classes
Back to top Generated by DocFX