com.dropbox.core.v2.sharing

Class SharedFileMetadata

java.lang.Object

com.dropbox.core.v2.sharing.SharedFileMetadata

public class SharedFileMetadata
extends Object

Properties of the shared file.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id
protected String	name
protected Team	ownerTeam
protected String	parentSharedFolderId
protected String	pathDisplay
protected String	pathLower
protected List<FilePermission>	permissions
protected FolderPolicy	policy
protected String	previewUrl
protected Date	timeInvited

Constructor Summary

Constructors

Constructor and Description
SharedFileMetadata(FolderPolicy policy, String previewUrl, String name, String id) Properties of the shared file.
SharedFileMetadata(FolderPolicy policy, String previewUrl, String name, String id, List<FilePermission> permissions, Team ownerTeam, String parentSharedFolderId, String pathLower, String pathDisplay, Date timeInvited) Properties of the shared file.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getId() The ID of the file.
String	getName() The name of this file.
Team	getOwnerTeam() The team that owns the file.
String	getParentSharedFolderId() The ID of the parent shared folder.
String	getPathDisplay() The cased path to be used for display purposes only.
String	getPathLower() The lower-case full path of this file.
List<FilePermission>	getPermissions() The sharing permissions that requesting user has on this file.
FolderPolicy	getPolicy() Policies governing this shared file.
String	getPreviewUrl() URL for displaying a web preview of the shared file.
Date	getTimeInvited() Timestamp indicating when the current user was invited to this shared file.
int	hashCode()
static SharedFileMetadata.Builder	newBuilder(FolderPolicy policy, String previewUrl, String name, String id) 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

policy

protected final FolderPolicy policy

permissions

protected final List<FilePermission> permissions

ownerTeam

protected final Team ownerTeam

parentSharedFolderId

protected final String parentSharedFolderId

previewUrl

protected final String previewUrl

pathLower

protected final String pathLower

pathDisplay

protected final String pathDisplay

name

protected final String name

id

protected final String id

timeInvited

protected final Date timeInvited

Constructor Detail

SharedFileMetadata

public SharedFileMetadata(FolderPolicy policy,
                          String previewUrl,
                          String name,
                          String id,
                          List<FilePermission> permissions,
                          Team ownerTeam,
                          String parentSharedFolderId,
                          String pathLower,
                          String pathDisplay,
                          Date timeInvited)

Properties of the shared file.

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

Parameters:

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

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

name - The name of this file. Must not be null.

id - The ID of the file. Must have length of at least 1, match pattern "id:.*", and not be null.

permissions - The sharing permissions that requesting user has on this file. This corresponds to the entries given in the actions argument to DbxUserSharingRequests.getFileMetadataBatch(List,List) or the actions argument to DbxUserSharingRequests.getFileMetadata(String,List). Must not contain a null item.

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

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

pathLower - The lower-case full path of this file. Absent for unmounted files.

pathDisplay - The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files.

timeInvited - Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

SharedFileMetadata

public SharedFileMetadata(FolderPolicy policy,
                          String previewUrl,
                          String name,
                          String id)

Properties of the shared file.

The default values for unset fields will be used.

Parameters:

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

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

name - The name of this file. Must not be null.

id - The ID of the file. Must have length of at least 1, match pattern "id:.*", and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getPolicy

public FolderPolicy getPolicy()

Policies governing this shared file.

Returns:

value for this field, never null.

getPreviewUrl

public String getPreviewUrl()

URL for displaying a web preview of the shared file.

Returns:

value for this field, never null.

getName

public String getName()

The name of this file.

Returns:

value for this field, never null.

getId

public String getId()

The ID of the file.

Returns:

value for this field, never null.

getPermissions

public List<FilePermission> getPermissions()

The sharing permissions that requesting user has on this file. This corresponds to the entries given in the actions argument to DbxUserSharingRequests.getFileMetadataBatch(List,List) or the actions argument to DbxUserSharingRequests.getFileMetadata(String,List).

Returns:

value for this field, or null if not present.

getOwnerTeam

public Team getOwnerTeam()

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

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 file is contained within a shared folder.

Returns:

value for this field, or null if not present.

getPathLower

public String getPathLower()

The lower-case full path of this file. Absent for unmounted files.

Returns:

value for this field, or null if not present.

getPathDisplay

public String getPathDisplay()

The cased path to be used for display purposes only. In rare instances the casing will not correctly match the user's filesystem, but this behavior will match the path provided in the Core API v1. Absent for unmounted files.

Returns:

value for this field, or null if not present.

getTimeInvited

public Date getTimeInvited()

Timestamp indicating when the current user was invited to this shared file. If the user was not invited to the shared file, the timestamp will indicate when the user was invited to the parent shared folder. This value may be absent.

Returns:

value for this field, or null if not present.

newBuilder

public static SharedFileMetadata.Builder newBuilder(FolderPolicy policy,
                                                    String previewUrl,
                                                    String name,
                                                    String id)

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

Parameters:

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

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

name - The name of this file. Must not be null.

id - The ID of the file. Must have length of at least 1, match pattern "id:.*", and 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