//readium-shared/org.readium.r2.shared.publication.services.search/SearchService
SearchService¶
[androidJvm]\ interface SearchService : Publication.Service
Provides a way to search terms in a publication.
Types¶
Name | Summary |
---|---|
Options | [androidJvm] 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. |
Functions¶
Name | Summary |
---|---|
close | [androidJvm] open override fun close() Closes any opened file handles, removes temporary files, etc. |
get | [androidJvm] open fun get(link: Link): Resource? A service can return a Resource to: |
search | [androidJvm] abstract suspend fun search(query: String, options: SearchService.Options? = null): SearchTry<SearchIterator> Starts a new search through the publication content, with the given query. |
Properties¶
Name | Summary |
---|---|
links | [androidJvm] open val links: List<Link> Links which will be added to Publication.links. It can be used to expose a web API for the service, through Publication.get. |
options | [androidJvm] abstract val options: SearchService.Options Default value for the search options of this service. |
Inheritors¶
Name |
---|
StringSearchService |