domain

Documentation

Index

• func ResultToProto(r *Result) *pb.Result
• func VerseToProto(verse *Verse) *pb.Verse
• type Chapter
• type ChapterInfo
• type Pagination
• type Result
• type SearchResults
• type SearchTranslation
• type Tafsir
• type TranslatedName
• type Translation
• type TranslationText
• type Transliteration
• type Verse
• type VersesByChapter
• type Word

Functions

func ResultToProto

func ResultToProto(r *Result) *pb.Result

func VerseToProto

func VerseToProto(verse *Verse) *pb.Verse

Types

type Chapter

type Chapter struct {
	Id              int32           `json:"id"`
	RevelationPlace string          `json:"revelation_place"`
	RevelationOrder int32           `json:"revelation_order"`
	BismillahPrefix bool            `json:"bismillah_pre"`
	NameSimple      string          `json:"name_simple"`
	NameComplex     string          `json:"name_complex"`
	NameArabic      string          `json:"name_arabic"`
	VersesCount     int32           `json:"verses_count"`
	Pages           []int32         `json:"pages"`
	TranslatedName  *TranslatedName `json:"translated_name"`
}

type ChapterInfo

type ChapterInfo struct {
	Id           int32  `json:"id"`
	ChapterId    int32  `json:"chapter_id"`
	LanguageName string `json:"language_name"`
	ShortText    string `json:"short_text"`
	Source       string `json:"source"`
	Text         string `json:"text"`
}

type Pagination

type Pagination struct {
	PerPage      int32 `json:"per_page"`
	CurrentPage  int32 `json:"current_page"`
	NextPage     int32 `json:"next_page"`
	TotalPages   int32 `json:"total_pages"`
	TotalRecords int32 `json:"total_records"`
}

type Result

type Result struct {
	VerseId      int32                `json:"verse_id"`
	VerseKey     string               `json:"verse_key"`
	Text         string               `json:"text"`
	Translations []*SearchTranslation `json:"translations"`
}

type SearchResults

type SearchResults struct {
	Query        string    `json:"query"`
	TotalResults int32     `json:"total_results"`
	CurrentPage  int32     `json:"current_page"`
	TotalPages   int32     `json:"total_pages"`
	Results      []*Result `json:"results"`
}

type SearchTranslation

type SearchTranslation struct {
	ResourceId int32  `json:"resource_id"`
	Text       string `json:"text"`
	Name       string `json:"name"`
}

type Tafsir

type Tafsir struct {
	Id         int32  `json:"id"`
	ResourceId int32  `json:"resource_id"`
	Text       string `json:"text"`
}

type TranslatedName

type TranslatedName struct {
	LanguageName string `json:"language_name"`
	Name         string `json:"name"`
}

type Translation

type Translation struct {
	Text         string `json:"text"`
	LanguageName string `json:"language_name"`
}

type TranslationText

type TranslationText struct {
	Id           int32  `json:"id"`
	ResourceId   int32  `json:"resource_id"`
	Text         string `json:"text"`
	ResourceName string `json:"resource_name"`
}

type Transliteration

type Transliteration struct {
	Text         string `json:"text"`
	LanguageName string `json:"language_name"`
}

type Verse

type Verse struct {
	Id           int32              `json:"id"`
	VerseNumber  int32              `json:"verse_number"`
	VerseKey     string             `json:"verse_key"`
	JuzNumber    int32              `json:"juz_number"`
	HizbNumber   int32              `json:"hizb_number"`
	RubNumber    int32              `json:"rub_number"`
	PageNumber   int32              `json:"page_number"`
	Translations []*TranslationText `json:"translations"`
	Tafsirs      []*Tafsir          `json:"tafsirs"`
	Words        []*Word            `json:"words"`
	TextImlaei   string             `json:"text_imlaei"`
}

type VersesByChapter

type VersesByChapter struct {
	Pagination *Pagination `json:"pagination"`
	Verses     []*Verse    `json:"verses"`
}

type Word

type Word struct {
	Id              int32        `json:"id"`
	Position        int32        `json:"position"`
	AudioUrl        string       `json:"audio_url"`
	CharTypeName    string       `json:"char_type_name"`
	CodeV1          string       `json:"code_v1"`
	PageNumber      int32        `json:"page_number"`
	LineNumber      int32        `json:"line_number"`
	Text            string       `json:"text_imlaei"`
	Code            string       `json:"code_v2"`
	Translation     *Translation `json:"translation"`
	Transliteration *Translation `json:"transliteration"`
}