frontend

Documentation

Overview

Package frontend defines the interface a frontend server should comply to.

Index

• type Context
  • func (c *Context) FlavorId(key string) (content.FlavorId, error)
  • func (c *Context) IsFocusOnA() bool
  • func (c *Context) LoggedIn() bool
  • func (c *Context) ProtocolAndHost() string
• type ErrorMap
• type FlavorTriple
  • func (t *FlavorTriple) Language() language.Code
• type Server

Types

type Context

type Context struct {
	Locale   string
	Vars     map[string]string
	Query    url.Values
	Form     url.Values
	Url      string
	User     user.Name
	Protocol string
	Host     string

	Email string // for password reset

	Defaults url.Values // default form values
	Errors   ErrorMap   // errors on form submit
}

func (*Context) FlavorId

func (c *Context) FlavorId(key string) (content.FlavorId, error)

func (*Context) IsFocusOnA

func (c *Context) IsFocusOnA() bool

func (*Context) LoggedIn

func (c *Context) LoggedIn() bool

func (*Context) ProtocolAndHost

func (c *Context) ProtocolAndHost() string

type ErrorMap

type ErrorMap map[string]i18n.Key

type FlavorTriple

type FlavorTriple struct {
	Audio      *content.Flavor
	Text       *content.Flavor
	Transcript *content.Flavor
}

func (*FlavorTriple) Language

func (t *FlavorTriple) Language() language.Code

type Server

type Server interface {
	SetLanguageList([]language.Code) error

	Home(context *Context) ([]byte, error)
	Error(context *Context) ([]byte, error)
	NotFound(context *Context) ([]byte, error)

	Flavor(context *Context, e *content.Extract, a, b *FlavorTriple) ([]byte, error)

	NewExtract(context *Context) ([]byte, error)
	NewFlavor(context *Context, e *content.Extract) ([]byte, error)
	EditText(context *Context, e *content.Extract, a, b *content.Flavor) ([]byte, error)

	SignUp(context *Context) ([]byte, error)
	SignIn(context *Context) ([]byte, error)
	ForgotPassword(context *Context) ([]byte, error)
	PasswordSent(context *Context) ([]byte, error)
	ResetPassword(context *Context) ([]byte, error)
	PasswordResetEmail(c *Context, a *user.Account, token string) ([]byte, error)
}

Server is the interface a frontend server should comply to.