Package com.dropbox.core.v2.sharing

Class SharedLinkSettings.Builder

java.lang.Object

com.dropbox.core.v2.sharing.SharedLinkSettings.Builder

Enclosing class:

SharedLinkSettings

public static class SharedLinkSettings.Builder
extends java.lang.Object

Builder for SharedLinkSettings.

Field Summary

Fields

Modifier and Type	Field	Description
protected RequestedLinkAccessLevel	access
protected java.lang.Boolean	allowDownload
protected LinkAudience	audience
protected java.util.Date	expires
protected java.lang.String	linkPassword
protected RequestedVisibility	requestedVisibility
protected java.lang.Boolean	requirePassword

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
SharedLinkSettings	build()	Builds an instance of SharedLinkSettings configured with this builder's values
SharedLinkSettings.Builder	withAccess(RequestedLinkAccessLevel access)	Set value for optional field.
SharedLinkSettings.Builder	withAllowDownload(java.lang.Boolean allowDownload)	Set value for optional field.
SharedLinkSettings.Builder	withAudience(LinkAudience audience)	Set value for optional field.
SharedLinkSettings.Builder	withExpires(java.util.Date expires)	Set value for optional field.
SharedLinkSettings.Builder	withLinkPassword(java.lang.String linkPassword)	Set value for optional field.
SharedLinkSettings.Builder	withRequestedVisibility(RequestedVisibility requestedVisibility)	Set value for optional field.
SharedLinkSettings.Builder	withRequirePassword(java.lang.Boolean requirePassword)	Set value for optional field.

Methods inherited from class java.lang.Object

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

Field Detail

requirePassword

protected java.lang.Boolean requirePassword

linkPassword

protected java.lang.String linkPassword

expires

protected java.util.Date expires

audience

protected LinkAudience audience

access

protected RequestedLinkAccessLevel access

requestedVisibility

protected RequestedVisibility requestedVisibility

allowDownload

protected java.lang.Boolean allowDownload

Constructor Detail

Builder

protected Builder()

Method Detail

withRequirePassword

public SharedLinkSettings.Builder withRequirePassword(java.lang.Boolean requirePassword)

Set value for optional field.

Parameters:

requirePassword - Boolean flag to enable or disable password protection.

Returns:

this builder

withLinkPassword

public SharedLinkSettings.Builder withLinkPassword(java.lang.String linkPassword)

Set value for optional field.

Parameters:

linkPassword - If SharedLinkSettings.getRequirePassword() is true, this is needed to specify the password to access the link.

Returns:

this builder

withExpires

public SharedLinkSettings.Builder withExpires(java.util.Date expires)

Set value for optional field.

Parameters:

expires - Expiration time of the shared link. By default the link won't expire.

Returns:

this builder

withAudience

public SharedLinkSettings.Builder withAudience(LinkAudience audience)

Set value for optional field.

Parameters:

audience - The new audience who can benefit from the access level specified by the link's access level specified in the `link_access_level` field of `LinkPermissions`. This is used in conjunction with team policies and shared folder policies to determine the final effective audience type in the `effective_audience` field of `LinkPermissions.

Returns:

this builder

withAccess

public SharedLinkSettings.Builder withAccess(RequestedLinkAccessLevel access)

Set value for optional field.

Parameters:

access - Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported.

Returns:

this builder

withRequestedVisibility

public SharedLinkSettings.Builder withRequestedVisibility(RequestedVisibility requestedVisibility)

Set value for optional field.

Parameters:

requestedVisibility - Use SharedLinkSettings.getAudience() instead. The requested access for this shared link.

Returns:

this builder

withAllowDownload

public SharedLinkSettings.Builder withAllowDownload(java.lang.Boolean allowDownload)

Set value for optional field.

Parameters:

allowDownload - Boolean flag to allow or not download capabilities for shared links.

Returns:

this builder

build

public SharedLinkSettings build()

Builds an instance of SharedLinkSettings configured with this builder's values

Returns:

new instance of SharedLinkSettings