Package com.dropbox.core.v2.sharing

Class FileLinkMetadata

java.lang.Object
com.dropbox.core.v2.sharing.SharedLinkMetadata
com.dropbox.core.v2.sharing.FileLinkMetadata
public class FileLinkMetadata extends SharedLinkMetadata
The metadata of a file shared link.

  • Field Details

    • clientModified

      @Nonnull protected final Date clientModified

    • serverModified

      @Nonnull protected final Date serverModified

    • rev

      @Nonnull protected final String rev

    • size

      protected final long size

  • Constructor Details

    • FileLinkMetadata

      public FileLinkMetadata(@Nonnull String url, @Nonnull String name, @Nonnull LinkPermissions linkPermissions, @Nonnull Date clientModified, @Nonnull Date serverModified, @Nonnull String rev, long size, @Nullable String id, @Nullable Date expires, @Nullable String pathLower, @Nullable TeamMemberInfo teamMemberInfo, @Nullable Team contentOwnerTeamInfo)
      The metadata of a file shared link.

      Use newBuilder(java.lang.String,java.lang.String,com.dropbox.core.v2.sharing.LinkPermissions,java.util.Date,java.util.Date,java.lang.String,long) 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.
      clientModified - The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not. Must not be null.
      serverModified - The last time the file was modified on Dropbox. Must not be null.
      rev - A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts. Must have length of at least 9, match pattern "[0-9a-f]+", and not be null.
      size - The file size in bytes.
      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 and the user is the owner of the link.
      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:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • FileLinkMetadata

      public FileLinkMetadata(@Nonnull String url, @Nonnull String name, @Nonnull LinkPermissions linkPermissions, @Nonnull Date clientModified, @Nonnull Date serverModified, @Nonnull String rev, long size)
      The metadata of a file 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.
      clientModified - The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not. Must not be null.
      serverModified - The last time the file was modified on Dropbox. Must not be null.
      rev - A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts. Must have length of at least 9, match pattern "[0-9a-f]+", and not be null.
      size - The file size in bytes.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

  • Method Details

    • getUrl

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

    • getName

      @Nonnull public 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.

    • getLinkPermissions

      @Nonnull public LinkPermissions getLinkPermissions()
      The link's access permissions.
      Overrides:
      getLinkPermissions in class SharedLinkMetadata
      Returns:
      value for this field, never null.

    • getClientModified

      @Nonnull public Date getClientModified()
      The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not.
      Returns:
      value for this field, never null.

    • getServerModified

      @Nonnull public Date getServerModified()
      The last time the file was modified on Dropbox.
      Returns:
      value for this field, never null.

    • getRev

      @Nonnull public String getRev()
      A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts.
      Returns:
      value for this field, never null.

    • getSize

      public long getSize()
      The file size in bytes.
      Returns:
      value for this field.

    • getId

      @Nullable public 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 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 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 and the user is the owner of the link.
      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 FileLinkMetadata.Builder newBuilder(String url, String name, LinkPermissions linkPermissions, Date clientModified, Date serverModified, String rev, long size)
      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.
      clientModified - The modification time set by the desktop client when the file was added to Dropbox. Since this time is not verified (the Dropbox server stores whatever the desktop client sends up), this should only be used for display purposes (such as sorting) and not, for example, to determine if a file has changed or not. Must not be null.
      serverModified - The last time the file was modified on Dropbox. Must not be null.
      rev - A unique identifier for the current revision of a file. This field is the same rev as elsewhere in the API and can be used to detect changes and avoid conflicts. Must have length of at least 9, match pattern "[0-9a-f]+", and not be null.
      size - The file size in bytes.
      Returns:
      builder for this class.
      Throws:
      IllegalArgumentException - If any argument does not meet its preconditions.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class SharedLinkMetadata

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class SharedLinkMetadata

    • 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 SharedLinkMetadata
      Returns:
      Formatted, multiline String representation of this object