Package com.dropbox.core.v2.paper

Class DocsUsersAddBuilder

java.lang.Object

com.dropbox.core.v2.paper.DocsUsersAddBuilder

public class DocsUsersAddBuilder
extends Object

The request builder returned by DbxUserPaperRequests.docsUsersAddBuilder(java.lang.String, java.util.List<com.dropbox.core.v2.paper.AddMember>).

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

Method Summary

Modifier and Type	Method	Description
List<AddPaperDocUserMemberResult>	start()	Issues the request.
DocsUsersAddBuilder	withCustomMessage(String customMessage)	Set value for optional field.
DocsUsersAddBuilder	withQuiet(Boolean quiet)	Set value for optional field.

Methods inherited from class java.lang.Object

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

Method Details

withCustomMessage

public DocsUsersAddBuilder withCustomMessage(String customMessage)

Set value for optional field.

Parameters:

customMessage - A personal message that will be emailed to each successfully added member.

Returns:

this builder

withQuiet

public DocsUsersAddBuilder withQuiet(Boolean quiet)

Set value for optional field.

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

Parameters:

quiet - Clients should set this to true if no email message shall be sent to added users. Defaults to false when set to null.

Returns:

this builder

start

public List<AddPaperDocUserMemberResult> start()
                                        throws DocLookupErrorException,
DbxException

Issues the request.

Throws:

DocLookupErrorException

DbxException