alquran_cloud library Null safety

Classes

Aya
Edition
Juz
Quran
QuranCloudException
Surah

Properties

quranCloud ↔ _AlquranCloud
read / write

Functions

getAllEditions({String? format, String? language, String? type}) Future<List<Edition>>
? Edition Endpoints Lists all available editions. You can filter the results using the parameters below. format - Specify a format. 'text' or 'audio' language - A 2 digit language code. Example: 'en', 'fr', etc. type - A valid type. Example - 'versebyverse', 'translation' etc.
getAllEditionsByFormat(String format) Future<List<Edition>>
Lists all editions for a given type type can be 'translation', 'tafsir' or another result returned in 4 above
getAllEditionsForLanguage(String language) Future<List<Edition>>
Lists all editions for a given language language - is a 2 digit language code. Example: en for English, fr for French, ar for Arabic
getAllEditionsForType(String type) Future<List<Edition>>
Lists all editions for a given type type can be 'translation', 'tafsir' or another result returned in 4 above
getAyaByMultiEdition(List<String> editions) Future<List<Aya>>
Returns the requested surah from multiple editions
getAyaByNumber(int ayaNumber, Edition edition) Future<Aya>
Returns an ayah for a given edition.
getEditionFormat() Future<List<String>>
Lists all formats
getEditionSupportedLanguages() Future<List<String>>
Lists all languages in which editions are available
getEditionTypes() Future<List<String>>
Lists all types of editions
getJuzByNumber(int juzNumber, Edition edition, {int? offset, int? limit}) Future<Juz>
Returns the requested juz from a particular edition offset - offset ayahs in a juz by the given number limit - This is the number of ayahs that the response will be limited to.
getQuranByEdition(Edition edition) Future<Quran>
Returns a complete Quran edition in the audio or text format
getQuranSurahs({int? offset, int? limit}) Future<List<Surah>>
Returns the list of Surahs in the Quran offset - offset ayahs in a juz by the given number limit - This is the number of ayahs that the response will be limited to.
getSurahByEdition(int id, Edition edition) Future<Surah>
Returns the requested surah from a particular edition
getSurahByMultiEdition(List<String> editions) Future<List<Surah>>
Returns the requested surah from multiple editions
Returns ayahs that match a keyword in a given edition or language. If you do not specify an edition or language, all english language texts are searched. surah Enter a surah number (between 1 and 114) to search a specific surah or 'all' to search all the text editionis an edition identifier. Example: en.asad for Muhammad Asad's english translation language is 2 digit alpha language code. Example: en for English, fr for french