translations

Documentation

Index

• Variables
• type EpisodesTranslations
• type FAQTranslations
• type MediaItemTranslation
• type Service
  • func NewService(queries *sqlc.Queries, provider TranslationsProvider) *Service
  • func (s *Service) HandleWebhook(ctx context.Context, originalRequest *http.Request, hookData []byte) error
  • func (s *Service) SendAllToTranslation(ctx context.Context) []error
  • func (s *Service) SendCollectionToTranslation(ctx context.Context, collection TranslatableCollection) error
  • func (s *Service) UpdateTranslations(ctx context.Context, collection *TranslatableCollection, ...) []error
• type StudyQuestions
• type SurveyTranslations
• type TitleDescriptionTranslation
• type TitleTranslation
• type TitleWithId
• type TranslatableCollection
• type TranslationsProvider
• type UpdateTranslationCallback

Variables

var (
	CollectionAchievementGroups = TranslatableCollection{"achievementgroups"}
	CollectionAchievements      = TranslatableCollection{"achievements"}
	CollectionStudyQuestions    = TranslatableCollection{"studyquestions"}
	CollectionCalendarEntries   = TranslatableCollection{"calendarentries"}
	CollectionEpisodes          = TranslatableCollection{"episodes"}
	CollectionEvents            = TranslatableCollection{"events"}
	CollectionFAQCategories     = TranslatableCollection{"faqcategories"}
	CollectionFAQs              = TranslatableCollection{"faqs"}
	CollectionGames             = TranslatableCollection{"games"}
	CollectionLessons           = TranslatableCollection{"lessons"}
	CollectionLinks             = TranslatableCollection{"links"}
	CollectionMediaItems        = TranslatableCollection{"mediaitems"}
	CollectionPages             = TranslatableCollection{"pages"}
	CollectionPlaylists         = TranslatableCollection{"playlists"}
	CollectionSeasons           = TranslatableCollection{"seasons"}
	CollectionSections          = TranslatableCollection{"sections"}
	CollectionShows             = TranslatableCollection{"shows"}
	CollectionSurveys           = TranslatableCollection{"surveys"}
	CollectionTopics            = TranslatableCollection{"topics"}

	TranslatableCollections = enum.New(
		CollectionAchievementGroups,
		CollectionAchievements,
		CollectionCalendarEntries,
		CollectionEpisodes,
		CollectionEvents,
		CollectionFAQCategories,
		CollectionFAQs,
		CollectionGames,
		CollectionLessons,
		CollectionLinks,
		CollectionMediaItems,
		CollectionPages,
		CollectionPlaylists,
		CollectionSeasons,
		CollectionSections,
		CollectionShows,
		CollectionSurveys,
		CollectionTopics,
		CollectionStudyQuestions,
	)
)

Types

type EpisodesTranslations

type EpisodesTranslations struct {
	Title       string
	Description null.String
	Context     string `json:"@context"`
}

type FAQTranslations

type FAQTranslations struct {
	Question string
	Answer   string
}

type MediaItemTranslation

type MediaItemTranslation struct {
	Title       null.String
	Description null.String
}

type Service

type Service struct {
	// contains filtered or unexported fields
}

func NewService

func NewService(queries *sqlc.Queries, provider TranslationsProvider) *Service

func (*Service) HandleWebhook

func (s *Service) HandleWebhook(ctx context.Context, originalRequest *http.Request, hookData []byte) error

func (*Service) SendAllToTranslation

func (s *Service) SendAllToTranslation(ctx context.Context) []error

func (*Service) SendCollectionToTranslation

func (s *Service) SendCollectionToTranslation(ctx context.Context, collection TranslatableCollection) error

func (*Service) UpdateTranslations

func (s *Service) UpdateTranslations(ctx context.Context, collection *TranslatableCollection, data []common.TranslationData) []error

type StudyQuestions

type StudyQuestions struct {
	Question    string
	Description null.String
	Answers     []TitleWithId `json:"answers,omitempty"`
}

type SurveyTranslations

type SurveyTranslations struct {
	Title       string
	Description null.String
	Questions   []TitleWithId `json:"questions,omitempty"`
}

type TitleDescriptionTranslation

type TitleDescriptionTranslation struct {
	Title       string
	Description null.String
}

type TitleTranslation

type TitleTranslation struct {
	Title null.String
}

type TitleWithId

type TitleWithId struct {
	Title string
	ID    string `json:"@id"`
}

type TranslatableCollection

type TranslatableCollection enum.Member[string]

type TranslationsProvider

type TranslationsProvider interface {
	SendToTranslation(ctx context.Context, collection string, data []common.TranslationData) error
	ProcessWebhook(ctx context.Context, originalRequest *http.Request, hookData []byte) (collection *TranslatableCollection, data []common.TranslationData, err error)
}

type UpdateTranslationCallback

type UpdateTranslationCallback func(ctx context.Context, collection string, data []common.TranslationData) error