com.dropbox.core.v2.sharing

Class AddFileMemberBuilder

java.lang.Object

com.dropbox.core.v2.sharing.AddFileMemberBuilder

public class AddFileMemberBuilder
extends Object

The request builder returned by DbxUserSharingRequests.addFileMemberBuilder(java.lang.String, java.util.List<com.dropbox.core.v2.sharing.MemberSelector>).

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

Method Summary

Modifier and Type	Method and Description
List<FileMemberActionResult>	start() Issues the request.
AddFileMemberBuilder	withAccessLevel(AccessLevel accessLevel) Set value for optional field.
AddFileMemberBuilder	withAddMessageAsComment(Boolean addMessageAsComment) Set value for optional field.
AddFileMemberBuilder	withCustomMessage(String customMessage) Set value for optional field.
AddFileMemberBuilder	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 Detail

withCustomMessage

public AddFileMemberBuilder withCustomMessage(String customMessage)

Set value for optional field.

Parameters:

customMessage - Message to send to added members in their invitation.

Returns:

this builder

withQuiet

public AddFileMemberBuilder withQuiet(Boolean quiet)

Set value for optional field.

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

Parameters:

quiet - Whether added members should be notified via device notifications of their invitation. Defaults to false when set to null.

Returns:

this builder

withAccessLevel

public AddFileMemberBuilder withAccessLevel(AccessLevel accessLevel)

Set value for optional field.

If left unset or set to null, defaults to AccessLevel.VIEWER.

Parameters:

accessLevel - AccessLevel union object, describing what access level we want to give new members. Must not be null. Defaults to AccessLevel.VIEWER when set to null.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withAddMessageAsComment

public AddFileMemberBuilder withAddMessageAsComment(Boolean addMessageAsComment)

Set value for optional field.

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

Parameters:

addMessageAsComment - If the custom message should be added as a comment on the file. Defaults to false when set to null.

Returns:

this builder

start

public List<FileMemberActionResult> start()
                                   throws AddFileMemberErrorException,
                                          DbxException

Issues the request.

Throws:

AddFileMemberErrorException

DbxException