QuranService class

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

getAllSurahs() List<SurahMetadata>
Get metadata for all 114 surahs.
getAudioUrl(int surah, int ayah, {String? reciterIdentifier}) String
Generate an audio URL for a specific ayah and reciter.
getAyah(int surahNumber, int ayahNumber, {QuranLanguage language = QuranLanguage.arabic}) Ayah
Get a single ayah.
getJuz(int juzNumber, {QuranLanguage language = QuranLanguage.arabic}) List<Ayah>
Get all ayahs in a specific Juz (1-30).
getJuzNumber(int surahNumber, int ayahNumber, {QuranLanguage language = QuranLanguage.arabic}) int?
The juz number for a given ayah.
getPage(int pageNumber, {QuranLanguage language = QuranLanguage.arabic}) List<Ayah>
Get all ayahs on a specific page (1-604).
getPageData(int pageNumber) List<Map<String, int>>
Raw page segments for a page (surah/start/end).
getPageNumber(int surahNumber, int ayahNumber, {QuranLanguage language = QuranLanguage.arabic}) int?
The page number for a given ayah.
getPlaceOfRevelation(int surahNumber) String?
Get the place of revelation for a surah ("Meccan" or "Medinan").
getRubIndex(int surahNumber, int ayahNumber) int?
The 1-based rub index for a given ayah, or null if not a boundary.
getSurah(int surahNumber, {QuranLanguage language = QuranLanguage.arabic}) Surah
Get a full surah.
getSurahMetadata(int surahNumber) SurahMetadata
Get metadata for a specific surah.
getSurahNameArabic(int surahNumber) String
Get the Arabic name of a surah.
getSurahNameEnglish(int surahNumber) String
Get the English name of a surah.
getTafsir(int surahNumber, {QuranLanguage language = QuranLanguage.arabic}) Map<int, String>
Get the tafsir for a surah (Arabic only; returns empty map for English).
getVerseCount(int surahNumber) int
Get the ayah count for a surah.
getVersesByPage(int pageNumber, {QuranLanguage language = QuranLanguage.arabic}) List<Ayah>
Alias for getPage.
getVersesBySurah(int surahNumber, {QuranLanguage language = QuranLanguage.arabic}) List<Ayah>
Get all ayahs for a surah.
isRubBoundary(int surahNumber, int ayahNumber) bool
Whether a given ayah is a rub al-hizb boundary.
isSajda(int surahNumber, int ayahNumber) bool
Whether a given ayah is a sajda location.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
Synchronous full-text search with Arabic/English normalization.
searchAsync(String query, {int limit = 50, QuranLanguage language = QuranLanguage.arabic}) Future<List<Ayah>>
Async wrapper around search — useful in UI contexts.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

instance QuranService
no setter