nutrient/com.pspdfkit.document.library/QueryOptions

QueryOptions

open class QueryOptions

Detailed options for querying the FTS database.

Types

Link copied to clipboard
class Builder
Builder used to construct QueryOptions instance.

Properties

Link copied to clipboard
val maximumPreviewResultsPerDocument: Int
Maximum number of preview results per document.
Link copied to clipboard
val maximumPreviewResultsTotal: Int
Maximum total number of preview results.
Link copied to clipboard
val maximumSearchResultsPerDocument: Int
Maximum number of search results per document.
Link copied to clipboard
val maximumSearchResultsTotal: Int
Maximum total number of search results.
Link copied to clipboard
val previewRange: Range
The range used for preview text generation.

Functions

Link copied to clipboard
open fun shouldGenerateTextPreviews(): Boolean
Indicates whether text previews should be generated.
Link copied to clipboard
open fun shouldIgnoreAnnotations(): Boolean
Indicates whether annotations should be ignored when querying.
Link copied to clipboard
open fun shouldIgnoreDocumentText(): Boolean
Indicates whether document text should be ignored when querying.
Link copied to clipboard
open fun shouldMatchExactPhrases(): Boolean
Indicates whether exact phrases should be matched.
Link copied to clipboard
open fun shouldMatchExactWords(): Boolean
Indicates whether exact words should be matched when searching.
Generated by Dokka
© 2026 Copyright