Class FolderLinkMetadata


  • public class FolderLinkMetadata
    extends SharedLinkMetadata
    The metadata of a folder shared link.
    • Constructor Detail

      • FolderLinkMetadata

        public FolderLinkMetadata​(@Nonnull
                                  java.lang.String url,
                                  @Nonnull
                                  java.lang.String name,
                                  @Nonnull
                                  LinkPermissions linkPermissions,
                                  @Nullable
                                  java.lang.String id,
                                  @Nullable
                                  java.util.Date expires,
                                  @Nullable
                                  java.lang.String pathLower,
                                  @Nullable
                                  TeamMemberInfo teamMemberInfo,
                                  @Nullable
                                  Team contentOwnerTeamInfo)
        The metadata of a folder shared link.

        Use newBuilder(java.lang.String,java.lang.String,com.dropbox.core.v2.sharing.LinkPermissions) to create instances of this class without specifying values for all optional fields.

        Parameters:
        url - URL of the shared link. Must not be null.
        name - The linked file name (including extension). This never contains a slash. Must not be null.
        linkPermissions - The link's access permissions. Must not be null.
        id - A unique identifier for the linked file. Must have length of at least 1.
        expires - Expiration time, if set. By default the link won't expire.
        pathLower - The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox.
        teamMemberInfo - The team membership information of the link's owner. This field will only be present if the link's owner is a team member.
        contentOwnerTeamInfo - The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
      • FolderLinkMetadata

        public FolderLinkMetadata​(@Nonnull
                                  java.lang.String url,
                                  @Nonnull
                                  java.lang.String name,
                                  @Nonnull
                                  LinkPermissions linkPermissions)
        The metadata of a folder shared link.

        The default values for unset fields will be used.

        Parameters:
        url - URL of the shared link. Must not be null.
        name - The linked file name (including extension). This never contains a slash. Must not be null.
        linkPermissions - The link's access permissions. Must not be null.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
    • Method Detail

      • getUrl

        @Nonnull
        public java.lang.String getUrl()
        URL of the shared link.
        Overrides:
        getUrl in class SharedLinkMetadata
        Returns:
        value for this field, never null.
      • getName

        @Nonnull
        public java.lang.String getName()
        The linked file name (including extension). This never contains a slash.
        Overrides:
        getName in class SharedLinkMetadata
        Returns:
        value for this field, never null.
      • getId

        @Nullable
        public java.lang.String getId()
        A unique identifier for the linked file.
        Overrides:
        getId in class SharedLinkMetadata
        Returns:
        value for this field, or null if not present.
      • getExpires

        @Nullable
        public java.util.Date getExpires()
        Expiration time, if set. By default the link won't expire.
        Overrides:
        getExpires in class SharedLinkMetadata
        Returns:
        value for this field, or null if not present.
      • getPathLower

        @Nullable
        public java.lang.String getPathLower()
        The lowercased full path in the user's Dropbox. This always starts with a slash. This field will only be present only if the linked file is in the authenticated user's dropbox.
        Overrides:
        getPathLower in class SharedLinkMetadata
        Returns:
        value for this field, or null if not present.
      • getTeamMemberInfo

        @Nullable
        public TeamMemberInfo getTeamMemberInfo()
        The team membership information of the link's owner. This field will only be present if the link's owner is a team member.
        Overrides:
        getTeamMemberInfo in class SharedLinkMetadata
        Returns:
        value for this field, or null if not present.
      • getContentOwnerTeamInfo

        @Nullable
        public Team getContentOwnerTeamInfo()
        The team information of the content's owner. This field will only be present if the content's owner is a team member and the content's owner team is different from the link's owner team.
        Overrides:
        getContentOwnerTeamInfo in class SharedLinkMetadata
        Returns:
        value for this field, or null if not present.
      • newBuilder

        public static FolderLinkMetadata.Builder newBuilder​(java.lang.String url,
                                                            java.lang.String name,
                                                            LinkPermissions linkPermissions)
        Returns a new builder for creating an instance of this class.
        Parameters:
        url - URL of the shared link. Must not be null.
        name - The linked file name (including extension). This never contains a slash. Must not be null.
        linkPermissions - The link's access permissions. Must not be null.
        Returns:
        builder for this class.
        Throws:
        java.lang.IllegalArgumentException - If any argument does not meet its preconditions.
      • toStringMultiline

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

        The returned String may contain newlines.

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