com.dropbox.core.v2.sharing

Class ListFoldersBuilder

java.lang.Object

com.dropbox.core.v2.sharing.ListFoldersBuilder

public class ListFoldersBuilder
extends java.lang.Object

The request builder returned by DbxUserSharingRequests.listFoldersBuilder().

Use this class to set optional request parameters and complete the request.

Method Summary

Modifier and Type	Method and Description
ListFoldersResult	start() Issues the request.
ListFoldersBuilder	withActions(java.util.List<FolderAction> actions) Set value for optional field.
ListFoldersBuilder	withLimit(java.lang.Long limit) Set value for optional field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withLimit

public ListFoldersBuilder withLimit(java.lang.Long limit)

Set value for optional field.

If left unset or set to null, defaults to 1000L.

Parameters:

limit - The maximum number of results to return per request. Must be greater than or equal to 1 and be less than or equal to 1000. Defaults to 1000L when set to null.

Returns:

this builder

Throws:

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

withActions

public ListFoldersBuilder withActions(java.util.List<FolderAction> actions)

Set value for optional field.

Parameters:

actions - A list of `FolderAction`s corresponding to `FolderPermission`s that should appear in the response's SharedFolderMetadata.getPermissions() field describing the actions the authenticated user can perform on the folder. Must not contain a null item.

Returns:

this builder

Throws:

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

start

public ListFoldersResult start()
                        throws DbxApiException,
                               DbxException

Issues the request.

Throws:

DbxApiException

DbxException