com.dropbox.core.v2.files

Class SearchBuilder

java.lang.Object

com.dropbox.core.v2.files.SearchBuilder

public class SearchBuilder
extends Object

The request builder returned by DbxUserFilesRequests.searchBuilder(String,String).

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

Method Summary

Modifier and Type	Method and Description
SearchResult	start() Issues the request.
SearchBuilder	withMaxResults(Long maxResults) Set value for optional field.
SearchBuilder	withMode(SearchMode mode) Set value for optional field.
SearchBuilder	withStart(Long start) 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

withStart

public SearchBuilder withStart(Long start)

Set value for optional field.

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

Parameters:

start - The starting index within the search results (used for paging). Defaults to 0L when set to null.

Returns:

this builder

withMaxResults

public SearchBuilder withMaxResults(Long maxResults)

Set value for optional field.

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

Parameters:

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

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withMode

public SearchBuilder withMode(SearchMode mode)

Set value for optional field.

If left unset or set to null, defaults to SearchMode.FILENAME.

Parameters:

mode - The search mode (filename, filename_and_content, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts. Defaults to SearchMode.FILENAME when set to null.

Returns:

this builder

start

public SearchResult start()
                   throws SearchErrorException,
                          DbxException

Issues the request.

Throws:

SearchErrorException

DbxException