Client Methods
The client methods are a conglomerate of methods from various plugins, the socket, and the plugin system. There are also a few client specific methods. These are provided so that every plugin has access to the base functionality of the bot without having to require the base plugins.
Client Specific Methods
connect() -> this, start() -> this
Starts the Client.
disconnect() -> this, end() -> this
Stops the Client.
Action Plugin Delegates
These methods delegate to the action plugin. They are here so that you don't have to rely on the action plugin in almost every plugin.
Note: This section is badly documented. Sorry.
- act
- ctcp [deprecated]
- ctcpRequest
- ctcpResponse
- join
- kick
- mode
- nick
- notice
- part
- quit
- respond
- say
- userhost
- who
- whois
- raw
- rawf
Config Plugin Delegates
The Config plugin provides a single method, config, that takes a key from the config object and gives its value.
Self Plugin Delegates
The Self plugin provides a single method, nickname, that provides the Client's current nickname.
Subscriber Plugin Delegates
These methods call exports on the Subscriber plugin which in turn calls them on the prefix-event-subscriber.
Note: Not all methods from this plugin are on the client. For the fooWithMetadata methods, you will need to require the plugin.
Note: This section is badly documented. Sorry.
- on
- once
- off
Plugin System Delegates
These are from the plugin system.
Note: You probably will not need to use these directly.
Note: This section is badly documented. Sorry.
- use
- getPlugin
- getRole
- initializePlugin
- isPluginInitializable
- addHook - Adds an instance hook
addStaticHookaddInstanceHook- debug(source, message)
- info(source, message)
- note(source, message)
- warn(source, message)
- error(source, message)
- crit(source, message)
- emerg(source, message)
- log(level, source, message)
Logger Delegates
Note: This section is badly documented. Sorry.