eliza

Elizabot - a virtual therapist.

eliza.description

Brief description of this module for Help Docs

Kind: static property of eliza

eliza.configuration

Default Configuration settings for this sock_module

Kind: static property of eliza

configuration.enabled : Boolean

Whether to enable this bot

Kind: static property of configuration

configuration.autoTimeout : Number

The default timeout

Kind: static property of configuration

configuration.userTimeout : Number

Timeout per user

Kind: static property of configuration

configuration.waitTime : Number

WAit time for a reply

Kind: static property of configuration

configuration.probability : Number

Probability of answering, from 0 to 1

Kind: static property of configuration

configuration.vocabulary : String

Vocabulary file is loaded via require() in elizabot.js. This implies the path is relative to 'sock_modules/eliza' :( TODO: load data in a better way.

Kind: static property of configuration

eliza.name

The name of this sock_module

Kind: static property of eliza

eliza.priority

If defined by a sock_module it is the priority of the module with respect to other modules.

sock_modules should not define modules with negative permissions. Default value is 50 with lower numbers being higher priority.

Kind: static property of eliza

eliza.version

The version of this sock_module

Kind: static property of eliza

eliza.onNotify(type, notification, topic, post, callback)

Runs on notification. Uses a random chance of appearing to determine if it should appear or not, controlled by the module configuration.

Kind: static method of eliza

Param Type Description
type string The type of event. Only responds if this is 'mentioned', PM, or reply
notification string The notification to respond to
topic string Unused.
post string The post the notification was for
callback function The callback to notify when processing is complete.

eliza.begin(browser, config)

Bootstrap the module.

Kind: static method of eliza

Param Type Description
browser object The Discourse interface object
config object The SockBot config object