Package com.dropbox.core.v2.files

Class ExportBuilder

java.lang.Object

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

com.dropbox.core.v2.files.ExportBuilder

public class ExportBuilder
extends DbxDownloadStyleBuilder<ExportResult>

The request builder returned by DbxUserFilesRequests.exportBuilder(java.lang.String).

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

Method Summary

Modifier and Type	Method	Description
DbxDownloader<ExportResult>	start()	Issues the download request using this builder's request parameters and returns a DbxDownloader for reading the response body.
ExportBuilder	withExportFormat(String exportFormat)	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

withExportFormat

public ExportBuilder withExportFormat(String exportFormat)

Set value for optional field.

Parameters:

exportFormat - The file format to which the file should be exported. This must be one of the formats listed in the file's export_options returned by DbxUserFilesRequests.getMetadata(String). If none is specified, the default format (specified in export_as in file metadata) will be used.

Returns:

this builder

start

public DbxDownloader<ExportResult> start()
                                  throws ExportErrorException,
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<ExportResult>

Returns:

DbxDownloader used to download data and read the response.

Throws:

DbxException - if an error occursing issuing the request

ExportErrorException