Package com.dropbox.core.v2.filerequests

Class CreateBuilder

java.lang.Object

com.dropbox.core.v2.filerequests.CreateBuilder

public class CreateBuilder
extends java.lang.Object

The request builder returned by DbxUserFileRequestsRequests.createBuilder(java.lang.String, java.lang.String).

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

Method Summary

Modifier and Type	Method	Description
FileRequest	start()	Issues the request.
CreateBuilder	withDeadline(FileRequestDeadline deadline)	Set value for optional field.
CreateBuilder	withDescription(java.lang.String description)	Set value for optional field.
CreateBuilder	withOpen(java.lang.Boolean open)	Set value for optional field.

Methods inherited from class java.lang.Object

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

Method Detail

withDeadline

public CreateBuilder withDeadline(FileRequestDeadline deadline)

Set value for optional field.

Parameters:

deadline - The deadline for the file request. Deadlines can only be set by Professional and Business accounts.

Returns:

this builder

withOpen

public CreateBuilder withOpen(java.lang.Boolean open)

Set value for optional field.

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

Parameters:

open - Whether or not the file request should be open. If the file request is closed, it will not accept any file submissions, but it can be opened later. Defaults to true when set to null.

Returns:

this builder

withDescription

public CreateBuilder withDescription(java.lang.String description)

Set value for optional field.

Parameters:

description - A description of the file request.

Returns:

this builder

start

public FileRequest start()
                  throws CreateFileRequestErrorException,
                         DbxException

Issues the request.

Throws:

CreateFileRequestErrorException

DbxException