plugin

Documentation

Index

• type API
• type Base
  • func (b *Base) OnConfigurationChange()
• type Hooks
• type Plugin

Types

type API

type API interface {
	// Loads the plugin's configuration
	LoadPluginConfiguration(dest interface{}) error

	// The plugin's router
	PluginRouter() *mux.Router

	// Gets a team by its name
	GetTeamByName(name string) (*model.Team, *model.AppError)

	// Gets a user by its name
	GetUserByName(name string) (*model.User, *model.AppError)

	// Gets a channel by its name
	GetChannelByName(teamId, name string) (*model.Channel, *model.AppError)

	// Gets a direct message channel
	GetDirectChannel(userId1, userId2 string) (*model.Channel, *model.AppError)

	// Creates a post
	CreatePost(post *model.Post, teamId string) (*model.Post, *model.AppError)

	// Returns a localized string. If a request is given, its headers will be used to pick a locale.
	I18n(id string, r *http.Request) string
}

type Base

type Base struct{}

Base provides default implementations for hooks.

func (*Base) OnConfigurationChange

func (b *Base) OnConfigurationChange()

type Hooks

type Hooks interface {
	// Invoked when configuration changes may have been made
	OnConfigurationChange()
}

All implementations should be safe for concurrent use.

type Plugin

type Plugin interface {
	Initialize(API)
	Hooks
}