namer

Change your long name periodically

Author: Accalia
License: MIT

namer.prepare(plugConfig, config, events, browser)

Prepare Plugin prior to login

Kind: static method of namer

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

namer.start()

Start the plugin after login

Kind: static method of namer

namer.stop()

Stop the plugin prior to exit or reload

Kind: static method of namer

namer.setName()

Set the new Log name from a list of choices.

Kind: static method of namer

namer~profilePrefix

Profile Prefix

Kind: inner constant of namer

namer~defaultConfig : object

Default configuration settings

Kind: inner typedef of namer

defaultConfig.schedule : string

Schedule to change name on. Must be a valid later text schedule.

See the parser documentation for more information

Kind: static property of defaultConfig
Default: "at 00:00"

defaultConfig.names : Array.<string>

Long names to choose from.

Kind: static property of defaultConfig
Default: ["The of and to. A in is I. That it, for you, was with on. As have ... but be they."]

namer~internals : object

Internal status store

Kind: inner typedef of namer

internals.profileUrl : string

Profile URL

Kind: static property of internals

internals.browser : Browser

Browser to use for communication with discourse

Kind: static property of internals

internals.events : externals.events.SockEvents

EventEmitter used for internal communication

Kind: static property of internals

internals.config : object

Instance configuration

Kind: static property of internals

internals.interval : *

Interval identifier for schedule

Kind: static property of internals

internals.extendedHelp

Extended help message

Kind: static property of internals