HighlightSearchResultsParams.Builder

public final class HighlightSearchResultsParams.Builder

A builder for constructing HighlightSearchResultsParams instances.

Summary

Public constructors

Public methods
final @NonNull HighlightSearchResultsParams

Builds the HighlightSearchResultsParams object specified by this builder.
final @NonNull HighlightSearchResultsParams.Builder
setHighlightSearchTextQuery(@NonNull String highlightSearchTextQuery)

Sets the text query string used for highlighting media search results.
final @NonNull HighlightSearchResultsParams.Builder
setHighlightType(int highlightType)

Sets the requested highlight type specifying how the highlighted search results will be displayed.

Public constructors

Builder

Added in 1.0.0-alpha03
public Builder()

Public methods

build

Added in 1.0.0-alpha03
public final @NonNull HighlightSearchResultsParams build()

Builds the HighlightSearchResultsParams object specified by this builder.

Returns
@NonNull HighlightSearchResultsParams

The newly constructed HighlightSearchResultsParams instance.
Throws
IllegalArgumentException

if highlightType is not set, or if highlightSearchTextQuery is not set or blank.

setHighlightSearchTextQuery

Added in 1.0.0-alpha03
public final @NonNull HighlightSearchResultsParams.Builder setHighlightSearchTextQuery(@NonNull String highlightSearchTextQuery)

Sets the text query string used for highlighting media search results. It should not be empty or null.

Parameters
@NonNull String highlightSearchTextQuery

Input string query for highlighting media results.
Returns
@NonNull HighlightSearchResultsParams.Builder

This Builder.

setHighlightType

Added in 1.0.0-alpha03
public final @NonNull HighlightSearchResultsParams.Builder setHighlightType(int highlightType)

Sets the requested highlight type specifying how the highlighted search results will be displayed.

Parameters
int highlightType

A supported highlight type from HighlightType.
Returns
@NonNull HighlightSearchResultsParams.Builder

This Builder.