com.dropbox.core.v2.sharing

Class ShareFolderBuilder

java.lang.Object

com.dropbox.core.v2.sharing.ShareFolderBuilder

public class ShareFolderBuilder
extends Object

The request builder returned by DbxUserSharingRequests.shareFolderBuilder(java.lang.String).

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

Method Summary

Modifier and Type	Method and Description
ShareFolderLaunch	start() Issues the request.
ShareFolderBuilder	withAclUpdatePolicy(AclUpdatePolicy aclUpdatePolicy) Set value for optional field.
ShareFolderBuilder	withForceAsync(Boolean forceAsync) Set value for optional field.
ShareFolderBuilder	withMemberPolicy(MemberPolicy memberPolicy) Set value for optional field.
ShareFolderBuilder	withSharedLinkPolicy(SharedLinkPolicy sharedLinkPolicy) 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

withMemberPolicy

public ShareFolderBuilder withMemberPolicy(MemberPolicy memberPolicy)

Set value for optional field.

If left unset or set to null, defaults to MemberPolicy.ANYONE.

Parameters:

memberPolicy - Who can be a member of this shared folder. Only applicable if the current user is on a team. Must not be null. Defaults to MemberPolicy.ANYONE when set to null.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withAclUpdatePolicy

public ShareFolderBuilder withAclUpdatePolicy(AclUpdatePolicy aclUpdatePolicy)

Set value for optional field.

If left unset or set to null, defaults to AclUpdatePolicy.OWNER.

Parameters:

aclUpdatePolicy - Who can add and remove members of this shared folder. Must not be null. Defaults to AclUpdatePolicy.OWNER when set to null.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withSharedLinkPolicy

public ShareFolderBuilder withSharedLinkPolicy(SharedLinkPolicy sharedLinkPolicy)

Set value for optional field.

If left unset or set to null, defaults to SharedLinkPolicy.ANYONE.

Parameters:

sharedLinkPolicy - The policy to apply to shared links created for content inside this shared folder. The current user must be on a team to set this policy to SharedLinkPolicy.MEMBERS. Must not be null. Defaults to SharedLinkPolicy.ANYONE when set to null.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withForceAsync

public ShareFolderBuilder withForceAsync(Boolean forceAsync)

Set value for optional field.

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

Parameters:

forceAsync - Whether to force the share to happen asynchronously. Defaults to false when set to null.

Returns:

this builder

start

public ShareFolderLaunch start()
                        throws ShareFolderErrorException,
                               DbxException

Issues the request.

Throws:

ShareFolderErrorException

DbxException