com.dropbox.core.v2.sharing

Class ShareFolderBuilder

java.lang.Object

com.dropbox.core.v2.sharing.ShareFolderBuilder

public class ShareFolderBuilder
extends java.lang.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	withAccessInheritance(AccessInheritance accessInheritance) Set value for optional field.
ShareFolderBuilder	withAclUpdatePolicy(AclUpdatePolicy aclUpdatePolicy) Set value for optional field.
ShareFolderBuilder	withActions(java.util.List<FolderAction> actions) Set value for optional field.
ShareFolderBuilder	withForceAsync(java.lang.Boolean forceAsync) Set value for optional field.
ShareFolderBuilder	withLinkSettings(LinkSettings linkSettings) Set value for optional field.
ShareFolderBuilder	withMemberPolicy(MemberPolicy memberPolicy) Set value for optional field.
ShareFolderBuilder	withSharedLinkPolicy(SharedLinkPolicy sharedLinkPolicy) Set value for optional field.
ShareFolderBuilder	withViewerInfoPolicy(ViewerInfoPolicy viewerInfoPolicy) 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

withAclUpdatePolicy

public ShareFolderBuilder withAclUpdatePolicy(AclUpdatePolicy aclUpdatePolicy)

Set value for optional field.

Parameters:

aclUpdatePolicy - Who can add and remove members of this shared folder.

Returns:

this builder

withForceAsync

public ShareFolderBuilder withForceAsync(java.lang.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

withMemberPolicy

public ShareFolderBuilder withMemberPolicy(MemberPolicy memberPolicy)

Set value for optional field.

Parameters:

memberPolicy - Who can be a member of this shared folder. Only applicable if the current user is on a team.

Returns:

this builder

withSharedLinkPolicy

public ShareFolderBuilder withSharedLinkPolicy(SharedLinkPolicy sharedLinkPolicy)

Set value for optional field.

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.

Returns:

this builder

withViewerInfoPolicy

public ShareFolderBuilder withViewerInfoPolicy(ViewerInfoPolicy viewerInfoPolicy)

Set value for optional field.

Parameters:

viewerInfoPolicy - Who can enable/disable viewer info for this shared folder.

Returns:

this builder

withAccessInheritance

public ShareFolderBuilder withAccessInheritance(AccessInheritance accessInheritance)

Set value for optional field.

If left unset or set to null, defaults to AccessInheritance.INHERIT.

Parameters:

accessInheritance - The access inheritance settings for the folder. Must not be null. Defaults to AccessInheritance.INHERIT when set to null.

Returns:

this builder

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

withActions

public ShareFolderBuilder withActions(java.util.List<FolderAction> actions)

Set value for optional field.

Parameters:

actions - A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's SharedFolderMetadata.getPermissions() field describing the actions the authenticated user can perform on the folder. Must not contain a null item.

Returns:

this builder

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

withLinkSettings

public ShareFolderBuilder withLinkSettings(LinkSettings linkSettings)

Set value for optional field.

Parameters:

linkSettings - Settings on the link for this folder.

Returns:

this builder

start

public ShareFolderLaunch start()
                        throws ShareFolderErrorException,
                               DbxException

Issues the request.

Throws:

ShareFolderErrorException

DbxException