summaryrefslogtreecommitdiffstats
path: root/plugin/hooks.go
diff options
context:
space:
mode:
authorChris <ccbrown112@gmail.com>2017-11-03 11:34:44 -0500
committerChristopher Speller <crspeller@gmail.com>2017-11-03 09:34:44 -0700
commitd2cff9b77cca87c339e65591179a2d7456a6915a (patch)
tree8540cb8ded46b98e195c3517929f3f751db8e5ca /plugin/hooks.go
parent71dd21ef3d89f8967b81a6bbfa67b2c85d3ad3e0 (diff)
downloadchat-d2cff9b77cca87c339e65591179a2d7456a6915a.tar.gz
chat-d2cff9b77cca87c339e65591179a2d7456a6915a.tar.bz2
chat-d2cff9b77cca87c339e65591179a2d7456a6915a.zip
more plugin doc updates (#7767)
Diffstat (limited to 'plugin/hooks.go')
-rw-r--r--plugin/hooks.go8
1 files changed, 4 insertions, 4 deletions
diff --git a/plugin/hooks.go b/plugin/hooks.go
index a40ac0e5c..04d5c7c14 100644
--- a/plugin/hooks.go
+++ b/plugin/hooks.go
@@ -7,10 +7,10 @@ import (
"net/http"
)
-// Hooks represents an object that handles events for a plugin. Methods are likely to be added over
-// time, and plugins are not expected to implement all of them. Instead, plugins are expected to
-// implement a subset of them and pass an instance to plugin/rpcplugin.Main, which will take over
-// execution of the process and add default behaviors for missing hooks.
+// Methods from the Hooks interface can be used by a plugin to respond to events. Methods are likely
+// to be added over time, and plugins are not expected to implement all of them. Instead, plugins
+// are expected to implement a subset of them and pass an instance to plugin/rpcplugin.Main, which
+// will take over execution of the process and add default behaviors for missing hooks.
type Hooks interface {
// OnActivate is invoked when the plugin is activated. Implementations will usually want to save
// the api argument for later use. Loading configuration for the first time is also a commonly