Class GetMarkdownArgs

Arguments for the asynchronous GetMarkdownAsyncAsync(GetMarkdownArgs) GetMarkdownAsyncAsync(GetMarkdownArgs) route. Exactly one of FileIdOrUrl.FileId, FileIdOrUrl.Path, or FileIdOrUrl.Url must be supplied via FileIdOrUrl to identify the document to convert to markdown.

Inheritance

object

GetMarkdownArgs

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Dropbox.Api.Riviera

Assembly: Dropbox.Api.dll

Syntax

public class GetMarkdownArgs

Constructors

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 fail with MarkdownConversionApiV2Error.UserError.
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

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

EnableOcr

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

Declaration

public bool EnableOcr { get; protected set; }

Property Value

Type	Description
bool

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 fail with MarkdownConversionApiV2Error.UserError.

Declaration

public FileIdOrUrl FileIdOrUrl { get; protected set; }

Property Value

Type	Description
FileIdOrUrl