com.dropbox.core.v2.files

Class SearchV2Builder

java.lang.Object

com.dropbox.core.v2.files.SearchV2Builder

public class SearchV2Builder
extends java.lang.Object

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

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

Method Summary

Modifier and Type	Method and Description
SearchV2Result	start() Issues the request.
SearchV2Builder	withIncludeHighlights(java.lang.Boolean includeHighlights) Set value for optional field.
SearchV2Builder	withMatchFieldOptions(SearchMatchFieldOptions matchFieldOptions) Set value for optional field.
SearchV2Builder	withOptions(SearchOptions options) 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

withOptions

public SearchV2Builder withOptions(SearchOptions options)

Set value for optional field.

Parameters:

options - Options for more targeted search results.

Returns:

this builder

withMatchFieldOptions

public SearchV2Builder withMatchFieldOptions(SearchMatchFieldOptions matchFieldOptions)

Set value for optional field.

Parameters:

matchFieldOptions - Options for search results match fields.

Returns:

this builder

withIncludeHighlights

public SearchV2Builder withIncludeHighlights(java.lang.Boolean includeHighlights)

Set value for optional field.

If left unset or set to null, defaults to false.

Parameters:

includeHighlights - Deprecated and moved this option to SearchMatchFieldOptions. Defaults to false when set to null.

Returns:

this builder

start

public SearchV2Result start()
                     throws SearchErrorException,
                            DbxException

Issues the request.

Throws:

SearchErrorException

DbxException