diff options
| author | Chris <ccbrown112@gmail.com> | 2017-11-03 11:34:44 -0500 |
|---|---|---|
| committer | Christopher Speller <crspeller@gmail.com> | 2017-11-03 09:34:44 -0700 |
| commit | d2cff9b77cca87c339e65591179a2d7456a6915a (patch) | |
| tree | 8540cb8ded46b98e195c3517929f3f751db8e5ca /plugin/api.go | |
| parent | 71dd21ef3d89f8967b81a6bbfa67b2c85d3ad3e0 (diff) | |
| download | chat-d2cff9b77cca87c339e65591179a2d7456a6915a.tar.gz chat-d2cff9b77cca87c339e65591179a2d7456a6915a.tar.bz2 chat-d2cff9b77cca87c339e65591179a2d7456a6915a.zip | |
more plugin doc updates (#7767)
Diffstat (limited to 'plugin/api.go')
| -rw-r--r-- | plugin/api.go | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/plugin/api.go b/plugin/api.go index d7443d813..8d27bc794 100644 --- a/plugin/api.go +++ b/plugin/api.go @@ -7,8 +7,10 @@ import ( "github.com/mattermost/mattermost-server/model" ) -// API implementations can be used to retrieve data or perform actions on behalf of the plugin. Most -// methods have direct counterparts in the REST API and very similar behavior. +// The API can be used to retrieve data or perform actions on behalf of the plugin. Most methods +// have direct counterparts in the REST API and very similar behavior. +// +// Plugins can obtain access to the API by implementing the OnActivate hook. type API interface { // LoadPluginConfiguration loads the plugin's configuration. dest should be a pointer to a // struct that the configuration JSON can be unmarshalled to. |