summaryrefslogtreecommitdiffstats
path: root/plugin/plugin.go
blob: 3150bf56afa984ce1dad45092b9e3c9ae00deac2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.

// The plugin package defines the primary interfaces for interacting with a Mattermost server: the
// API and the hook interfaces.
//
// The API interface is used to perform actions. The Hook interface is used to respond to actions.
//
// Plugins should define a type that implements some of the methods from the Hook interface, then
// pass an instance of that object into the rpcplugin package's Main function (See the HelloWorld
// example.).
//
// Testing
//
// To make testing plugins easier, you can use the plugintest package to create a mock API for your
// plugin to interact with. See
// https://godoc.org/github.com/mattermost/mattermost-server/plugin/plugintest
package plugin