mirror of
https://github.com/mattermost/mattermost.git
synced 2026-02-14 08:15:22 -05:00
Include https://github.com/mattermost/mattermost-plugin-api into the mono repo Co-authored-by: Jesse Hallam <jesse.hallam@gmail.com> Co-authored-by: Michael Kochell <mjkochell@gmail.com> Co-authored-by: Alejandro García Montoro <alejandro.garciamontoro@gmail.com> Co-authored-by: Ben Schumacher <ben.schumacher@mattermost.com> Co-authored-by: Alex Dovenmuehle <alex.dovenmuehle@mattermost.com> Co-authored-by: Michael Kochell <6913320+mickmister@users.noreply.github.com> Co-authored-by: Christopher Poile <cpoile@gmail.com> Co-authored-by: İlker Göktuğ Öztürk <ilkergoktugozturk@gmail.com> Co-authored-by: Shota Gvinepadze <wineson@gmail.com> Co-authored-by: Ali Farooq <ali.farooq0@pm.me> Co-authored-by: Maria A Nunez <maria.nunez@mattermost.com> Co-authored-by: Daniel Espino García <larkox@gmail.com> Co-authored-by: Christopher Speller <crspeller@gmail.com> Co-authored-by: Alex Dovenmuehle <adovenmuehle@gmail.com> Co-authored-by: Szymon Gibała <szymongib@gmail.com> Co-authored-by: Lev <1187448+levb@users.noreply.github.com> Co-authored-by: Jason Frerich <jason.frerich@mattermost.com> Co-authored-by: Agniva De Sarker <agnivade@yahoo.co.in> Co-authored-by: Artur M. Wolff <artur.m.wolff@gmail.com> Co-authored-by: Madhav Hugar <16546715+madhavhugar@users.noreply.github.com> Co-authored-by: Joe <security.joe@pm.me> Co-authored-by: Ibrahim Serdar Acikgoz <serdaracikgoz86@gmail.com> Co-authored-by: José Peso <trilopin@users.noreply.github.com>
55 lines
1.7 KiB
Go
55 lines
1.7 KiB
Go
package pluginapi
|
|
|
|
import (
|
|
"github.com/mattermost/mattermost/server/public/model"
|
|
"github.com/mattermost/mattermost/server/public/plugin"
|
|
)
|
|
|
|
// ConfigurationService exposes methods to manipulate the server and plugin configuration.
|
|
type ConfigurationService struct {
|
|
api plugin.API
|
|
}
|
|
|
|
// LoadPluginConfiguration loads the plugin's configuration. dest should be a pointer to a
|
|
// struct to which the configuration JSON can be unmarshalled.
|
|
//
|
|
// Minimum server version: 5.2
|
|
func (c *ConfigurationService) LoadPluginConfiguration(dest interface{}) error {
|
|
// TODO: Isn't this method redundant given GetPluginConfig() and even GetConfig()?
|
|
return c.api.LoadPluginConfiguration(dest)
|
|
}
|
|
|
|
// GetConfig fetches the currently persisted config.
|
|
//
|
|
// Minimum server version: 5.2
|
|
func (c *ConfigurationService) GetConfig() *model.Config {
|
|
return c.api.GetConfig()
|
|
}
|
|
|
|
// GetUnsanitizedConfig fetches the currently persisted config without removing secrets.
|
|
//
|
|
// Minimum server version: 5.16
|
|
func (c *ConfigurationService) GetUnsanitizedConfig() *model.Config {
|
|
return c.api.GetUnsanitizedConfig()
|
|
}
|
|
|
|
// SaveConfig sets the given config and persists the changes
|
|
//
|
|
// Minimum server version: 5.2
|
|
func (c *ConfigurationService) SaveConfig(cfg *model.Config) error {
|
|
return normalizeAppErr(c.api.SaveConfig(cfg))
|
|
}
|
|
|
|
// GetPluginConfig fetches the currently persisted config of plugin
|
|
//
|
|
// Minimum server version: 5.6
|
|
func (c *ConfigurationService) GetPluginConfig() map[string]interface{} {
|
|
return c.api.GetPluginConfig()
|
|
}
|
|
|
|
// SavePluginConfig sets the given config for plugin and persists the changes
|
|
//
|
|
// Minimum server version: 5.6
|
|
func (c *ConfigurationService) SavePluginConfig(cfg map[string]interface{}) error {
|
|
return normalizeAppErr(c.api.SavePluginConfig(cfg))
|
|
}
|