com.dropbox.core.v2.sharing

Class SharedLinkMetadata

java.lang.Object

com.dropbox.core.v2.sharing.SharedLinkMetadata

Direct Known Subclasses:

FileLinkMetadata, FolderLinkMetadata

public class SharedLinkMetadata
extends Object

The metadata of a shared link

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SharedLinkMetadata.Builder Builder for SharedLinkMetadata.

Field Summary

Fields

Modifier and Type	Field and Description
protected Team	contentOwnerTeamInfo
protected Date	expires
protected String	id
protected LinkPermissions	linkPermissions
protected String	name
protected String	pathLower
protected TeamMemberInfo	teamMemberInfo
protected String	url

Constructor Summary

Constructors

Constructor and Description
SharedLinkMetadata(String url, String name, LinkPermissions linkPermissions) The metadata of a shared link
SharedLinkMetadata(String url, String name, LinkPermissions linkPermissions, String id, Date expires, String pathLower, TeamMemberInfo teamMemberInfo, Team contentOwnerTeamInfo) The metadata of a shared link

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Team	getContentOwnerTeamInfo() The team information of the content's owner.
Date	getExpires() Expiration time, if set.
String	getId() A unique identifier for the linked file.
LinkPermissions	getLinkPermissions() The link's access permissions.
String	getName() The linked file name (including extension).
String	getPathLower() The lowercased full path in the user's Dropbox.
TeamMemberInfo	getTeamMemberInfo() The team membership information of the link's owner.
String	getUrl() URL of the shared link.
int	hashCode()
static SharedLinkMetadata.Builder	newBuilder(String url, String name, LinkPermissions linkPermissions) Returns a new builder for creating an instance of this class.
String	toString()
String	toStringMultiline() Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

url

protected final String url

id

protected final String id

name

protected final String name

expires

protected final Date expires

pathLower

protected final String pathLower

linkPermissions

protected final LinkPermissions linkPermissions

teamMemberInfo

protected final TeamMemberInfo teamMemberInfo

contentOwnerTeamInfo

protected final Team contentOwnerTeamInfo

Constructor Detail

SharedLinkMetadata

public SharedLinkMetadata(String url,
                          String name,
                          LinkPermissions linkPermissions,
                          String id,
                          Date expires,
                          String pathLower,
                          TeamMemberInfo teamMemberInfo,
                          Team contentOwnerTeamInfo)

The metadata of a shared link

Use newBuilder 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:

IllegalArgumentException - If any argument does not meet its preconditions.

SharedLinkMetadata

public SharedLinkMetadata(String url,
                          String name,
                          LinkPermissions linkPermissions)

The metadata of a 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:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getUrl

public String getUrl()

URL of the shared link.

Returns:

value for this field, never null.

getName

public String getName()

The linked file name (including extension). This never contains a slash.

Returns:

value for this field, never null.

getLinkPermissions

public LinkPermissions getLinkPermissions()

The link's access permissions.

Returns:

value for this field, never null.

getId

public String getId()

A unique identifier for the linked file.

Returns:

value for this field, or null if not present.

getExpires

public Date getExpires()

Expiration time, if set. By default the link won't expire.

Returns:

value for this field, or null if not present.

getPathLower

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.

Returns:

value for this field, or null if not present.

getTeamMemberInfo

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.

Returns:

value for this field, or null if not present.

getContentOwnerTeamInfo

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.

Returns:

value for this field, or null if not present.

newBuilder

public static SharedLinkMetadata.Builder newBuilder(String url,
                                                    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:

IllegalArgumentException - If any argument does not meet its preconditions.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Returns:

Formatted, multiline String representation of this object