Package com.dropbox.core.v2.files

Class PreviewResult

java.lang.Object

com.dropbox.core.v2.files.PreviewResult

public class PreviewResult
extends Object

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final FileMetadata	fileMetadata
protected final MinimalFileLinkMetadata	linkMetadata

Constructor Summary

Constructors

Constructor	Description
PreviewResult()	None
PreviewResult(FileMetadata fileMetadata, MinimalFileLinkMetadata linkMetadata)	Use newBuilder() to create instances of this class without specifying values for all optional fields.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
FileMetadata	getFileMetadata()	Metadata corresponding to the file received as an argument.
MinimalFileLinkMetadata	getLinkMetadata()	Minimal metadata corresponding to the file received as an argument.
int	hashCode()
static PreviewResult.Builder	newBuilder()	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 Details

fileMetadata

@Nullable
protected final FileMetadata fileMetadata

linkMetadata

@Nullable
protected final MinimalFileLinkMetadata linkMetadata

Constructor Details

PreviewResult

public PreviewResult(@Nullable
 FileMetadata fileMetadata,
 @Nullable
 MinimalFileLinkMetadata linkMetadata)

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

Parameters:

fileMetadata - Metadata corresponding to the file received as an argument. Will be populated if the endpoint is called with a path (ReadPath).

linkMetadata - Minimal metadata corresponding to the file received as an argument. Will be populated if the endpoint is called using a shared link (SharedLinkFileInfo).

PreviewResult

public PreviewResult()

None

The default values for unset fields will be used.

Method Details

getFileMetadata

@Nullable
public FileMetadata getFileMetadata()

Metadata corresponding to the file received as an argument. Will be populated if the endpoint is called with a path (ReadPath).

Returns:

value for this field, or null if not present.

getLinkMetadata

@Nullable
public MinimalFileLinkMetadata getLinkMetadata()

Minimal metadata corresponding to the file received as an argument. Will be populated if the endpoint is called using a shared link (SharedLinkFileInfo).

Returns:

value for this field, or null if not present.

newBuilder

public static PreviewResult.Builder newBuilder()

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

Returns:

builder for this class.

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