com.dropbox.core.v2.files

Class ListRevisionsBuilder

java.lang.Object

com.dropbox.core.v2.files.ListRevisionsBuilder

public class ListRevisionsBuilder
extends java.lang.Object

The request builder returned by DbxUserFilesRequests.listRevisionsBuilder(java.lang.String).

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

Method Summary

Modifier and Type	Method and Description
ListRevisionsResult	start() Issues the request.
ListRevisionsBuilder	withLimit(java.lang.Long limit) Set value for optional field.
ListRevisionsBuilder	withMode(ListRevisionsMode mode) 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

withMode

public ListRevisionsBuilder withMode(ListRevisionsMode mode)

Set value for optional field.

If left unset or set to null, defaults to ListRevisionsMode.PATH.

Parameters:

mode - Determines the behavior of the API in listing the revisions for a given file path or id. Must not be null. Defaults to ListRevisionsMode.PATH when set to null.

Returns:

this builder

Throws:

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

withLimit

public ListRevisionsBuilder withLimit(java.lang.Long limit)

Set value for optional field.

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

Parameters:

limit - The maximum number of revision entries returned. Must be greater than or equal to 1 and be less than or equal to 100. Defaults to 10L when set to null.

Returns:

this builder

Throws:

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

start

public ListRevisionsResult start()
                          throws ListRevisionsErrorException,
                                 DbxException

Issues the request.

Throws:

ListRevisionsErrorException

DbxException