com.dropbox.core.v2.sharing

Class FolderLinkMetadata

java.lang.Object

com.dropbox.core.v2.sharing.SharedLinkMetadata

com.dropbox.core.v2.sharing.FolderLinkMetadata

public class FolderLinkMetadata
extends SharedLinkMetadata

The metadata of a folder shared link

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.dropbox.core.v2.sharing.SharedLinkMetadata

contentOwnerTeamInfo, expires, id, linkPermissions, name, pathLower, teamMemberInfo, url

Constructor Summary

Constructors

Constructor and Description
FolderLinkMetadata(String url, String name, LinkPermissions linkPermissions) The metadata of a folder shared link
FolderLinkMetadata(String url, String name, LinkPermissions linkPermissions, String id, Date expires, String pathLower, TeamMemberInfo teamMemberInfo, Team contentOwnerTeamInfo) The metadata of a folder 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 FolderLinkMetadata.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

Constructor Detail

FolderLinkMetadata

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

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

FolderLinkMetadata

public FolderLinkMetadata(String url,
                          String name,
                          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:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getUrl

public String getUrl()

URL of the shared link.

Overrides:

getUrl in class SharedLinkMetadata

Returns:

value for this field, never null.

getName

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

public LinkPermissions getLinkPermissions()

The link's access permissions.

Overrides:

getLinkPermissions in class SharedLinkMetadata

Returns:

value for this field, never null.

getId

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

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

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.

Overrides:

getPathLower in class SharedLinkMetadata

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.

Overrides:

getTeamMemberInfo in class SharedLinkMetadata

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.

Overrides:

getContentOwnerTeamInfo in class SharedLinkMetadata

Returns:

value for this field, or null if not present.

newBuilder

public static FolderLinkMetadata.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 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