| Copyright | (c) Eric Mertens 2016 |
|---|---|
| License | ISC |
| Maintainer | emertens@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Irc.Commands
Contents
Description
This module provides smart constructors for IRC commands.
Synopsis
- ircAdmin :: Text -> RawIrcMsg
- ircAway :: Text -> RawIrcMsg
- ircCapEnd :: RawIrcMsg
- ircCapLs :: RawIrcMsg
- ircCapReq :: [Text] -> RawIrcMsg
- ircChantrace :: Text -> RawIrcMsg
- ircCnotice :: Text -> Text -> Text -> RawIrcMsg
- ircCprivmsg :: Text -> Text -> Text -> RawIrcMsg
- ircEtrace :: Text -> RawIrcMsg
- ircInfo :: RawIrcMsg
- ircInvite :: Text -> Identifier -> RawIrcMsg
- ircIson :: [Text] -> RawIrcMsg
- ircJoin :: Text -> Maybe Text -> RawIrcMsg
- ircKick :: Identifier -> Text -> Text -> RawIrcMsg
- ircKill :: Text -> Text -> RawIrcMsg
- ircKline :: Text -> Text -> Text -> RawIrcMsg
- ircKnock :: Text -> Text -> RawIrcMsg
- ircLinks :: [Text] -> RawIrcMsg
- ircList :: [Text] -> RawIrcMsg
- ircLusers :: [Text] -> RawIrcMsg
- ircMap :: RawIrcMsg
- ircMasktrace :: Text -> Text -> RawIrcMsg
- ircMode :: Identifier -> [Text] -> RawIrcMsg
- ircMotd :: Text -> RawIrcMsg
- ircNick :: Text -> RawIrcMsg
- ircNotice :: Text -> Text -> RawIrcMsg
- ircOper :: Text -> Text -> RawIrcMsg
- ircPart :: Identifier -> Text -> RawIrcMsg
- ircPass :: Text -> RawIrcMsg
- ircPing :: [Text] -> RawIrcMsg
- ircPong :: [Text] -> RawIrcMsg
- ircPrivmsg :: Text -> Text -> RawIrcMsg
- ircQuit :: Text -> RawIrcMsg
- ircRemove :: Identifier -> Text -> Text -> RawIrcMsg
- ircRules :: Text -> RawIrcMsg
- ircStats :: [Text] -> RawIrcMsg
- ircTestline :: Text -> RawIrcMsg
- ircTestmask :: Text -> Text -> RawIrcMsg
- ircTime :: Text -> RawIrcMsg
- ircTopic :: Identifier -> Text -> RawIrcMsg
- ircUnkline :: Text -> RawIrcMsg
- ircUser :: Text -> Text -> RawIrcMsg
- ircUserhost :: [Text] -> RawIrcMsg
- ircVersion :: Text -> RawIrcMsg
- ircWho :: [Text] -> RawIrcMsg
- ircWhois :: [Text] -> RawIrcMsg
- ircWhowas :: [Text] -> RawIrcMsg
- ircZnc :: [Text] -> RawIrcMsg
- newtype AuthenticatePayload = AuthenticatePayload ByteString
- ircAuthenticate :: Text -> RawIrcMsg
- ircAuthenticates :: AuthenticatePayload -> [RawIrcMsg]
- encodePlainAuthentication :: Text -> Text -> AuthenticatePayload
- encodeExternalAuthentication :: Text -> AuthenticatePayload
Documentation
CNOTICE command
CNOTICE <nickname> <channel> :<message>
CPRIVMSG command
CPRIVMSG <nickname> <channel> :<message>
Arguments
| :: Identifier | channel |
| -> Text | nickname |
| -> Text | message |
| -> RawIrcMsg |
KICK command
KNOCK command
KNOCK <channel> [<message>]
Arguments
| :: Identifier | channel |
| -> Text | nickname |
| -> Text | message |
| -> RawIrcMsg |
REMOVE command
ZNC support
SASL support
newtype AuthenticatePayload Source #
Payload for ircAuthenticates
Constructors
| AuthenticatePayload ByteString |
Instances
| Show AuthenticatePayload Source # | |
Defined in Irc.Commands Methods showsPrec :: Int -> AuthenticatePayload -> ShowS # show :: AuthenticatePayload -> String # showList :: [AuthenticatePayload] -> ShowS # | |
Arguments
| :: AuthenticatePayload | authentication payload |
| -> [RawIrcMsg] |
AUTHENTICATE command generator. Returns a list because AUTHENTICATE has a chunking behavior.
encodePlainAuthentication Source #
Arguments
| :: Text | username |
| -> Text | password |
| -> AuthenticatePayload |
Encoding of username and password in PLAIN authentication
encodeExternalAuthentication Source #
Arguments
| :: Text | username |
| -> AuthenticatePayload |
Encoding of username in EXTERNAL authentication