IRCHandler

(c) 2013-2014 http://ircanywhere.com

Author: Ricki Hastings

IRCAnywhere server/irchandler.js

class IRCHandler.IRCHandler()

The object responsible for handling an event from IRCFactory none of these should be called directly, however they can be hooked onto or have their actions prevented or replaced. The function names equal directly to irc-factory events and are case sensitive to them.

Returns:void

IRCHandler.blacklisted

An array of blacklisted commands which should be ignored

Type:array

IRCHandler._formatRaw(raw)

Formats an array of RAW IRC strings, taking off the :leguin.freenode.net 251 ricki- : at the start, returns an array of strings with it removed

Arguments:

• raw (array) – An array of raw IRC strings to format

Returns:

A formatted array of the inputted strings

IRCHandler.opened(client, message)

Handles the opened event from irc-factory which just tells us what localPort and any other information relating to the client so we can make sure the identd server is working.

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.registered(client, message)

Handles the registered event, this will only ever be called when an IRC connection has been fully established and we’ve recieved the registered events. This means when we reconnect to an already established connection we won’t get this event again.

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.closed(client, message)

Handles a closed connection

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.failed(client, message)

Handles a failed event, which is emitted when the retry attempts are exhaused

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.lusers(client, message)

Handles an incoming lusers event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.motd(client, message)

Handles an incoming motd event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.join(client, message)

Handles an incoming join event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.part(client, message)

Handles an incoming part event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.kick(client, message)

Handles an incoming kick event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.quit(client, message)

Handles an incoming quit event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.nick(client, message)

Handles an incoming nick change event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.who(client, message)

Handles an incoming who event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.names(client, message)

Handles an incoming names event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.mode(client, message)

Handles an incoming mode notify event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.mode_change(client, message)

Handles an incoming mode change event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

IRCHandler.topic(client, message)

Handles an incoming topic notify event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.topic_change(client, message)

Handles an incoming topic change event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.privmsg(client, message)

Handles an incoming privmsg event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.action(client, message)

Handles an incoming action event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.notice(client, message)

Handles an incoming notice event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.usermode(client, message)

Handles an incoming usermode event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.ctcp_response(client, message)

Handles an incoming ctcp_response event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.ctcp_request(client, message)

Handles an incoming ctcp request event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.unknown(client, message)

Handles an incoming unknown event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.banlist(client, message)

Handles an incoming banlist event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.invitelist(client, message)

Handles an incoming invitelist event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.exceptlist(client, message)

Handles an incoming exceptlist event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.quietlist(client, message)

Handles an incoming quietlist event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.list(client, message)

Handles an incoming list event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void

IRCHandler.whois(client, message)

Handles an incoming whois event

Arguments:

• client (object) – A valid client object
• message (object) – A valid message object

Returns:

void