Package com.dropbox.core.v2.sharing

Class ListReceivedFilesBuilder

java.lang.Object

com.dropbox.core.v2.sharing.ListReceivedFilesBuilder

public class ListReceivedFilesBuilder
extends Object

The request builder returned by DbxUserSharingRequests.listReceivedFilesBuilder().

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

Method Summary

Modifier and Type	Method	Description
ListFilesResult	start()	Issues the request.
ListReceivedFilesBuilder	withActions(List<FileAction> actions)	Set value for optional field.
ListReceivedFilesBuilder	withLimit(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 Details

withLimit

public ListReceivedFilesBuilder withLimit(Long limit)

Set value for optional field.

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

Parameters:

limit - Number of files to return max per query. Defaults to 100 if no limit is specified. Must be greater than or equal to 1 and be less than or equal to 300. Defaults to 100L when set to null.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withActions

public ListReceivedFilesBuilder withActions(List<FileAction> actions)

Set value for optional field.

Parameters:

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

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

start

public ListFilesResult start()
                      throws SharingUserErrorException,
DbxException

Issues the request.

Throws:

SharingUserErrorException

DbxException