preferences

Documentation

Index

• Variables
• func GetDefaultLocale() language.Tag
• type Record
  • func GetDefaultPreferences(id *user.DataContainerID) *Record
  • func (r *Record) Clone() Record
  • func (r *Record) CopyTo(dst *Record)
  • func (r *Record) Validate() error
• type Store

Variables

var (
	ErrPreferencesNotFound = errors.New("preferences record not found")
)

Functions

func GetDefaultLocale

func GetDefaultLocale() language.Tag

GetDefaultLocale returns the default locale setting

Types

type Record

type Record struct {
	Id uint64

	DataContainerId user.DataContainerID

	Locale language.Tag

	LastUpdatedAt time.Time
}

func GetDefaultPreferences

func GetDefaultPreferences(id *user.DataContainerID) *Record

GetDefaultPreferences returns the default set of user preferences

func (*Record) Clone

func (r *Record) Clone() Record

func (*Record) CopyTo

func (r *Record) CopyTo(dst *Record)

func (*Record) Validate

func (r *Record) Validate() error

type Store

type Store interface {
	// Save saves a preferences record
	Save(ctx context.Context, record *Record) error

	// Get gets a a preference record by a data container. ErrPreferencesNotFound
	// is returned if no record exists.
	Get(ctx context.Context, id *user.DataContainerID) (*Record, error)
}