biblekit/com.aarkaystudio.biblekit/BibleProvider

BibleProvider

class BibleProvider

Main provider class for accessing and searching Bible content. This class serves as the primary interface for retrieving verses and performing searches within the Bible database.

Features:

  • Full-text search with different search types (word, substring, prefix, suffix)

  • Verse retrieval by chapter, book, or specific verse IDs

  • Support for paginated results

  • Reference-based search scoping

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
suspend fun book(book: Book, limit: Long = Long.MAX_VALUE, offset: Long = Long.MIN_VALUE): List<Verse>

Retrieves all verses from a specific book of the Bible.

Link copied to clipboard
suspend fun chapter(chapter: ChapterReference, limit: Long = Long.MAX_VALUE, offset: Long = Long.MIN_VALUE): List<Verse>

Retrieves all verses from a specific chapter.

Link copied to clipboard
suspend fun search(query: String, reference: Reference, limit: Long = Long.MAX_VALUE, offset: Long = Long.MIN_VALUE): List<Verse>

Performs a text search within a specific range of verses defined by start and end verse IDs. This is a more direct way to search within a specific range compared to using Reference.

suspend fun search(query: String, verseIDs: List<VerseID>?, limit: Long = Long.MAX_VALUE, offset: Long = Long.MIN_VALUE): List<Verse>

Performs a text search across Bible verses with optional verse ID filtering. The search can be customized using different search types and supports pagination. If verseIDs is provided, the search will be limited to only those verses.

Link copied to clipboard
suspend fun verses(ids: List<VerseID>, limit: Long = Long.MAX_VALUE, offset: Long = Long.MIN_VALUE): List<Verse>

Retrieves specific verses by their IDs.