Namespace Dropbox.Api.Files

This user's email address is not verified. This functionality is only available on accounts with a verified email address. Users can verify their email address here.

GetTemporaryLinkError.NotAllowed

The user is not allowed to request a temporary link to the specified file. For example, this can occur if the file is restricted or if the user's links are banned.

GetTemporaryLinkError.UnsupportedFile

Cannot get temporary link to this file type; use ExportAsync(ExportArg) instead.

GetTemporaryUploadLinkArg

The get temporary upload link arg object

GetTemporaryUploadLinkResult

The get temporary upload link result object

GetThumbnailBatchArg

Arguments for GetThumbnailBatchAsync(GetThumbnailBatchArg).

GetThumbnailBatchError.TooManyFiles

The operation involves more than 25 files.

GetThumbnailBatchResultData

The get thumbnail batch result data object

GetThumbnailBatchResultEntry

The get thumbnail batch result entry object

GetThumbnailBatchResultEntry.Failure

The result for this file if it was an error.

GetThumbnailBatchResultEntry.Other

The other object

GetThumbnailBatchResultEntry.Success

The success object

ImportFormat

The import format of the incoming Paper doc content.

ImportFormat.Html

The provided data is interpreted as standard HTML.

ImportFormat.Markdown

The provided data is interpreted as markdown.

ImportFormat.PlainText

The provided data is interpreted as plain text.

ListFolderContinueError.Reset

Indicates that the cursor has been invalidated. Call ListFolderAsync(ListFolderArg) ListFolderAsync(ListFolderArg) to obtain a new cursor.

ListFolderGetLatestCursorResult

The list folder get latest cursor result object

ListFolderLongpollError.Reset

Indicates that the cursor has been invalidated. Call ListFolderAsync(ListFolderArg) ListFolderAsync(ListFolderArg) to obtain a new cursor.

ListRevisionsMode.Id

Returns revisions with the same file id as identified by the latest file entry at the given file path or id.

ListRevisionsMode.Path

Returns revisions with the same file path as identified by the latest file entry at the given file path or id.

LockFileError.InternalError

Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

LockFileError.LockConflict

The user action conflicts with an existing lock on the file.

LockFileError.NoWritePermission

The user does not have permissions to change the lock state or access the file.

LockFileError.TooManyFiles

There are too many files in one request. Please retry with fewer files.

LockFileError.TooManyWriteOperations

There are too many write operations in user's Dropbox. Please retry this request.

LookupError.MalformedPath

The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.

LookupError.NotFile

We were expecting a file, but the given path refers to something that isn't a file.

LookupError.NotFolder

We were expecting a folder, but the given path refers to something that isn't a folder.

LookupError.RestrictedContent

The file cannot be transferred because the content is restricted. For example, we might restrict a file due to legal requirements.

LookupError.UnsupportedContentType

This operation is not supported for this content type.

MediaInfo.Pending

Indicate the photo/video is still under processing and metadata is not available yet.

MetadataV2

Metadata for a file, folder or other resource types.

MoveIntoFamilyError.IsSharedFolder

Moving shared folder into Family Room folder is not allowed.

MoveIntoVaultError.IsSharedFolder

Moving shared folder into Vault is not allowed.

PaperContentError.ContentMalformed

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

PaperContentError.DocLengthExceeded

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

PaperContentError.ImageSizeExceeded

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

PaperContentError.InsufficientPermissions

Your account does not have permissions to edit Paper docs.

PaperCreateError.ContentMalformed

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

PaperCreateError.DocLengthExceeded

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

PaperCreateError.EmailUnverified

The user's email must be verified to create Paper docs.

PaperCreateError.ImageSizeExceeded

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

PaperCreateError.InsufficientPermissions

Your account does not have permissions to edit Paper docs.

PaperCreateError.InvalidFileExtension

The file path must end in .paper.

PaperCreateError.InvalidPath

The file could not be saved to the specified location.

PaperCreateError.PaperDisabled

Paper is disabled for your team.

PaperDocUpdatePolicy.Append

Adds the provided content to the end of the doc without checking paper_revision.

PaperDocUpdatePolicy.Overwrite

Sets the doc content to the provided content without checking paper_revision.

PaperDocUpdatePolicy.Prepend

Adds the provided content to the beginning of the doc without checking paper_revision.

PaperDocUpdatePolicy.Update

Sets the doc content to the provided content if the provided paper_revision matches the latest doc revision. Otherwise, returns an error.

PaperUpdateError.ContentMalformed

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

PaperUpdateError.DocArchived

This operation is not allowed on archived Paper docs.

PaperUpdateError.DocDeleted

This operation is not allowed on deleted Paper docs.

PaperUpdateError.DocLengthExceeded

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

PaperUpdateError.ImageSizeExceeded

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

PaperUpdateError.InsufficientPermissions

Your account does not have permissions to edit Paper docs.

PaperUpdateError.RevisionMismatch

The provided revision does not match the document head.

PreviewError.InProgress

This preview generation is still in progress and the file is not ready for preview yet.

PreviewError.Path

An error occurs when downloading metadata for the file.

PreviewError.UnsupportedContent

The file content is not supported for preview generation.

PreviewError.UnsupportedExtension

The file extension is not supported preview generation.

RelocationBatchError.CantCopySharedFolder

Shared folders can't be copied.

RelocationBatchError.CantMoveFolderIntoItself

You cannot move a folder into itself.

RelocationBatchError.CantMoveIntoFamily

Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.

RelocationBatchError.CantMoveIntoVault

Some content cannot be moved into Vault under certain circumstances, see detailed error.

RelocationBatchError.CantMoveSharedFolder

Can't move the shared folder to the given destination.

RelocationBatchError.CantNestSharedFolder

Your move operation would result in nested shared folders. This is not allowed.

RelocationBatchError.CantTransferOwnership

Your move operation would result in an ownership transfer. You may reissue the request with the field AllowOwnershipTransfer to true.

RelocationBatchError.DuplicatedOrNestedPaths

There are duplicated/nested paths among and .

RelocationBatchError.FromLookup

The from lookup object

RelocationBatchError.FromWrite

The from write object

RelocationBatchError.InsufficientQuota

The current user does not have enough space to move or copy the files.

RelocationBatchError.InternalError

Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

RelocationBatchError.TooManyFiles

The operation would involve more than 10,000 files and folders.

RelocationBatchError.TooManyWriteOperations

There are too many write operations in user's Dropbox. Please retry this request.

RelocationBatchErrorEntry.InternalError

Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

RelocationBatchErrorEntry.Other

The other object

RelocationBatchErrorEntry.RelocationError

User errors that retry won't help.

RelocationBatchErrorEntry.TooManyWriteOperations

There are too many write operations in user's Dropbox. Please retry this request.

RelocationBatchJobStatus.Complete

The copy or move batch job has finished.

RelocationBatchJobStatus.Failed

The copy or move batch job has failed with exception.

RelocationBatchJobStatus.InProgress

The asynchronous job is still in progress.

RelocationBatchLaunch

Result returned by CopyBatchAsync(RelocationBatchArg) or MoveBatchAsync(RelocationBatchArg) that may either launch an asynchronous job or complete synchronously.

RelocationBatchLaunch.AsyncJobId

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

RelocationBatchLaunch.Complete

The complete object

RelocationBatchResultEntry

The relocation batch result entry object

RelocationBatchResultEntry.Failure

The failure object

RelocationBatchResultEntry.Other

The other object

RelocationBatchResultEntry.Success

The success object

RelocationBatchV2JobStatus

Result returned by CopyBatchCheckV2Async(PollArg) or MoveBatchCheckV2Async(PollArg) that may either be in progress or completed with result for each entry.

RelocationBatchV2JobStatus.Complete

The copy or move batch job has finished.

RelocationBatchV2JobStatus.InProgress

The asynchronous job is still in progress.

RelocationBatchV2Launch

Result returned by CopyBatchV2Async(RelocationBatchArgBase) or MoveBatchV2Async(MoveBatchArg) that may either launch an asynchronous job or complete synchronously.

RelocationBatchV2Launch.AsyncJobId

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

RelocationBatchV2Launch.Complete

The complete object

RelocationError.CantCopySharedFolder

Shared folders can't be copied.

RelocationError.CantMoveFolderIntoItself

You cannot move a folder into itself.

RelocationError.CantMoveIntoFamily

Some content cannot be moved into the Family Room folder under certain circumstances, see detailed error.

RelocationError.CantMoveIntoVault

Some content cannot be moved into Vault under certain circumstances, see detailed error.

RelocationError.CantMoveSharedFolder

Can't move the shared folder to the given destination.

RelocationError.CantNestSharedFolder

Your move operation would result in nested shared folders. This is not allowed.

RelocationError.CantTransferOwnership

Your move operation would result in an ownership transfer. You may reissue the request with the field AllowOwnershipTransfer to true.

RelocationError.DuplicatedOrNestedPaths

There are duplicated/nested paths among and .

RelocationError.InsufficientQuota

The current user does not have enough space to move or copy the files.

RelocationError.InternalError

Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

RelocationError.TooManyFiles

The operation would involve more than 10,000 files and folders.

RestoreError.InProgress

The restore is currently executing, but has not yet completed.

RestoreError.InvalidRevision

The revision is invalid. It may not exist or may point to a deleted file.

RestoreError.PathLookup

An error occurs when downloading metadata for the file.

RestoreError.PathWrite

An error occurs when trying to restore the file to that path.

SaveCopyReferenceError.InvalidCopyReference

The copy reference is invalid.

SaveCopyReferenceError.NoPermission

You don't have permission to save the given copy reference. Please make sure this app is same app which created the copy reference and the source user is still linked to the app.

SaveCopyReferenceError.NotFound

The file referenced by the copy reference cannot be found.

SaveCopyReferenceError.TooManyFiles

The operation would involve more than 10,000 files and folders.

SaveUrlError.DownloadFailed

Failed downloading the given URL. The URL may be password-protected and the password provided was incorrect, or the link may be disabled.

SaveUrlError.NotFound

The file where the URL is saved to no longer exists.

SaveUrlJobStatus.Complete

Metadata of the file where the URL is saved to.

SaveUrlJobStatus.InProgress

The asynchronous job is still in progress.

SaveUrlResult.AsyncJobId

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

SaveUrlResult.Complete

Metadata of the file where the URL is saved to.

SearchMatchType

Indicates what type of match was found for a given item.

SearchMatchType.Both

This item was matched based on both its contents and its file name.

SearchMatchType.Content

This item was matched based on its file contents.

SearchMatchType.Filename

This item was matched on its file or folder name.

SearchMatchTypeV2

Indicates what type of match was found for a given item.

SearchMatchTypeV2.FileContent

This item was matched based on its file contents.

SearchMatchTypeV2.Filename

This item was matched on its file or folder name.

SearchMatchTypeV2.FilenameAndContent

This item was matched based on both its contents and its file name.

SearchMatchTypeV2.ImageContent

This item was matched on image content.

SearchMode.DeletedFilename

Search for deleted file and folder names.

SearchMode.FilenameAndContent

Search file and folder names as well as file contents.

SearchOrderBy.LastModifiedTime

The last modified time object

SyncSetting.Default

On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.

SyncSetting.NotSynced

On first sync to members' computers, the specified folder will be set to not sync with selective sync.

SyncSetting.NotSyncedInactive

The specified folder's not_synced setting is inactive due to its location or other configuration changes. It will follow its parent folder's setting.

SyncSettingArg.Default

On first sync to members' computers, the specified folder will follow its parent folder's setting or otherwise follow default sync behavior.

SyncSettingArg.NotSynced

On first sync to members' computers, the specified folder will be set to not sync with selective sync.

SyncSettingsError.UnsupportedCombination

Setting this combination of sync settings simultaneously is not supported.

SyncSettingsError.UnsupportedConfiguration

The specified configuration is not supported.

ThumbnailError.ConversionError

An error occurs during thumbnail conversion.

ThumbnailError.Path

An error occurs when downloading metadata for the image.

ThumbnailError.UnsupportedExtension

The file extension doesn't allow conversion to a thumbnail.

ThumbnailError.UnsupportedImage

The image cannot be converted to a thumbnail.

ThumbnailMode.Bestfit

Scale down the image to fit within the given size or its transpose.

ThumbnailMode.FitoneBestfit

Scale down the image to completely cover the given size or its transpose.

ThumbnailMode.Strict

Scale down the image to fit within the given size.

ThumbnailV2Error.AccessDenied

Access to this shared link is forbidden.

ThumbnailV2Error.ConversionError

An error occurred during thumbnail conversion.

ThumbnailV2Error.Path

An error occurred when downloading metadata for the image.

ThumbnailV2Error.UnsupportedExtension

The file extension doesn't allow conversion to a thumbnail.

ThumbnailV2Error.UnsupportedImage

The image cannot be converted to a thumbnail.

UploadError.ContentHashMismatch

The content received by the Dropbox server in this call does not match the provided content hash.

UploadError.Path

Unable to save the uploaded contents to a file.

UploadError.PayloadTooLarge

The request payload must be at most 150 MB.

UploadError.PropertiesError

The supplied property group is invalid. The file has uploaded without property groups.

UploadSessionAppendError.Closed

You are attempting to append data to an upload session that has already been closed (i.e. committed).

UploadSessionAppendError.ConcurrentSessionInvalidDataSize

For concurrent upload sessions, only chunks with size multiple of 4194304 bytes can be uploaded.

UploadSessionAppendError.ConcurrentSessionInvalidOffset

For concurrent upload sessions, offset needs to be multiple of 4194304 bytes.

UploadSessionAppendError.ContentHashMismatch

The content received by the Dropbox server in this call does not match the provided content hash.

UploadSessionAppendError.IncorrectOffset

The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error.

UploadSessionAppendError.NotClosed

The session must be closed before calling upload_session/finish_batch.

UploadSessionAppendError.NotFound

The upload session ID was not found or has expired. Upload sessions are valid for 7 days.

UploadSessionAppendError.Other

The other object

UploadSessionAppendError.PayloadTooLarge

The request payload must be at most 150 MB.

UploadSessionAppendError.TooLarge

You can not append to the upload session because the size of a file should not reach the max file size limit (i.e. 350GB).

UploadSessionCursor

The upload session cursor object

UploadSessionFinishArg

The upload session finish arg object

UploadSessionFinishBatchArg

The upload session finish batch arg object

UploadSessionFinishBatchJobStatus

The upload session finish batch job status object

UploadSessionFinishBatchJobStatus.Complete

The UploadSessionFinishBatchAsync(UploadSessionFinishBatchArg) has finished.

UploadSessionFinishBatchJobStatus.InProgress

The asynchronous job is still in progress.

UploadSessionFinishBatchLaunch

Result returned by UploadSessionFinishBatchAsync(UploadSessionFinishBatchArg) that may either launch an asynchronous job or complete synchronously.

UploadSessionFinishBatchLaunch.AsyncJobId

This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

UploadSessionFinishBatchLaunch.Complete

The complete object

UploadSessionFinishBatchLaunch.Other

The other object

UploadSessionFinishBatchResult

The upload session finish batch result object

UploadSessionFinishBatchResultEntry

The upload session finish batch result entry object

UploadSessionFinishBatchResultEntry.Failure

The failure object

UploadSessionFinishBatchResultEntry.Success

The success object

UploadSessionFinishError

The upload session finish error object

UploadSessionFinishError.ConcurrentSessionDataNotAllowed

Uploading data not allowed when finishing concurrent upload session.

UploadSessionFinishError.ConcurrentSessionMissingData

Not all pieces of data were uploaded before trying to finish the session.

UploadSessionFinishError.ConcurrentSessionNotClosed

Concurrent upload sessions need to be closed before finishing.

UploadSessionFinishError.ContentHashMismatch

The content received by the Dropbox server in this call does not match the provided content hash.

UploadSessionFinishError.LookupFailed

The session arguments are incorrect; the value explains the reason.

UploadSessionFinishError.Other

The other object

UploadSessionFinishError.Path

Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset.

UploadSessionFinishError.PayloadTooLarge

The request payload must be at most 150 MB.

UploadSessionFinishError.PropertiesError

The supplied property group is invalid. The file has uploaded without property groups.

UploadSessionFinishError.TooManySharedFolderTargets

The batch request commits files into too many different shared folders. Please limit your batch request to files contained in a single shared folder.

UploadSessionFinishError.TooManyWriteOperations

There are too many write operations happening in the user's Dropbox. You should retry uploading this file.

UploadSessionLookupError

The upload session lookup error object

UploadSessionLookupError.Closed

You are attempting to append data to an upload session that has already been closed (i.e. committed).

UploadSessionLookupError.ConcurrentSessionInvalidDataSize

For concurrent upload sessions, only chunks with size multiple of 4194304 bytes can be uploaded.

UploadSessionLookupError.ConcurrentSessionInvalidOffset

For concurrent upload sessions, offset needs to be multiple of 4194304 bytes.

UploadSessionLookupError.IncorrectOffset

UploadSessionLookupError.NotClosed

The session must be closed before calling upload_session/finish_batch.

UploadSessionLookupError.NotFound

The upload session ID was not found or has expired. Upload sessions are valid for 7 days.

UploadSessionLookupError.Other

The other object

UploadSessionLookupError.PayloadTooLarge

The request payload must be at most 150 MB.

UploadSessionLookupError.TooLarge

You can not append to the upload session because the size of a file should not reach the max file size limit (i.e. 350GB).

UploadSessionOffsetError

The upload session offset error object

UploadSessionStartArg

The upload session start arg object

UploadSessionStartBatchArg

The upload session start batch arg object

UploadSessionStartBatchResult

The upload session start batch result object

UploadSessionStartError

The upload session start error object

UploadSessionStartError.ConcurrentSessionCloseNotAllowed

Can not start a closed concurrent upload session.

UploadSessionStartError.ConcurrentSessionDataNotAllowed

Uploading data not allowed when starting concurrent upload session.

UploadSessionStartError.ContentHashMismatch

The content received by the Dropbox server in this call does not match the provided content hash.

UploadSessionStartError.Other

The other object

UploadSessionStartError.PayloadTooLarge

The request payload must be at most 150 MB.

UploadSessionStartResult

The upload session start result object

UploadSessionType

The upload session type object

UploadSessionType.Concurrent

Pieces of data can be uploaded in concurrent RPCs in any order.

UploadSessionType.Other

The other object

UploadSessionType.Sequential

Pieces of data are uploaded sequentially one after another. This is the default behavior.

UploadWriteFailed

The upload write failed object

UserGeneratedTag

The user generated tag object

VideoMetadata

Metadata for a video.

WriteConflictError

The write conflict error object

WriteConflictError.File

There's a file in the way.

WriteConflictError.FileAncestor

There's a file at an ancestor path, so we couldn't create the required parent folders.

WriteConflictError.Folder

There's a folder in the way.

WriteConflictError.Other

The other object

WriteError

The write error object

WriteError.Conflict

Couldn't write to the target path because there was something in the way.

WriteError.DisallowedName

Dropbox will not save the file or folder because of its name.

WriteError.InsufficientSpace

The user doesn't have enough available space (bytes) to write more data.

WriteError.MalformedPath

The given path does not satisfy the required path format. Please refer to the Path formats documentation for more information.

WriteError.NoWritePermission

The user doesn't have permissions to write to the target location.

WriteError.OperationSuppressed

This file operation is not allowed at this path.

WriteError.Other

The other object

WriteError.TeamFolder

This endpoint cannot move or delete team folders.

WriteError.TooManyWriteOperations

There are too many write operations in user's Dropbox. Please retry this request.

WriteMode

Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is.

In some situations, the conflict behavior is identical: (a) If the target path doesn't refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it's always a conflict. (c) If the target path refers to a file with identical contents, nothing gets written; no conflict.

The conflict checking differs in the case where there's a file at the target path with contents different from the contents you're trying to write.

WriteMode.Add

Do not overwrite an existing file if there is a conflict. The autorename strategy is to append a number to the file name. For example, "document.txt" might become "document (2).txt".

WriteMode.Overwrite

Always overwrite the existing file. The autorename strategy is the same as it is for WriteMode.Add.

WriteMode.Update

Overwrite if the given "rev" matches the existing file's "rev". The supplied value should be the latest known "rev" of the file, for example, from FileMetadata, from when the file was last downloaded by the app. This will cause the file on the Dropbox servers to be overwritten if the given "rev" matches the existing file's current "rev" on the Dropbox servers. The autorename strategy is to append the string "conflicted copy" to the file name. For example, "document.txt" might become "document (conflicted copy).txt" or "document (Panda's conflicted copy).txt".