com.dropbox.core.v2.sharing

Class ListFoldersResult

java.lang.Object

com.dropbox.core.v2.sharing.ListFoldersResult

public class ListFoldersResult
extends Object

Result for DbxUserSharingRequests.listFolders(com.dropbox.core.v2.sharing.ListFoldersArgs) or DbxUserSharingRequests.listMountableFolders(com.dropbox.core.v2.sharing.ListFoldersArgs), depending on which endpoint was requested. Unmounted shared folders can be identified by the absence of SharedFolderMetadata.getPathLower().

Field Summary

Fields

Modifier and Type	Field and Description
protected String	cursor
protected List<SharedFolderMetadata>	entries

Constructor Summary

Constructors

Constructor and Description
ListFoldersResult(List<SharedFolderMetadata> entries) Result for DbxUserSharingRequests.listFolders(com.dropbox.core.v2.sharing.ListFoldersArgs) or DbxUserSharingRequests.listMountableFolders(com.dropbox.core.v2.sharing.ListFoldersArgs), depending on which endpoint was requested.
ListFoldersResult(List<SharedFolderMetadata> entries, String cursor) Result for DbxUserSharingRequests.listFolders(com.dropbox.core.v2.sharing.ListFoldersArgs) or DbxUserSharingRequests.listMountableFolders(com.dropbox.core.v2.sharing.ListFoldersArgs), depending on which endpoint was requested.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCursor() Present if there are additional shared folders that have not been returned yet.
List<SharedFolderMetadata>	getEntries() List of all shared folders the authenticated user has access to.
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 Detail

entries

protected final List<SharedFolderMetadata> entries

cursor

protected final String cursor

Constructor Detail

ListFoldersResult

public ListFoldersResult(List<SharedFolderMetadata> entries,
                         String cursor)

Result for DbxUserSharingRequests.listFolders(com.dropbox.core.v2.sharing.ListFoldersArgs) or DbxUserSharingRequests.listMountableFolders(com.dropbox.core.v2.sharing.ListFoldersArgs), depending on which endpoint was requested. Unmounted shared folders can be identified by the absence of SharedFolderMetadata.getPathLower().

Parameters:

entries - List of all shared folders the authenticated user has access to. Must not contain a null item and not be null.

cursor - Present if there are additional shared folders that have not been returned yet. Pass the cursor into the corresponding continue endpoint (either DbxUserSharingRequests.listFoldersContinue(String) or DbxUserSharingRequests.listMountableFoldersContinue(String)) to list additional folders.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

ListFoldersResult

public ListFoldersResult(List<SharedFolderMetadata> entries)

Result for DbxUserSharingRequests.listFolders(com.dropbox.core.v2.sharing.ListFoldersArgs) or DbxUserSharingRequests.listMountableFolders(com.dropbox.core.v2.sharing.ListFoldersArgs), depending on which endpoint was requested. Unmounted shared folders can be identified by the absence of SharedFolderMetadata.getPathLower().

The default values for unset fields will be used.

Parameters:

entries - List of all shared folders the authenticated user has access to. Must not contain a null item and not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getEntries

public List<SharedFolderMetadata> getEntries()

List of all shared folders the authenticated user has access to.

Returns:

value for this field, never null.

getCursor

public String getCursor()

Present if there are additional shared folders that have not been returned yet. Pass the cursor into the corresponding continue endpoint (either DbxUserSharingRequests.listFoldersContinue(String) or DbxUserSharingRequests.listMountableFoldersContinue(String)) to list additional folders.

Returns:

value for this field, or null if not present.

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