Package com.dropbox.core.v2.sharing
Class SharedContentLinkMetadata
- java.lang.Object
-
- com.dropbox.core.v2.sharing.SharedContentLinkMetadataBase
-
- com.dropbox.core.v2.sharing.SharedContentLinkMetadata
-
public class SharedContentLinkMetadata extends SharedContentLinkMetadataBase
Metadata of a shared link for a file or folder.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SharedContentLinkMetadata.Builder
Builder forSharedContentLinkMetadata
.
-
Field Summary
Fields Modifier and Type Field Description protected AudienceExceptions
audienceExceptions
protected java.lang.String
url
-
Fields inherited from class com.dropbox.core.v2.sharing.SharedContentLinkMetadataBase
accessLevel, audienceOptions, audienceRestrictingSharedFolder, currentAudience, expiry, linkPermissions, passwordProtected
-
-
Constructor Summary
Constructors Constructor Description SharedContentLinkMetadata(java.util.List<LinkAudience> audienceOptions, LinkAudience currentAudience, java.util.List<LinkPermission> linkPermissions, boolean passwordProtected, java.lang.String url)
Metadata of a shared link for a file or folder.SharedContentLinkMetadata(java.util.List<LinkAudience> audienceOptions, LinkAudience currentAudience, java.util.List<LinkPermission> linkPermissions, boolean passwordProtected, java.lang.String url, AccessLevel accessLevel, AudienceRestrictingSharedFolder audienceRestrictingSharedFolder, java.util.Date expiry, AudienceExceptions audienceExceptions)
Metadata of a shared link for a file or folder.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
AccessLevel
getAccessLevel()
The access level on the link for this file.AudienceExceptions
getAudienceExceptions()
The content inside this folder with link audience different than this folder's.java.util.List<LinkAudience>
getAudienceOptions()
The audience options that are available for the content.AudienceRestrictingSharedFolder
getAudienceRestrictingSharedFolder()
The shared folder that prevents the link audience for this link from being more restrictive.LinkAudience
getCurrentAudience()
The current audience of the link.java.util.Date
getExpiry()
Whether the link has an expiry set on it.java.util.List<LinkPermission>
getLinkPermissions()
A list of permissions for actions you can perform on the link.boolean
getPasswordProtected()
Whether the link is protected by a password.java.lang.String
getUrl()
The URL of the link.int
hashCode()
static SharedContentLinkMetadata.Builder
newBuilder(java.util.List<LinkAudience> audienceOptions, LinkAudience currentAudience, java.util.List<LinkPermission> linkPermissions, boolean passwordProtected, java.lang.String url)
Returns a new builder for creating an instance of this class.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.-
Methods inherited from class com.dropbox.core.v2.sharing.SharedContentLinkMetadataBase
newBuilder
-
-
-
-
Field Detail
-
audienceExceptions
@Nullable protected final AudienceExceptions audienceExceptions
-
url
@Nonnull protected final java.lang.String url
-
-
Constructor Detail
-
SharedContentLinkMetadata
public SharedContentLinkMetadata(@Nonnull java.util.List<LinkAudience> audienceOptions, @Nonnull LinkAudience currentAudience, @Nonnull java.util.List<LinkPermission> linkPermissions, boolean passwordProtected, @Nonnull java.lang.String url, @Nullable AccessLevel accessLevel, @Nullable AudienceRestrictingSharedFolder audienceRestrictingSharedFolder, @Nullable java.util.Date expiry, @Nullable AudienceExceptions audienceExceptions)
Metadata of a shared link for a file or folder.Use
newBuilder(java.util.List<com.dropbox.core.v2.sharing.LinkAudience>,com.dropbox.core.v2.sharing.LinkAudience,java.util.List<com.dropbox.core.v2.sharing.LinkPermission>,boolean,java.lang.String)
to create instances of this class without specifying values for all optional fields.- Parameters:
audienceOptions
- The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings. Must not contain anull
item and not benull
.currentAudience
- The current audience of the link. Must not benull
.linkPermissions
- A list of permissions for actions you can perform on the link. Must not contain anull
item and not benull
.passwordProtected
- Whether the link is protected by a password.url
- The URL of the link. Must not benull
.accessLevel
- The access level on the link for this file.audienceRestrictingSharedFolder
- The shared folder that prevents the link audience for this link from being more restrictive.expiry
- Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached.audienceExceptions
- The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
SharedContentLinkMetadata
public SharedContentLinkMetadata(@Nonnull java.util.List<LinkAudience> audienceOptions, @Nonnull LinkAudience currentAudience, @Nonnull java.util.List<LinkPermission> linkPermissions, boolean passwordProtected, @Nonnull java.lang.String url)
Metadata of a shared link for a file or folder.The default values for unset fields will be used.
- Parameters:
audienceOptions
- The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings. Must not contain anull
item and not benull
.currentAudience
- The current audience of the link. Must not benull
.linkPermissions
- A list of permissions for actions you can perform on the link. Must not contain anull
item and not benull
.passwordProtected
- Whether the link is protected by a password.url
- The URL of the link. Must not benull
.- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
-
Method Detail
-
getAudienceOptions
@Nonnull public java.util.List<LinkAudience> getAudienceOptions()
The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings.- Overrides:
getAudienceOptions
in classSharedContentLinkMetadataBase
- Returns:
- value for this field, never
null
.
-
getCurrentAudience
@Nonnull public LinkAudience getCurrentAudience()
The current audience of the link.- Overrides:
getCurrentAudience
in classSharedContentLinkMetadataBase
- Returns:
- value for this field, never
null
.
-
getLinkPermissions
@Nonnull public java.util.List<LinkPermission> getLinkPermissions()
A list of permissions for actions you can perform on the link.- Overrides:
getLinkPermissions
in classSharedContentLinkMetadataBase
- Returns:
- value for this field, never
null
.
-
getPasswordProtected
public boolean getPasswordProtected()
Whether the link is protected by a password.- Overrides:
getPasswordProtected
in classSharedContentLinkMetadataBase
- Returns:
- value for this field.
-
getUrl
@Nonnull public java.lang.String getUrl()
The URL of the link.- Returns:
- value for this field, never
null
.
-
getAccessLevel
@Nullable public AccessLevel getAccessLevel()
The access level on the link for this file.- Overrides:
getAccessLevel
in classSharedContentLinkMetadataBase
- Returns:
- value for this field, or
null
if not present.
-
getAudienceRestrictingSharedFolder
@Nullable public AudienceRestrictingSharedFolder getAudienceRestrictingSharedFolder()
The shared folder that prevents the link audience for this link from being more restrictive.- Overrides:
getAudienceRestrictingSharedFolder
in classSharedContentLinkMetadataBase
- Returns:
- value for this field, or
null
if not present.
-
getExpiry
@Nullable public java.util.Date getExpiry()
Whether the link has an expiry set on it. A link with an expiry will have its audience changed to members when the expiry is reached.- Overrides:
getExpiry
in classSharedContentLinkMetadataBase
- Returns:
- value for this field, or
null
if not present.
-
getAudienceExceptions
@Nullable public AudienceExceptions getAudienceExceptions()
The content inside this folder with link audience different than this folder's. This is only returned when an endpoint that returns metadata for a single shared folder is called, e.g. /get_folder_metadata.- Returns:
- value for this field, or
null
if not present.
-
newBuilder
public static SharedContentLinkMetadata.Builder newBuilder(java.util.List<LinkAudience> audienceOptions, LinkAudience currentAudience, java.util.List<LinkPermission> linkPermissions, boolean passwordProtected, java.lang.String url)
Returns a new builder for creating an instance of this class.- Parameters:
audienceOptions
- The audience options that are available for the content. Some audience options may be unavailable. For example, team_only may be unavailable if the content is not owned by a user on a team. The 'default' audience option is always available if the user can modify link settings. Must not contain anull
item and not benull
.currentAudience
- The current audience of the link. Must not benull
.linkPermissions
- A list of permissions for actions you can perform on the link. Must not contain anull
item and not benull
.passwordProtected
- Whether the link is protected by a password.url
- The URL of the link. Must not benull
.- Returns:
- builder for this class.
- Throws:
java.lang.IllegalArgumentException
- If any argument does not meet its preconditions.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classSharedContentLinkMetadataBase
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classSharedContentLinkMetadataBase
-
toString
public java.lang.String toString()
- Overrides:
toString
in classSharedContentLinkMetadataBase
-
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 classSharedContentLinkMetadataBase
- Returns:
- Formatted, multiline String representation of this object
-
-