i18n

type Bundle ¶

type Bundle struct {
	*i18n.Bundle
	// contains filtered or unexported fields
}

Bundle stores a set of messages and pluralization rules. Most plugins only need a single bundle that is initialized on activation. It is not goroutine safe to modify the bundle while Localizers are reading from it.

func InitBundle(api PluginAPI, path string) (*Bundle, error)

package main

import (
	"path/filepath"

	"github.com/mattermost/mattermost/server/public/plugin"
	"github.com/mattermost/mattermost/server/public/pluginapi/i18n"
)

func main() {
	type Plugin struct {
		plugin.MattermostPlugin

		b *i18n.Bundle
	}

	p := Plugin{}
	b, err := i18n.InitBundle(p.API, filepath.Join("assets", "i18n"))
	if err != nil {
		panic(err)
	}

	p.b = b
}

Output:

func (b *Bundle) GetServerLocalizer() *i18n.Localizer

func (b *Bundle) GetUserLocalizer(userID string) *i18n.Localizer

func (b *Bundle) LocalizeDefaultMessage(l *Localizer, m *Message) string

func (b *Bundle) LocalizeWithConfig(l *Localizer, lc *LocalizeConfig) string

type LocalizeConfig ¶

type LocalizeConfig = i18n.LocalizeConfig

LocalizeConfig configures a call to the Localize method on Localizer.

See https://pkg.go.dev/github.com/nicksnyder/go-i18n/v2/i18n?tab=doc#LocalizeConfig for more details.

type Localizer ¶

type Localizer = i18n.Localizer

Localizer provides Localize and MustLocalize methods that return localized messages.

See https://pkg.go.dev/github.com/nicksnyder/go-i18n/v2/i18n?tab=doc#Localizer for more details.

type Message ¶

type Message = i18n.Message

Message is a string that can be localized.

See https://pkg.go.dev/github.com/nicksnyder/go-i18n/v2/i18n?tab=doc#Message for more details.

type PluginAPI ¶

type PluginAPI interface {
	GetBundlePath() (string, error)
	GetConfig() *model.Config
	GetUser(userID string) (*model.User, *model.AppError)
	LogWarn(msg string, keyValuePairs ...interface{})
}

PluginAPI is the plugin API interface required to manage translations.