Lambdabot.IRC

The IRC module processes the IRC protocol and provides a nice API for sending and receiving IRC messages with an IRC server.

Documentation

data IrcMessage

An IRC message is a server, a prefix, a command and a list of parameters.

Note that the strings here are treated as lists of bytes!

Constructors

IrcMessage

Fields

• ircMsgServer :: !String
• ircMsgLBName :: !String
• ircMsgPrefix :: !String
• ircMsgCommand :: !String
• ircMsgParams :: ![String]

Instances

Show IrcMessage

Defined in Lambdabot.IRC

Methods

showsPrec :: Int -> IrcMessage -> ShowS

show :: IrcMessage -> String

showList :: [IrcMessage] -> ShowS

Message IrcMessage

Defined in Lambdabot.IRC

Methods

server :: IrcMessage -> String

nick :: IrcMessage -> Nick

fullName :: IrcMessage -> String

channels :: IrcMessage -> [Nick]

lambdabotName :: IrcMessage -> Nick

joinChannel :: Nick -> IrcMessage

partChannel :: Nick -> IrcMessage

getTopic :: Nick -> IrcMessage

setTopic :: Nick -> String -> IrcMessage

codepage :: String -> String -> IrcMessage

codepage creates a server CODEPAGE message. The input string given is the codepage name for current session.

privmsg

Arguments

:: Nick

Who should receive the message (nick)

-> String

What is the message?

-> IrcMessage

Constructed message

privmsg creates a private message to the person designated.

quit :: String -> String -> IrcMessage

quit creates a server QUIT message. The input string given is the quit message, given to other parties when leaving the network.

timeReply :: IrcMessage -> IrcMessage

Construct a privmsg from the CTCP TIME notice, to feed up to the @localtime-reply plugin, which then passes the output to the appropriate client.

pass :: String -> String -> IrcMessage

user :: String -> String -> String -> String -> IrcMessage

setNick :: Nick -> IrcMessage