Package 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	Description
static class	SharedFolderMetadata.Builder	Builder for SharedFolderMetadata.

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessInheritance	accessInheritance
protected SharedContentLinkMetadata	linkMetadata
protected java.lang.String	name
protected java.util.List<FolderPermission>	permissions
protected FolderPolicy	policy
protected java.lang.String	previewUrl
protected java.lang.String	sharedFolderId
protected java.util.Date	timeInvited

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

accessType, isInsideTeamFolder, isTeamFolder, ownerDisplayNames, ownerTeam, parentFolderName, parentSharedFolderId, pathDisplay, pathLower

Constructor Summary

Constructors

Constructor	Description
SharedFolderMetadata(AccessLevel accessType, boolean isInsideTeamFolder, boolean isTeamFolder, java.lang.String name, FolderPolicy policy, java.lang.String previewUrl, java.lang.String sharedFolderId, java.util.Date timeInvited)	The metadata which includes basic information about the shared folder.
SharedFolderMetadata(AccessLevel accessType, boolean isInsideTeamFolder, boolean isTeamFolder, java.lang.String name, FolderPolicy policy, java.lang.String previewUrl, java.lang.String sharedFolderId, java.util.Date timeInvited, java.util.List<java.lang.String> ownerDisplayNames, Team ownerTeam, java.lang.String parentSharedFolderId, java.lang.String pathDisplay, java.lang.String pathLower, java.lang.String parentFolderName, SharedContentLinkMetadata linkMetadata, java.util.List<FolderPermission> permissions, AccessInheritance accessInheritance)	The metadata which includes basic information about the shared folder.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
AccessInheritance	getAccessInheritance()	Whether the folder inherits its members from its parent.
AccessLevel	getAccessType()	The current user's access level for this shared folder.
boolean	getIsInsideTeamFolder()	Whether this folder is inside of a team folder.
boolean	getIsTeamFolder()	Whether this folder is a team folder.
SharedContentLinkMetadata	getLinkMetadata()	The metadata of the shared content link to this shared folder.
java.lang.String	getName()	The name of the this shared folder.
java.util.List<java.lang.String>	getOwnerDisplayNames()	The display names of the users that own the folder.
Team	getOwnerTeam()	The team that owns the folder.
java.lang.String	getParentFolderName()	Display name for the parent folder.
java.lang.String	getParentSharedFolderId()	The ID of the parent shared folder.
java.lang.String	getPathDisplay()	The full path of this shared folder.
java.lang.String	getPathLower()	The lower-cased full path of this shared folder.
java.util.List<FolderPermission>	getPermissions()	Actions the current user may perform on the folder and its contents.
FolderPolicy	getPolicy()	Policies governing this shared folder.
java.lang.String	getPreviewUrl()	URL for displaying a web preview of the shared folder.
java.lang.String	getSharedFolderId()	The ID of the shared folder.
java.util.Date	getTimeInvited()	Timestamp indicating when the current user was invited to this shared folder.
int	hashCode()
static SharedFolderMetadata.Builder	newBuilder(AccessLevel accessType, boolean isInsideTeamFolder, boolean isTeamFolder, java.lang.String name, FolderPolicy policy, java.lang.String previewUrl, java.lang.String sharedFolderId, java.util.Date timeInvited)	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.SharedFolderMetadataBase

newBuilder

Methods inherited from class java.lang.Object

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

Field Detail

linkMetadata

@Nullable
protected final SharedContentLinkMetadata linkMetadata

name

@Nonnull
protected final java.lang.String name

permissions

@Nullable
protected final java.util.List<FolderPermission> permissions

policy

@Nonnull
protected final FolderPolicy policy

previewUrl

@Nonnull
protected final java.lang.String previewUrl

sharedFolderId

@Nonnull
protected final java.lang.String sharedFolderId

timeInvited

@Nonnull
protected final java.util.Date timeInvited

accessInheritance

@Nonnull
protected final AccessInheritance accessInheritance

Constructor Detail

SharedFolderMetadata

public SharedFolderMetadata(@Nonnull
                            AccessLevel accessType,
                            boolean isInsideTeamFolder,
                            boolean isTeamFolder,
                            @Nonnull
                            java.lang.String name,
                            @Nonnull
                            FolderPolicy policy,
                            @Nonnull
                            java.lang.String previewUrl,
                            @Nonnull
                            java.lang.String sharedFolderId,
                            @Nonnull
                            java.util.Date timeInvited,
                            @Nullable
                            java.util.List<java.lang.String> ownerDisplayNames,
                            @Nullable
                            Team ownerTeam,
                            @Nullable
                            java.lang.String parentSharedFolderId,
                            @Nullable
                            java.lang.String pathDisplay,
                            @Nullable
                            java.lang.String pathLower,
                            @Nullable
                            java.lang.String parentFolderName,
                            @Nullable
                            SharedContentLinkMetadata linkMetadata,
                            @Nullable
                            java.util.List<FolderPermission> permissions,
                            @Nonnull
                            AccessInheritance accessInheritance)

The metadata which includes basic information about the shared folder.

Use newBuilder(com.dropbox.core.v2.sharing.AccessLevel,boolean,boolean,java.lang.String,com.dropbox.core.v2.sharing.FolderPolicy,java.lang.String,java.lang.String,java.util.Date) 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.

isInsideTeamFolder - Whether this folder is inside of a team folder.

isTeamFolder - Whether this folder is a team folder.

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

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

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

ownerDisplayNames - The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched. Must not contain a null item.

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:]+".

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

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

parentFolderName - Display name for the parent folder.

linkMetadata - The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet.

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.

accessInheritance - Whether the folder inherits its members from its parent. Must not be null.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

SharedFolderMetadata

public SharedFolderMetadata(@Nonnull
                            AccessLevel accessType,
                            boolean isInsideTeamFolder,
                            boolean isTeamFolder,
                            @Nonnull
                            java.lang.String name,
                            @Nonnull
                            FolderPolicy policy,
                            @Nonnull
                            java.lang.String previewUrl,
                            @Nonnull
                            java.lang.String sharedFolderId,
                            @Nonnull
                            java.util.Date timeInvited)

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.

isInsideTeamFolder - Whether this folder is inside of a team folder.

isTeamFolder - Whether this folder is a team folder.

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

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

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

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getAccessType

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

getIsInsideTeamFolder

public boolean getIsInsideTeamFolder()

Whether this folder is inside of a team folder.

Overrides:

getIsInsideTeamFolder in class SharedFolderMetadataBase

Returns:

value for this field.

getIsTeamFolder

public boolean getIsTeamFolder()

Whether this folder is a team folder.

Overrides:

getIsTeamFolder in class SharedFolderMetadataBase

Returns:

value for this field.

getName

@Nonnull
public java.lang.String getName()

The name of the this shared folder.

Returns:

value for this field, never null.

getPolicy

@Nonnull
public FolderPolicy getPolicy()

Policies governing this shared folder.

Returns:

value for this field, never null.

getPreviewUrl

@Nonnull
public java.lang.String getPreviewUrl()

URL for displaying a web preview of the shared folder.

Returns:

value for this field, never null.

getSharedFolderId

@Nonnull
public java.lang.String getSharedFolderId()

The ID of the shared folder.

Returns:

value for this field, never null.

getTimeInvited

@Nonnull
public java.util.Date getTimeInvited()

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

Returns:

value for this field, never null.

getOwnerDisplayNames

@Nullable
public java.util.List<java.lang.String> getOwnerDisplayNames()

The display names of the users that own the folder. If the folder is part of a team folder, the display names of the team admins are also included. Absent if the owner display names cannot be fetched.

Overrides:

getOwnerDisplayNames in class SharedFolderMetadataBase

Returns:

value for this field, or null if not present.

getOwnerTeam

@Nullable
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

@Nullable
public java.lang.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.

getPathDisplay

@Nullable
public java.lang.String getPathDisplay()

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

Overrides:

getPathDisplay in class SharedFolderMetadataBase

Returns:

value for this field, or null if not present.

getPathLower

@Nullable
public java.lang.String getPathLower()

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

Overrides:

getPathLower in class SharedFolderMetadataBase

Returns:

value for this field, or null if not present.

getParentFolderName

@Nullable
public java.lang.String getParentFolderName()

Display name for the parent folder.

Overrides:

getParentFolderName in class SharedFolderMetadataBase

Returns:

value for this field, or null if not present.

getLinkMetadata

@Nullable
public SharedContentLinkMetadata getLinkMetadata()

The metadata of the shared content link to this shared folder. Absent if there is no link on the folder. This is for an unreleased feature so it may not be returned yet.

Returns:

value for this field, or null if not present.

getPermissions

@Nullable
public java.util.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.

getAccessInheritance

@Nonnull
public AccessInheritance getAccessInheritance()

Whether the folder inherits its members from its parent.

Returns:

value for this field, or null if not present. Defaults to AccessInheritance.INHERIT.

newBuilder

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

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.

isInsideTeamFolder - Whether this folder is inside of a team folder.

isTeamFolder - Whether this folder is a team folder.

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

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

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

Returns:

builder for this class.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

hashCode

public int hashCode()

Overrides:

hashCode in class SharedFolderMetadataBase

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class SharedFolderMetadataBase

toString

public java.lang.String toString()

Overrides:

toString in class SharedFolderMetadataBase

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 class SharedFolderMetadataBase

Returns:

Formatted, multiline String representation of this object