Package com.dropbox.core.v2.riviera

Class DbxUserGetMarkdownAsyncBuilder

java.lang.Object
com.dropbox.core.v2.riviera.DbxUserGetMarkdownAsyncBuilder
public class DbxUserGetMarkdownAsyncBuilder extends Object
The request builder returned by DbxUserRivieraRequests.getMarkdownAsyncBuilder().

Use this class to set optional request parameters and complete the request.

  • Method Details

    • withFileIdOrUrl

      public DbxUserGetMarkdownAsyncBuilder withFileIdOrUrl(FileIdOrUrl fileIdOrUrl)
      Set value for optional field.
      Parameters:
      fileIdOrUrl - Identifier of the document to convert. Callers must set exactly one of the oneof variants: - file_id: a Dropbox-issued file id (format: "id:<id>") for a file the authenticated user has access to. - path: an absolute Dropbox path, e.g. "/folder/report.docx". - url: either a Dropbox shared link (www.dropbox.com) or an external HTTPS URL pointing to a supported document 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 over HTTPS through the backend's egress proxy and must point at a supported document file extension. The referenced file must be a document in a supported format; requests against unsupported formats return `unsupported_format_error`.
      Returns:
      this builder

    • withEnableOcr

      public DbxUserGetMarkdownAsyncBuilder withEnableOcr(Boolean enableOcr)
      Set value for optional field.

      If left unset or set to null, defaults to false.

      Parameters:
      enableOcr - Enable OCR for PDF documents. Processing is slower when enabled. Defaults to false when set to null.
      Returns:
      this builder

    • withEmbedImages

      public DbxUserGetMarkdownAsyncBuilder withEmbedImages(Boolean embedImages)
      Set value for optional field.

      If left unset or set to null, defaults to false.

      Parameters:
      embedImages - When true, embed images as base64 data URIs in the markdown output. This can significantly increase output size. Defaults to false when set to null.
      Returns:
      this builder

    • start

      public LaunchResultBase start() throws DbxApiException, DbxException
      Issues the request.
      Throws:
      DbxApiException
      DbxException