plugin

type Configurer interface {
	Plugin
	// DefaultConfig will be called on plugin first run to set the default config.
	// DefaultConfig will also be used if the provided config cannot be validate during initialization.
	// The default configuration will be provided to the user for future editing. Used for generating schemas and unmarshaling.
	DefaultConfig() interface{}
	// ValidateAndSetConfig will be called every time the plugin is initialized or the configuration has been changed by the user.
	// Plugins should check whether the configuration is valid and optionally return an error.
	// Parameter is guaranteed to be the same type as the return type of DefaultConfig()
	ValidateAndSetConfig(c interface{}) error
}

type Displayer interface {
	Plugin
	GetDisplay(location *url.URL) string
}

type Info struct {
	Version     string
	Author      string
	Name        string
	Website     string
	Description string
	License     string
	ModulePath  string
}

type Message struct {
	Message  string
	Title    string
	Priority int
	Extras   map[string]interface{}
}

type MessageHandler interface {
	// SendMessage sends a message with the given information in the request.
	SendMessage(msg Message) error
}

type Messenger interface {
	Plugin
	// SetMessageHandler is called every time the plugin is initialized.
	// Plugins should record the handler and use the callbacks provided in the handler to send messages.
	SetMessageHandler(h MessageHandler)
}

type Plugin interface {
	// Enable is called every time a plugin is started. Spawn custom goroutines here for polling, etc.
	// It is always called after ^Set.*Handler$
	Enable() error
	// Disable is called every time a plugin is disabled. Plugins should stop all custom goroutines here.
	Disable() error
}

type StorageHandler interface {
	Save(b []byte) error
	Load() ([]byte, error)
}

type Storager interface {
	Plugin
	SetStorageHandler(handler StorageHandler)
}

type UserContext struct {
	ID    uint
	Name  string
	Admin bool
}

type Webhooker interface {
	Plugin
	// RegisterWebhook is called for plugins to create their own handler.
	RegisterWebhook(basePath string, mux *gin.RouterGroup)
}