summoner

Example plugin, replies to mentions with random quips.

Author: Accalia
License: MIT

module.exports(forum, config) ⇒ Plugin

Plugin generation function.

Returns a plugin object bound to the provided forum provider

Kind: Exported function
Returns: Plugin - An instance of the Summoner plugin

Param Type Description
forum Provider Active forum Provider
config object | Array Plugin configuration

module.exports~handler(notification) ⇒ Promise

Handle a mention notification.

Choose a random message and reply with it

Kind: inner method of module.exports
Returns: Promise - Resolves when event is processed

Param Type Description
notification Notification Notification event to handle

module.exports~activate()

Activate the plugin

Kind: inner method of module.exports

module.exports~deactivate()

Deactivate the plugin

Kind: inner method of module.exports