config

Documentation

Index

• Constants
• func Context(ctx context.Context, conf *Config) context.Context
• type Config
  • func FromContext(ctx context.Context) *Config
  • func (c *Config) Clone() *Config

Constants

const (
	// ApplicationName stores application name
	ApplicationName = "Anonymous plugin"

	// Repository stores repository
	Repository = "mattermost-plugin-anonymous"

	// CommandTrigger stores command trigger word
	CommandTrigger = "anonymous"

	// APIPath stores api prefix
	APIPath = "/api/v1"
)

Functions

func Context

func Context(ctx context.Context, conf *Config) context.Context

Context sets config object in context

Types

type Config

type Config struct {
	PluginID      string
	PluginVersion string
}

Config captures the plugin's external Config as exposed in the Mattermost server Config, as well as values computed from the Config. Any public fields will be deserialized from the Mattermost server Config in OnConfigurationChange.

As plugins are inherently concurrent (hooks being called asynchronously), and the plugin Config can change at any time, access to the Config must be synchronized. The strategy used in this plugin is to guard a pointer to the Config, and clone the entire struct whenever it changes. You may replace this with whatever strategy you choose.

If you add non-reference types to your Config struct, be sure to rewrite Clone as a deep copy appropriate for your types.

func FromContext

func FromContext(ctx context.Context) *Config

FromContext loads context object from context

func (*Config) Clone

func (c *Config) Clone() *Config

Clone shallow copies the Config. Your implementation may require a deep copy if your Config has reference types.