Package com.dropbox.core.v2.files

Class FolderSharingInfo

java.lang.Object
com.dropbox.core.v2.files.SharingInfo
com.dropbox.core.v2.files.FolderSharingInfo
public class FolderSharingInfo extends SharingInfo
Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.

  • Field Details

    • parentSharedFolderId

      @Nullable protected final String parentSharedFolderId

    • sharedFolderId

      @Nullable protected final String sharedFolderId

    • traverseOnly

      protected final boolean traverseOnly

    • noAccess

      protected final boolean noAccess

  • Constructor Details

    • FolderSharingInfo

      public FolderSharingInfo(boolean readOnly, @Nullable String parentSharedFolderId, @Nullable String sharedFolderId, boolean traverseOnly, boolean noAccess)
      Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.

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

      Parameters:
      readOnly - True if the file or folder is inside a read-only shared folder.
      parentSharedFolderId - Set if the folder is contained by a shared folder. Must match pattern "[-_0-9a-zA-Z:]+".
      sharedFolderId - If this folder is a shared folder mount point, the ID of the shared folder mounted at this location. Must match pattern "[-_0-9a-zA-Z:]+".
      traverseOnly - Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder.
      noAccess - Specifies that the folder cannot be accessed by the user.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • FolderSharingInfo

      public FolderSharingInfo(boolean readOnly)
      Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.

      The default values for unset fields will be used.

      Parameters:
      readOnly - True if the file or folder is inside a read-only shared folder.

  • Method Details

    • getReadOnly

      public boolean getReadOnly()
      True if the file or folder is inside a read-only shared folder.
      Overrides:
      getReadOnly in class SharingInfo
      Returns:
      value for this field.

    • getParentSharedFolderId

      @Nullable public String getParentSharedFolderId()
      Set if the folder is contained by a shared folder.
      Returns:
      value for this field, or null if not present.

    • getSharedFolderId

      @Nullable public String getSharedFolderId()
      If this folder is a shared folder mount point, the ID of the shared folder mounted at this location.
      Returns:
      value for this field, or null if not present.

    • getTraverseOnly

      public boolean getTraverseOnly()
      Specifies that the folder can only be traversed and the user can only see a limited subset of the contents of this folder because they don't have read access to this folder. They do, however, have access to some sub folder.
      Returns:
      value for this field, or null if not present. Defaults to false.

    • getNoAccess

      public boolean getNoAccess()
      Specifies that the folder cannot be accessed by the user.
      Returns:
      value for this field, or null if not present. Defaults to false.

    • newBuilder

      public static FolderSharingInfo.Builder newBuilder(boolean readOnly)
      Returns a new builder for creating an instance of this class.
      Parameters:
      readOnly - True if the file or folder is inside a read-only shared folder.
      Returns:
      builder for this class.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class SharingInfo

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class SharingInfo

    • toString

      public String toString()
      Overrides:
      toString in class SharingInfo

    • toStringMultiline

      public String toStringMultiline()
      Returns a String representation of this object formatted for easier readability.

      The returned String may contain newlines.

      Overrides:
      toStringMultiline in class SharingInfo
      Returns:
      Formatted, multiline String representation of this object