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 and Description
static class	SharedLinkSettings.Builder Builder for SharedLinkSettings.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SharedLinkSettings() None
SharedLinkSettings(RequestedVisibility requestedVisibility, java.lang.String linkPassword, java.util.Date expires, LinkAudience audience, RequestedLinkAccessLevel access) Use newBuilder to create instances of this class without specifying values for all optional fields.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
RequestedLinkAccessLevel	getAccess() Requested access level you want the audience to gain from this link.
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() If getRequestedVisibility() is RequestedVisibility.PASSWORD this is needed to specify the password to access the link.
RequestedVisibility	getRequestedVisibility() The requested access for this shared link.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

requestedVisibility

protected final RequestedVisibility requestedVisibility

linkPassword

protected final java.lang.String linkPassword

expires

protected final java.util.Date expires

audience

protected final LinkAudience audience

access

protected final RequestedLinkAccessLevel access

Constructor Detail

SharedLinkSettings

public SharedLinkSettings(RequestedVisibility requestedVisibility,
                          java.lang.String linkPassword,
                          java.util.Date expires,
                          LinkAudience audience,
                          RequestedLinkAccessLevel access)

Use newBuilder to create instances of this class without specifying values for all optional fields.

Parameters:

requestedVisibility - The requested access for this shared link.

linkPassword - If getRequestedVisibility() is RequestedVisibility.PASSWORD 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.

SharedLinkSettings

public SharedLinkSettings()

None

The default values for unset fields will be used.

Method Detail

getRequestedVisibility

public RequestedVisibility getRequestedVisibility()

The requested access for this shared link.

Returns:

value for this field, or null if not present.

getLinkPassword

public java.lang.String getLinkPassword()

If getRequestedVisibility() is RequestedVisibility.PASSWORD this is needed to specify the password to access the link.

Returns:

value for this field, or null if not present.

getExpires

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

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

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.

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 class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.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