Package com.dropbox.core.v2.sharing
Class SharedLinkSettings
- java.lang.Object
-
- com.dropbox.core.v2.sharing.SharedLinkSettings
-
public class SharedLinkSettings extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SharedLinkSettings.Builder
Builder forSharedLinkSettings
.
-
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 Constructor Description SharedLinkSettings()
NoneSharedLinkSettings(java.lang.Boolean requirePassword, java.lang.String linkPassword, java.util.Date expires, LinkAudience audience, RequestedLinkAccessLevel access, RequestedVisibility requestedVisibility, java.lang.Boolean allowDownload)
UsenewBuilder()
to create instances of this class without specifying values for all optional fields.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
RequestedLinkAccessLevel
getAccess()
Requested access level you want the audience to gain from this link.java.lang.Boolean
getAllowDownload()
Boolean flag to allow or not download capabilities for shared links.LinkAudience
getAudience()
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`.java.util.Date
getExpires()
Expiration time of the shared link.java.lang.String
getLinkPassword()
IfgetRequirePassword()
is true, this is needed to specify the password to access the link.RequestedVisibility
getRequestedVisibility()
UsegetAudience()
instead.java.lang.Boolean
getRequirePassword()
Boolean flag to enable or disable password protection.int
hashCode()
static SharedLinkSettings.Builder
newBuilder()
Returns a new builder for creating an instance of this class.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
requirePassword
@Nullable protected final java.lang.Boolean requirePassword
-
linkPassword
@Nullable protected final java.lang.String linkPassword
-
expires
@Nullable protected final java.util.Date expires
-
audience
@Nullable protected final LinkAudience audience
-
access
@Nullable protected final RequestedLinkAccessLevel access
-
requestedVisibility
@Nullable protected final RequestedVisibility requestedVisibility
-
allowDownload
@Nullable protected final java.lang.Boolean allowDownload
-
-
Constructor Detail
-
SharedLinkSettings
public SharedLinkSettings(@Nullable java.lang.Boolean requirePassword, @Nullable java.lang.String linkPassword, @Nullable java.util.Date expires, @Nullable LinkAudience audience, @Nullable RequestedLinkAccessLevel access, @Nullable RequestedVisibility requestedVisibility, @Nullable java.lang.Boolean allowDownload)
UsenewBuilder()
to create instances of this class without specifying values for all optional fields.- Parameters:
requirePassword
- Boolean flag to enable or disable password protection.linkPassword
- IfgetRequirePassword()
is true, this is needed to specify the password to access the link.expires
- Expiration time of the shared link. By default the link won't expire.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.access
- Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported.requestedVisibility
- UsegetAudience()
instead. The requested access for this shared link.allowDownload
- Boolean flag to allow or not download capabilities for shared links.
-
SharedLinkSettings
public SharedLinkSettings()
NoneThe default values for unset fields will be used.
-
-
Method Detail
-
getRequirePassword
@Nullable public java.lang.Boolean getRequirePassword()
Boolean flag to enable or disable password protection.- Returns:
- value for this field, or
null
if not present.
-
getLinkPassword
@Nullable public java.lang.String getLinkPassword()
IfgetRequirePassword()
is true, this is needed to specify the password to access the link.- Returns:
- value for this field, or
null
if not present.
-
getExpires
@Nullable public java.util.Date getExpires()
Expiration time of the shared link. By default the link won't expire.- Returns:
- value for this field, or
null
if not present.
-
getAudience
@Nullable public LinkAudience getAudience()
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:
- value for this field, or
null
if not present.
-
getAccess
@Nullable public RequestedLinkAccessLevel getAccess()
Requested access level you want the audience to gain from this link. Note, modifying access level for an existing link is not supported.- Returns:
- value for this field, or
null
if not present.
-
getRequestedVisibility
@Nullable public RequestedVisibility getRequestedVisibility()
UsegetAudience()
instead. The requested access for this shared link.- Returns:
- value for this field, or
null
if not present.
-
getAllowDownload
@Nullable public java.lang.Boolean getAllowDownload()
Boolean flag to allow or not download capabilities for shared links.- Returns:
- value for this field, or
null
if not present.
-
newBuilder
public static SharedLinkSettings.Builder newBuilder()
Returns a new builder for creating an instance of this class.- Returns:
- builder for this class.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
toStringMultiline
public java.lang.String toStringMultiline()
Returns a String representation of this object formatted for easier readability.The returned String may contain newlines.
- Returns:
- Formatted, multiline String representation of this object
-
-