Options

data class Options(val caseSensitive: Boolean? = null, val diacriticSensitive: Boolean? = null, val wholeWord: Boolean? = null, val exact: Boolean? = null, val language: String? = null, val regularExpression: Boolean? = null, val otherOptions: Map<String, String> = emptyMap()) : Parcelable

Holds the available search options and their current values.

Parameters

caseSensitive

Whether the search will differentiate between capital and lower-case letters.

diacriticSensitive

Whether the search will differentiate between letters with accents or not.

wholeWord

Whether the query terms will match full words and not parts of a word.

exact

Matches results exactly as stated in the query terms, taking into account stop words, order and spelling.

language

BCP 47 language code overriding the publication's language.

regularExpression

The search string is treated as a regular expression. The particular flavor of regex depends on the service.

otherOptions

Map of custom options implemented by a Search Service which are not officially recognized by Readium.

Constructors

Link copied to clipboard
constructor(caseSensitive: Boolean? = null, diacriticSensitive: Boolean? = null, wholeWord: Boolean? = null, exact: Boolean? = null, language: String? = null, regularExpression: Boolean? = null, otherOptions: Map<String, String> = emptyMap())

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
operator fun get(key: String): String?

Syntactic sugar to access the otherOptions values by subscripting Options directly.

Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)