Package com.dropbox.core.v2.paper

Class ListPaperDocsResponse

java.lang.Object

com.dropbox.core.v2.paper.ListPaperDocsResponse

public class ListPaperDocsResponse
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final Cursor	cursor
protected final List<String>	docIds
protected final boolean	hasMore

Constructor Summary

Constructors

Constructor	Description
ListPaperDocsResponse(List<String> docIds, Cursor cursor, boolean hasMore)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Cursor	getCursor()	Pass the cursor into DbxUserPaperRequests.docsListContinue(String) to paginate through all files.
List<String>	getDocIds()	The list of Paper doc IDs that can be used to access the given Paper docs or supplied to other API methods.
boolean	getHasMore()	Will be set to True if a subsequent call with the provided cursor to DbxUserPaperRequests.docsListContinue(String) returns immediately with some results.
int	hashCode()
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

docIds

@Nonnull
protected final List<String> docIds

cursor

@Nonnull
protected final Cursor cursor

hasMore

protected final boolean hasMore

Constructor Details

ListPaperDocsResponse

public ListPaperDocsResponse(@Nonnull
 List<String> docIds,
 @Nonnull
 Cursor cursor,
 boolean hasMore)

Parameters:

docIds - The list of Paper doc IDs that can be used to access the given Paper docs or supplied to other API methods. The list is sorted in the order specified by the initial call to DbxUserPaperRequests.docsList(com.dropbox.core.v2.paper.ListPaperDocsArgs). Must not contain a null item and not be null.

cursor - Pass the cursor into DbxUserPaperRequests.docsListContinue(String) to paginate through all files. The cursor preserves all properties as specified in the original call to DbxUserPaperRequests.docsList(com.dropbox.core.v2.paper.ListPaperDocsArgs). Must not be null.

hasMore - Will be set to True if a subsequent call with the provided cursor to DbxUserPaperRequests.docsListContinue(String) returns immediately with some results. If set to False please allow some delay before making another call to DbxUserPaperRequests.docsListContinue(String).

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Details

getDocIds

@Nonnull
public List<String> getDocIds()

The list of Paper doc IDs that can be used to access the given Paper docs or supplied to other API methods. The list is sorted in the order specified by the initial call to DbxUserPaperRequests.docsList(com.dropbox.core.v2.paper.ListPaperDocsArgs).

Returns:

value for this field, never null.

getCursor

@Nonnull
public Cursor getCursor()

Pass the cursor into DbxUserPaperRequests.docsListContinue(String) to paginate through all files. The cursor preserves all properties as specified in the original call to DbxUserPaperRequests.docsList(com.dropbox.core.v2.paper.ListPaperDocsArgs).

Returns:

value for this field, never null.

getHasMore

public boolean getHasMore()

Will be set to True if a subsequent call with the provided cursor to DbxUserPaperRequests.docsListContinue(String) returns immediately with some results. If set to False please allow some delay before making another call to DbxUserPaperRequests.docsListContinue(String).

Returns:

value for this field.

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