Package com.dropbox.core.v2.paper

Class DocsDownloadBuilder

java.lang.Object

com.dropbox.core.v2.DbxDownloadStyleBuilder<PaperDocExportResult>

com.dropbox.core.v2.paper.DocsDownloadBuilder

public class DocsDownloadBuilder
extends DbxDownloadStyleBuilder<PaperDocExportResult>

The request builder returned by DbxUserPaperRequests.docsDownloadBuilder(java.lang.String, com.dropbox.core.v2.paper.ExportFormat).

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

Method Summary

Modifier and Type	Method	Description
DbxDownloader<PaperDocExportResult>	start()	Issues the download request using this builder's request parameters and returns a DbxDownloader for reading the response body.
DocsDownloadBuilder	withIncludeComments(Boolean includeComments)	Set value for optional field.

Methods inherited from class com.dropbox.core.v2.DbxDownloadStyleBuilder

download, getHeaders, range, range

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

withIncludeComments

public DocsDownloadBuilder withIncludeComments(Boolean includeComments)

Set value for optional field.

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

Parameters:

includeComments - When true, export includes comment threads (e.g. markdown footnotes). When false or omitted, body only. Other formats may adopt this later; currently only markdown uses it. Plain bool (not optional): protoc-gen-godbx does not support proto3 optional yet. Defaults to false when set to null.

Returns:

this builder

start

public DbxDownloader<PaperDocExportResult> start()
                                          throws DocLookupErrorException,
DbxException

Description copied from class: DbxDownloadStyleBuilder

Issues the download request using this builder's request parameters and returns a DbxDownloader for reading the response body. Callers should fully read the response body using DbxDownloader.getInputStream() and close the downloader afterwards (see DbxDownloader.close()). This will allow for proper resource deallocation and connection re-use.. See DbxDownloadStyleBuilder.download(java.io.OutputStream) convenience method for a simpler way to complete the request.

Specified by:

start in class DbxDownloadStyleBuilder<PaperDocExportResult>

Returns:

DbxDownloader used to download data and read the response.

Throws:

DbxException - if an error occursing issuing the request

DocLookupErrorException