Package com.dropbox.core.v2.sharing

Class LinkAudienceOption

java.lang.Object

com.dropbox.core.v2.sharing.LinkAudienceOption

public class LinkAudienceOption
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	allowed
protected final LinkAudience	audience
protected final LinkAudienceDisallowedReason	disallowedReason

Constructor Summary

Constructors

Constructor	Description
LinkAudienceOption(LinkAudience audience, boolean allowed)	None
LinkAudienceOption(LinkAudience audience, boolean allowed, LinkAudienceDisallowedReason disallowedReason)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	getAllowed()	Whether the user calling this API can select this audience option.
LinkAudience	getAudience()	Specifies who can access the link.
LinkAudienceDisallowedReason	getDisallowedReason()	If getAllowed() is false, this will provide the reason that the user is not permitted to set the visibility to this policy.
int	hashCode()
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

audience

@Nonnull
protected final LinkAudience audience

allowed

protected final boolean allowed

disallowedReason

@Nullable
protected final LinkAudienceDisallowedReason disallowedReason

Constructor Details

LinkAudienceOption

public LinkAudienceOption(@Nonnull
 LinkAudience audience,
 boolean allowed,
 @Nullable
 LinkAudienceDisallowedReason disallowedReason)

Parameters:

audience - Specifies who can access the link. Must not be null.

allowed - Whether the user calling this API can select this audience option.

disallowedReason - If getAllowed() is false, this will provide the reason that the user is not permitted to set the visibility to this policy.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

LinkAudienceOption

public LinkAudienceOption(@Nonnull
 LinkAudience audience,
 boolean allowed)

None

The default values for unset fields will be used.

Parameters:

audience - Specifies who can access the link. Must not be null.

allowed - Whether the user calling this API can select this audience option.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Details

getAudience

@Nonnull
public LinkAudience getAudience()

Specifies who can access the link.

Returns:

value for this field, never null.

getAllowed

public boolean getAllowed()

Whether the user calling this API can select this audience option.

Returns:

value for this field.

getDisallowedReason

@Nullable
public LinkAudienceDisallowedReason getDisallowedReason()

If getAllowed() is false, this will provide the reason that the user is not permitted to set the visibility to this policy.

Returns:

value for this field, or null if not present.

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