Package com.dropbox.core.v2.sharing

Class SharedLinkSettings

java.lang.Object
com.dropbox.core.v2.sharing.SharedLinkSettings
public class SharedLinkSettings extends Object

  • Field Details

    • requirePassword

      @Nullable protected final Boolean requirePassword

    • linkPassword

      @Nullable protected final String linkPassword

    • expires

      @Nullable protected final Date expires

    • audience

      @Nullable protected final LinkAudience audience

    • access

      @Nullable protected final RequestedLinkAccessLevel access

    • requestedVisibility

      @Nullable protected final RequestedVisibility requestedVisibility

    • allowDownload

      @Nullable protected final Boolean allowDownload

  • Constructor Details

    • SharedLinkSettings

      public SharedLinkSettings(@Nullable Boolean requirePassword, @Nullable String linkPassword, @Nullable Date expires, @Nullable LinkAudience audience, @Nullable RequestedLinkAccessLevel access, @Nullable RequestedVisibility requestedVisibility, @Nullable Boolean allowDownload)
      Use newBuilder() to create instances of this class without specifying values for all optional fields.
      Parameters:
      requirePassword - Boolean flag to enable or disable password protection.
      linkPassword - If getRequirePassword() 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 - Field is deprecated. Use getAudience() instead. The requested access for this shared link.
      allowDownload - Boolean flag to allow or not download capabilities for shared links.

    • SharedLinkSettings

      public SharedLinkSettings()
      None

      The default values for unset fields will be used.

  • Method Details

    • getRequirePassword

      @Nullable public Boolean getRequirePassword()
      Boolean flag to enable or disable password protection.
      Returns:
      value for this field, or null if not present.

    • getLinkPassword

      @Nullable public String getLinkPassword()
      If getRequirePassword() 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 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

      @Deprecated @Nullable public RequestedVisibility getRequestedVisibility()
      Deprecated.
      Field is deprecated. Use getAudience() instead. The requested access for this shared link.
      Returns:
      value for this field, or null if not present.

    • getAllowDownload

      @Nullable public 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 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