Namespace Dropbox.Api.Riviera

Classes

ApiExifGpsMetadata

GPS coordinates and related tags extracted from image EXIF data. Fields are populated on a best-effort basis and may be empty when absent from the source file.

ApiExifMetadata

Image EXIF metadata. Mirrors the useful subset of the internal `riviera.ExifMetadata` message. Fields are best-effort and may be empty.

ApiMediaMetadata

Audio/video container and per-stream metadata. Mirrors the useful subset of the internal `riviera.MediaMetadata` message.

ApiMediaStream

A single audio or video stream within a media file.

ApiOfficeMetadata

MS Office document metadata. Mirrors the internal `riviera.OfficeMetadata` message. Some fields apply only to specific document types (e.g. `slides` for PowerPoint, `words`/`pages` for Word).

Reason a transcript job failed. Returned in the `failed` variant of `GetTranscriptAsyncCheckResult`. This is a semantic error union: the HTTP status of the poll request itself is unaffected (a poll that surfaces a failed job is still a normal successful poll response). Callers should branch on the variant.

ContentApiV2Error.IsAFolderError

The target is a folder, not a file.

ContentApiV2Error.LimitExceededError

The limit exceeded error object

ContentApiV2Error.LinkDownloadDisabledError

The link download disabled error object

ContentApiV2Error.MediaDurationError

The media duration error object

ContentApiV2Error.NoAudioError

The no audio error object

ContentApiV2Error.NotFoundError

The referenced file does not exist or is not accessible.

ContentApiV2Error.Other

The other object

ContentApiV2Error.ServerError

An unexpected, typically transient, server-side failure. The string is a human-readable message; retrying with backoff may succeed.

ContentApiV2Error.SharedLinkPasswordProtected

The shared link password protected object

ContentApiV2Error.UserError

The request could not be processed as supplied (a problem with the caller's input). The string is a human-readable message; retrying the same request will not help.

FileIdOrUrl

The file id or url object

FileIdOrUrl.FileId

FileIdOrUrl.Other

The other object

FileIdOrUrl.Path

An absolute Dropbox path, e.g. "/folder/example.pdf".

FileIdOrUrl.Url

Either a Dropbox shared link (www.dropbox.com) or an external HTTP or HTTPS URL pointing to a supported file. - Dropbox shared links are resolved internally using the caller's authenticated identity and the link's visibility / download settings. They therefore require an authenticated user context (anonymous `url` requests against Dropbox links are rejected with an `access_error`). Links protected by a password are rejected with `shared_link_password_protected`; links with downloads disabled are rejected with `link_download_disabled_error`. - External URLs are fetched through the backend's egress proxy and must point at a supported file extension.

GetMarkdownArgs

Arguments for the asynchronous `get_markdown_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the document to convert to markdown.

GetMarkdownAsyncCheckResult

Result type for EventBus async check

GetMarkdownAsyncCheckResult.Complete

The complete object

GetMarkdownAsyncCheckResult.Failed

The failed object

GetMarkdownAsyncCheckResult.InProgress

The in progress object

GetMarkdownAsyncCheckResult.Other

The other object

GetMarkdownResult

The get markdown result object

GetMetadataArgs

Arguments for the asynchronous `get_metadata_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the file whose metadata should be extracted.

GetMetadataAsyncCheckResult

Result type for EventBus async check - must end in "CheckResult"

GetMetadataAsyncCheckResult.Complete

The complete object

GetMetadataAsyncCheckResult.Failed

The failed object

GetMetadataAsyncCheckResult.InProgress

The in progress object

GetMetadataAsyncCheckResult.Other

The other object

GetMetadataResult

The get metadata result object

GetOcrArgs

Arguments for the asynchronous `get_ocr_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the image or PDF whose text should be extracted via OCR (optical character recognition).

GetOcrAsyncCheckResult

Result type for EventBus async check - must end in "CheckResult"

GetOcrAsyncCheckResult.Complete

The complete object

GetOcrAsyncCheckResult.Failed

The failed object

GetOcrAsyncCheckResult.InProgress

The in progress object

GetOcrAsyncCheckResult.Other

The other object

GetOcrResult

The get ocr result object

GetTextArgs

Arguments for the asynchronous `get_text_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the document whose plain-text content should be extracted.

GetTextAsyncCheckResult

Result type for EventBus async check - must end in "CheckResult"

GetTextAsyncCheckResult.Complete

The complete object

GetTextAsyncCheckResult.Failed

The failed object

GetTextAsyncCheckResult.InProgress

The in progress object

GetTextAsyncCheckResult.Other

The other object

GetTextResult

The get text result object

GetTranscriptArgs

Arguments for the asynchronous `get_transcript_async` route. Exactly one of `file_id`, `path`, or `url` must be supplied via `file_id_or_url` to identify the audio or video asset to transcribe.

GetTranscriptAsyncCheckResult

Result type for EventBus async check - must end in "CheckResult"

GetTranscriptAsyncCheckResult.Complete

The complete object

GetTranscriptAsyncCheckResult.Failed

The failed object

GetTranscriptAsyncCheckResult.InProgress

The in progress object

GetTranscriptAsyncCheckResult.Other

The other object

GetTranscriptResult

The get transcript result object

MarkdownConversionApiV2Error

Reason a markdown conversion job failed. Returned in the `failed` variant of `GetMarkdownAsyncCheckResult`. This is a semantic error union: the HTTP status of the poll request itself is unaffected (a poll that surfaces a failed job is still a normal successful poll response). Callers should branch on the variant.

MarkdownConversionApiV2Error.ConversionFailureError

The conversion failure error object

MarkdownConversionApiV2Error.IsAFolderError

The target is a folder, not a file.

MarkdownConversionApiV2Error.LimitExceededError

The limit exceeded error object

MarkdownConversionApiV2Error.LinkDownloadDisabledError

The link download disabled error object

MarkdownConversionApiV2Error.NotFoundError

The referenced file does not exist or is not accessible.

MarkdownConversionApiV2Error.Other

The other object

MarkdownConversionApiV2Error.ServerError

An unexpected, typically transient, server-side failure. The string is a human-readable message; retrying with backoff may succeed.

MarkdownConversionApiV2Error.SharedLinkPasswordProtected

The shared link password protected object

MarkdownConversionApiV2Error.UnsupportedFormatError

The unsupported format error object

MarkdownConversionApiV2Error.UserError

The request could not be processed as supplied (a problem with the caller's input). The string is a human-readable message; retrying the same request will not help.

MediaDurationError

The media duration error object

MetadataExtractionApiV2Error

Reason a metadata extraction job failed. Returned in the `failed` variant of `GetMetadataAsyncCheckResult`. This is a semantic error union: the HTTP status of the poll request itself is unaffected (a poll that surfaces a failed job is still a normal successful poll response). Callers should branch on the variant.

MetadataExtractionApiV2Error.ConversionFailureError

The conversion failure error object

MetadataExtractionApiV2Error.IsAFolderError

The target is a folder, not a file.

MetadataExtractionApiV2Error.LimitExceededError

The limit exceeded error object

MetadataExtractionApiV2Error.LinkDownloadDisabledError

The link download disabled error object

MetadataExtractionApiV2Error.NotFoundError

The referenced file does not exist or is not accessible.

MetadataExtractionApiV2Error.Other

The other object

MetadataExtractionApiV2Error.ServerError

An unexpected, typically transient, server-side failure. The string is a human-readable message; retrying with backoff may succeed.

MetadataExtractionApiV2Error.SharedLinkPasswordProtected

The shared link password protected object

MetadataExtractionApiV2Error.UnsupportedFormatError

The unsupported format error object

MetadataExtractionApiV2Error.UserError

The request could not be processed as supplied (a problem with the caller's input). The string is a human-readable message; retrying the same request will not help.

MetadataType

Which metadata variant is populated in a `GetMetadataResult`, derived from the file type.

MetadataType.MetadataTypeExif

The metadata type exif object

MetadataType.MetadataTypeMedia

The metadata type media object

MetadataType.MetadataTypeOffice

The metadata type office object

MetadataType.MetadataTypePdf

The metadata type pdf object

MetadataType.MetadataTypeUnknown

The metadata type unknown object

MetadataType.Other

The other object

MetadataUnion

Exactly one variant is populated, corresponding to `metadata_type`.

MetadataUnion.Exif

The exif object

MetadataUnion.Media

The media object

MetadataUnion.Office

The office object

MetadataUnion.Other

The other object

MetadataUnion.Pdf

The pdf object

OcrExtractionApiV2Error

Reason an OCR extraction job failed. Returned in the `failed` variant of `GetOcrAsyncCheckResult`. This is a semantic error union: the HTTP status of the poll request itself is unaffected (a poll that surfaces a failed job is still a normal successful poll response). Callers should branch on the variant.

OcrExtractionApiV2Error.ConversionFailureError

The conversion failure error object

OcrExtractionApiV2Error.IsAFolderError

The target is a folder, not a file.

OcrExtractionApiV2Error.LimitExceededError

The limit exceeded error object

OcrExtractionApiV2Error.LinkDownloadDisabledError

The link download disabled error object

OcrExtractionApiV2Error.NotFoundError

The referenced file does not exist or is not accessible.

OcrExtractionApiV2Error.Other

The other object

OcrExtractionApiV2Error.ServerError

An unexpected, typically transient, server-side failure. The string is a human-readable message; retrying with backoff may succeed.

OcrExtractionApiV2Error.SharedLinkPasswordProtected

The shared link password protected object

OcrExtractionApiV2Error.UnsupportedFormatError

The unsupported format error object

OcrExtractionApiV2Error.UserError

The request could not be processed as supplied (a problem with the caller's input). The string is a human-readable message; retrying the same request will not help.

OfficeFileType

The kind of MS Office document that produced an `ApiOfficeMetadata` result.

OfficeFileType.OfficeFiletypeExcel

The office filetype excel object

OfficeFileType.OfficeFiletypePowerpoint

The office filetype powerpoint object

OfficeFileType.OfficeFiletypeUnknown

The office filetype unknown object

OfficeFileType.OfficeFiletypeWord

The office filetype word object

OfficeFileType.Other

The other object

TextExtractionApiV2Error

Reason a text extraction job failed. Returned in the `failed` variant of `GetTextAsyncCheckResult`. This is a semantic error union: the HTTP status of the poll request itself is unaffected (a poll that surfaces a failed job is still a normal successful poll response). Callers should branch on the variant.