pspdfkit/com.pspdfkit.document.library/QueryOptions/Builder

Builder

class Builder

Builder used to construct QueryOptions instance.

By default the number of returned search results is limited to 500 to limit possible search time. Use maximumPreviewResultsTotal and maximumSearchResultsTotal to change this default.

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
@NonNull
open fun build(): QueryOptions
Builds query options.
Link copied to clipboard
@NonNull
open fun generateTextPreviews(generatePreviews: Boolean): QueryOptions.Builder
Enables generation of search preview snippets.
Link copied to clipboard
@NonNull
open fun ignoreAnnotations(ignoreAnnotations: Boolean): QueryOptions.Builder
Prevents querying of indexed annotations.
Link copied to clipboard
@NonNull
open fun ignoreDocumentText(ignoreDocumentText: Boolean): QueryOptions.Builder
Prevents querying of indexed document text.
Link copied to clipboard
@NonNull
open fun matchExactPhrases(matchExactPhrases: Boolean): QueryOptions.Builder
Enables exact phrase matching.
Link copied to clipboard
@NonNull
open fun matchExactWords(matchExactWords: Boolean): QueryOptions.Builder
Enables exact word matching.
Link copied to clipboard
@NonNull
open fun maximumPreviewResultsPerDocument(maximumPreviewResultsPerDocument: Int): QueryOptions.Builder
Sets a limit of preview results in each document.
Link copied to clipboard
@NonNull
open fun maximumPreviewResultsTotal(maximumPreviewResultsTotal: Int): QueryOptions.Builder
Sets a limit of all preview results.
Link copied to clipboard
@NonNull
open fun maximumSearchResultsPerDocument(maximumSearchResultsPerDocument: Int): QueryOptions.Builder
Sets a limit of search results in each document.
Link copied to clipboard
@NonNull
open fun maximumSearchResultsTotal(maximumSearchResultsTotal: Int): QueryOptions.Builder
Sets a limit of all search results.
Link copied to clipboard
@NonNull
open fun previewRange(start: Int, length: Int): QueryOptions.Builder
Sets range for the preview generated.