Package com.dropbox.core.v2.sharing

Class SharedFileMetadata.Builder

java.lang.Object
com.dropbox.core.v2.sharing.SharedFileMetadata.Builder
Enclosing class:
SharedFileMetadata
public static class SharedFileMetadata.Builder extends Object
Builder for SharedFileMetadata.

  • Field Details

  • Constructor Details

  • Method Details

    • withAccessType

      public SharedFileMetadata.Builder withAccessType(AccessLevel accessType)
      Set value for optional field.
      Parameters:
      accessType - The current user's access level for this shared file.
      Returns:
      this builder

    • withExpectedLinkMetadata

      public SharedFileMetadata.Builder withExpectedLinkMetadata(ExpectedSharedContentLinkMetadata expectedLinkMetadata)
      Set value for optional field.
      Parameters:
      expectedLinkMetadata - The expected metadata of the link associated for the file when it is first shared. Absent if the link already exists. This is for an unreleased feature so it may not be returned yet.
      Returns:
      this builder

    • withLinkMetadata

      public SharedFileMetadata.Builder withLinkMetadata(SharedContentLinkMetadata linkMetadata)
      Set value for optional field.
      Parameters:
      linkMetadata - The metadata of the link associated for the file. This is for an unreleased feature so it may not be returned yet.
      Returns:
      this builder

    • withOwnerDisplayNames

      public SharedFileMetadata.Builder withOwnerDisplayNames(List<String> ownerDisplayNames)
      Set value for optional field.
      Parameters:
      ownerDisplayNames - The display names of the users that own the file. If the file is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. Must not contain a null item.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withOwnerTeam

      public SharedFileMetadata.Builder withOwnerTeam(Team ownerTeam)
      Set value for optional field.
      Parameters:
      ownerTeam - The team that owns the file. This field is not present if the file is not owned by a team.
      Returns:
      this builder

    • withParentSharedFolderId

      public SharedFileMetadata.Builder withParentSharedFolderId(String parentSharedFolderId)
      Set value for optional field.
      Parameters:
      parentSharedFolderId - The ID of the parent shared folder. This field is present only if the file is contained within a shared folder. Must match pattern "[-_0-9a-zA-Z:]+".
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withPathDisplay

      public SharedFileMetadata.Builder withPathDisplay(String pathDisplay)
      Set value for optional field.
      Parameters:
      pathDisplay - The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files.
      Returns:
      this builder

    • withPathLower

      public SharedFileMetadata.Builder withPathLower(String pathLower)
      Set value for optional field.
      Parameters:
      pathLower - The lower-case full path of this file. Absent for unmounted files.
      Returns:
      this builder

    • withPermissions

      public SharedFileMetadata.Builder withPermissions(List<FilePermission> permissions)
      Set value for optional field.
      Parameters:
      permissions - The sharing permissions that requesting user has on this file. This corresponds to the entries given in the actions argument to DbxUserSharingRequests.getFileMetadataBatch(List,List) or the actions argument to DbxUserSharingRequests.getFileMetadata(String,List). Must not contain a null item.
      Returns:
      this builder
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • withTimeInvited

      public SharedFileMetadata.Builder withTimeInvited(Date timeInvited)
      Set value for optional field.
      Parameters:
      timeInvited - Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent.
      Returns:
      this builder

    • build

      public SharedFileMetadata build()
      Builds an instance of SharedFileMetadata configured with this builder's values
      Returns:
      new instance of SharedFileMetadata