echo
Example plugin, echos your words back at you.
Author: Accalia
License: MIT
- echo
- .prepare(plugConfig, config, events, browser)
- .start()
- .stop()
- .handler(notification, topic, post)
echo.prepare(plugConfig, config, events, browser)
Prepare Plugin prior to login
Kind: static method of echo
Param | Type | Description |
---|---|---|
plugConfig | * |
Plugin specific configuration |
config | Config |
Overall Bot Configuration |
events | externals.events.SockEvents |
EventEmitter used for the bot |
browser | Browser |
Web browser for communicating with discourse |
echo.start()
Start the plugin after login
Kind: static method of echo
echo.stop()
Stop the plugin prior to exit or reload
Kind: static method of echo
echo.handler(notification, topic, post)
Handle notifications
Kind: static method of echo
Param | Type | Description |
---|---|---|
notification | external.notifications.Notification |
Notification recieved |
topic | external.topics.Topic |
Topic trigger post belongs to |
post | external.posts.CleanedPost |
Post that triggered notification |