com.dropbox.core.v2.sharing

Class SharedFolderMetadata

java.lang.Object

com.dropbox.core.v2.sharing.SharedFolderMetadataBase

com.dropbox.core.v2.sharing.SharedFolderMetadata

public class SharedFolderMetadata
extends SharedFolderMetadataBase

The metadata which includes basic information about the shared folder.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	name
protected String	pathLower
protected List<FolderPermission>	permissions
protected String	previewUrl
protected String	sharedFolderId
protected Date	timeInvited

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

accessType, isTeamFolder, ownerTeam, parentSharedFolderId, policy

Constructor Summary

Constructors

Constructor and Description
SharedFolderMetadata(AccessLevel accessType, boolean isTeamFolder, FolderPolicy policy, String name, String sharedFolderId, Date timeInvited, String previewUrl) The metadata which includes basic information about the shared folder.
SharedFolderMetadata(AccessLevel accessType, boolean isTeamFolder, FolderPolicy policy, String name, String sharedFolderId, Date timeInvited, String previewUrl, Team ownerTeam, String parentSharedFolderId, String pathLower, List<FolderPermission> permissions) The metadata which includes basic information about the shared folder.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AccessLevel	getAccessType() The current user's access level for this shared folder.
boolean	getIsTeamFolder() Whether this folder is a team folder.
String	getName() The name of the this shared folder.
Team	getOwnerTeam() The team that owns the folder.
String	getParentSharedFolderId() The ID of the parent shared folder.
String	getPathLower() The lower-cased full path of this shared folder.
List<FolderPermission>	getPermissions() Actions the current user may perform on the folder and its contents.
FolderPolicy	getPolicy() Policies governing this shared folder.
String	getPreviewUrl() URL for displaying a web preview of the shared folder.
String	getSharedFolderId() The ID of the shared folder.
Date	getTimeInvited() Timestamp indicating when the current user was invited to this shared folder.
int	hashCode()
static SharedFolderMetadata.Builder	newBuilder(AccessLevel accessType, boolean isTeamFolder, FolderPolicy policy, String name, String sharedFolderId, Date timeInvited, String previewUrl) 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 com.dropbox.core.v2.sharing.SharedFolderMetadataBase

newBuilder

Methods inherited from class java.lang.Object

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

Field Detail

pathLower

protected final String pathLower

name

protected final String name

sharedFolderId

protected final String sharedFolderId

permissions

protected final List<FolderPermission> permissions

timeInvited

protected final Date timeInvited

previewUrl

protected final String previewUrl

Constructor Detail

SharedFolderMetadata

public SharedFolderMetadata(AccessLevel accessType,
                            boolean isTeamFolder,
                            FolderPolicy policy,
                            String name,
                            String sharedFolderId,
                            Date timeInvited,
                            String previewUrl,
                            Team ownerTeam,
                            String parentSharedFolderId,
                            String pathLower,
                            List<FolderPermission> permissions)

The metadata which includes basic information about the shared folder.

Use newBuilder to create instances of this class without specifying values for all optional fields.

Parameters:

accessType - The current user's access level for this shared folder. Must not be null.

isTeamFolder - Whether this folder is a team folder.

policy - Policies governing this shared folder. Must not be null.

name - The name of the this shared folder. Must not be null.

sharedFolderId - The ID of the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.

timeInvited - Timestamp indicating when the current user was invited to this shared folder. Must not be null.

previewUrl - URL for displaying a web preview of the shared folder. Must not be null.

ownerTeam - The team that owns the folder. This field is not present if the folder is not owned by a team.

parentSharedFolderId - The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. Must match pattern "[-_0-9a-zA-Z:]+".

pathLower - The lower-cased full path of this shared folder. Absent for unmounted folders.

permissions - Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request. Must not contain a null item.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

SharedFolderMetadata

public SharedFolderMetadata(AccessLevel accessType,
                            boolean isTeamFolder,
                            FolderPolicy policy,
                            String name,
                            String sharedFolderId,
                            Date timeInvited,
                            String previewUrl)

The metadata which includes basic information about the shared folder.

The default values for unset fields will be used.

Parameters:

accessType - The current user's access level for this shared folder. Must not be null.

isTeamFolder - Whether this folder is a team folder.

policy - Policies governing this shared folder. Must not be null.

name - The name of the this shared folder. Must not be null.

sharedFolderId - The ID of the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.

timeInvited - Timestamp indicating when the current user was invited to this shared folder. Must not be null.

previewUrl - URL for displaying a web preview of the shared folder. Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getAccessType

public AccessLevel getAccessType()

The current user's access level for this shared folder.

Overrides:

getAccessType in class SharedFolderMetadataBase

Returns:

value for this field, never null.

getIsTeamFolder

public boolean getIsTeamFolder()

Whether this folder is a team folder.

Overrides:

getIsTeamFolder in class SharedFolderMetadataBase

Returns:

value for this field.

getPolicy

public FolderPolicy getPolicy()

Policies governing this shared folder.

Overrides:

getPolicy in class SharedFolderMetadataBase

Returns:

value for this field, never null.

getName

public String getName()

The name of the this shared folder.

Returns:

value for this field, never null.

getSharedFolderId

public String getSharedFolderId()

The ID of the shared folder.

Returns:

value for this field, never null.

getTimeInvited

public Date getTimeInvited()

Timestamp indicating when the current user was invited to this shared folder.

Returns:

value for this field, never null.

getPreviewUrl

public String getPreviewUrl()

URL for displaying a web preview of the shared folder.

Returns:

value for this field, never null.

getOwnerTeam

public Team getOwnerTeam()

The team that owns the folder. This field is not present if the folder is not owned by a team.

Overrides:

getOwnerTeam in class SharedFolderMetadataBase

Returns:

value for this field, or null if not present.

getParentSharedFolderId

public String getParentSharedFolderId()

The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.

Overrides:

getParentSharedFolderId in class SharedFolderMetadataBase

Returns:

value for this field, or null if not present.

getPathLower

public String getPathLower()

The lower-cased full path of this shared folder. Absent for unmounted folders.

Returns:

value for this field, or null if not present.

getPermissions

public List<FolderPermission> getPermissions()

Actions the current user may perform on the folder and its contents. The set of permissions corresponds to the FolderActions in the request.

Returns:

value for this field, or null if not present.

newBuilder

public static SharedFolderMetadata.Builder newBuilder(AccessLevel accessType,
                                                      boolean isTeamFolder,
                                                      FolderPolicy policy,
                                                      String name,
                                                      String sharedFolderId,
                                                      Date timeInvited,
                                                      String previewUrl)

Returns a new builder for creating an instance of this class.

Parameters:

accessType - The current user's access level for this shared folder. Must not be null.

isTeamFolder - Whether this folder is a team folder.

policy - Policies governing this shared folder. Must not be null.

name - The name of the this shared folder. Must not be null.

sharedFolderId - The ID of the shared folder. Must match pattern "[-_0-9a-zA-Z:]+" and not be null.

timeInvited - Timestamp indicating when the current user was invited to this shared folder. Must not be null.

previewUrl - URL for displaying a web preview of the shared folder. 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 SharedFolderMetadataBase

equals

public boolean equals(Object obj)

Overrides:

equals in class SharedFolderMetadataBase

toString

public String toString()

Overrides:

toString in class SharedFolderMetadataBase

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 SharedFolderMetadataBase

Returns:

Formatted, multiline String representation of this object