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

Inheritance
object
GetMarkdownArgs
Inherited Members
Namespace: Dropbox.Api.Riviera
Assembly: Dropbox.Api.dll
Syntax
public class GetMarkdownArgs

Constructors

View Source

GetMarkdownArgs(FileIdOrUrl, bool, bool)

Initializes a new instance of the GetMarkdownArgs class.

Declaration
public GetMarkdownArgs(FileIdOrUrl fileIdOrUrl = null, bool enableOcr = false, bool embedImages = false)
Parameters
Type Name Description
FileIdOrUrl fileIdOrUrl

Identifier of the document to convert. Callers must set exactly one of the FileIdOrUrl variants. The referenced file must be a document in a supported format (see the route description for the list); requests against unsupported formats return unsupported_format_error.
bool enableOcr

Enable OCR for PDF documents. Processing is slower when enabled.
bool embedImages

When true, embed images as base64 data URIs in the markdown output. This can significantly increase output size.

Properties

View Source

EmbedImages

When true, embed images as base64 data URIs in the markdown output. This can significantly increase output size.

Declaration
public bool EmbedImages { get; protected set; }
Property Value
Type Description
bool
View Source

EnableOcr

Enable OCR for PDF documents. Processing is slower when enabled.

Declaration
public bool EnableOcr { get; protected set; }
Property Value
Type Description
bool
View Source

FileIdOrUrl

Identifier of the document to convert. Callers must set exactly one of the `FileIdOrUrl` variants. The referenced file must be a document in a supported format (see the route description for the list); requests against unsupported formats return `unsupported_format_error`.

Declaration
public FileIdOrUrl FileIdOrUrl { get; protected set; }
Property Value
Type Description
FileIdOrUrl