Package com.dropbox.core.v2.sharing

Class LinkSettings

java.lang.Object

com.dropbox.core.v2.sharing.LinkSettings

public class LinkSettings
extends Object

Settings that apply to a link.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LinkSettings.Builder	Builder for LinkSettings.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AccessLevel	accessLevel
protected final LinkAudience	audience
protected final LinkExpiry	expiry
protected final LinkPassword	password

Constructor Summary

Constructors

Constructor	Description
LinkSettings()	Settings that apply to a link.
LinkSettings(AccessLevel accessLevel, LinkAudience audience, LinkExpiry expiry, LinkPassword password)	Settings that apply to a link.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
AccessLevel	getAccessLevel()	The access level on the link for this file.
LinkAudience	getAudience()	The type of audience on the link for this file.
LinkExpiry	getExpiry()	An expiry timestamp to set on a link.
LinkPassword	getPassword()	The password for the link.
int	hashCode()
static LinkSettings.Builder	newBuilder()	Returns a new builder for creating an instance of this class.
String	toString()
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 Details

accessLevel

@Nullable
protected final AccessLevel accessLevel

audience

@Nullable
protected final LinkAudience audience

expiry

@Nullable
protected final LinkExpiry expiry

password

@Nullable
protected final LinkPassword password

Constructor Details

LinkSettings

public LinkSettings(@Nullable
 AccessLevel accessLevel,
 @Nullable
 LinkAudience audience,
 @Nullable
 LinkExpiry expiry,
 @Nullable
 LinkPassword password)

Settings that apply to a link.

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

Parameters:

accessLevel - The access level on the link for this file. Currently, it only accepts 'viewer' and 'viewer_no_comment'.

audience - The type of audience on the link for this file.

expiry - An expiry timestamp to set on a link.

password - The password for the link.

LinkSettings

public LinkSettings()

Settings that apply to a link.

The default values for unset fields will be used.

Method Details

getAccessLevel

@Nullable
public AccessLevel getAccessLevel()

The access level on the link for this file. Currently, it only accepts 'viewer' and 'viewer_no_comment'.

Returns:

value for this field, or null if not present.

getAudience

@Nullable
public LinkAudience getAudience()

The type of audience on the link for this file.

Returns:

value for this field, or null if not present.

getExpiry

@Nullable
public LinkExpiry getExpiry()

An expiry timestamp to set on a link.

Returns:

value for this field, or null if not present.

getPassword

@Nullable
public LinkPassword getPassword()

The password for the link.

Returns:

value for this field, or null if not present.

newBuilder

public static LinkSettings.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 Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public 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