irc-core-2.4.0: IRC core library for glirc

Copyright(c) Eric Mertens 2016
LicenseISC
Maintaineremertens@gmail.com
Safe HaskellNone
LanguageHaskell2010

Irc.Commands

Contents

Description

This module provides smart constructors for IRC commands.

Synopsis

Documentation

ircAdmin Source #

Arguments

:: Text

target

-> RawIrcMsg 

ADMIN command

ADMIN [<target>]

ircAway Source #

Arguments

:: Text

message

-> RawIrcMsg 

AWAY command

ircCapEnd :: RawIrcMsg Source #

CAP END command

ircCapLs :: RawIrcMsg Source #

CAP LS command

ircCapReq Source #

Arguments

:: [Text]

capabilities

-> RawIrcMsg 

CAP REQ command

ircCnotice Source #

Arguments

:: Text

nickname

-> Text

channel

-> Text

message

-> RawIrcMsg 

CNOTICE command

CNOTICE <nickname> <channel> :<message>

ircCprivmsg Source #

Arguments

:: Text

nickname

-> Text

channel

-> Text

message

-> RawIrcMsg 

CPRIVMSG command

CPRIVMSG <nickname> <channel> :<message>

ircInfo :: RawIrcMsg Source #

INFO command

ircInvite Source #

Arguments

:: Text

nickname

-> Identifier

channel

-> RawIrcMsg 

INVITE command

ircIson Source #

Arguments

:: [Text]

nicknames

-> RawIrcMsg 

ISON command

ircJoin Source #

Arguments

:: Text

channel

-> Maybe Text

key

-> RawIrcMsg 

JOIN command

ircKick Source #

Arguments

:: Identifier

channel

-> Text

nickname

-> Text

message

-> RawIrcMsg 

KICK command

ircKill Source #

Arguments

:: Text

client

-> Text

message

-> RawIrcMsg 

KILL command

ircKnock Source #

Arguments

:: Text

channel

-> Text

message

-> RawIrcMsg 

KNOCK command

KNOCK <channel> [<message>]

ircLinks Source #

Arguments

:: [Text]

parameters

-> RawIrcMsg 

LINKS command

ircList Source #

Arguments

:: [Text]

parameters

-> RawIrcMsg 

LIST command

ircLusers Source #

Arguments

:: [Text]

params

-> RawIrcMsg 

LUSERS command

LUSERS [<mask> [<server>]]

ircMap :: RawIrcMsg Source #

MAP command

ircMode Source #

Arguments

:: Identifier

target

-> [Text]

parameters

-> RawIrcMsg 

MODE command

ircMotd Source #

Arguments

:: Text

server

-> RawIrcMsg 

MOTD command

MOTD [<server>]

ircNick Source #

Arguments

:: Text

nickname

-> RawIrcMsg 

NICK command

ircNotice Source #

Arguments

:: Text

target

-> Text

message

-> RawIrcMsg 

NOTICE command

ircOper Source #

Arguments

:: Text

username

-> Text

password

-> RawIrcMsg 

OPER command

ircPart Source #

Arguments

:: Identifier

channel

-> Text

message

-> RawIrcMsg 

PART command

ircPass Source #

Arguments

:: Text

password

-> RawIrcMsg 

PASS command

ircPing Source #

Arguments

:: [Text]

parameters

-> RawIrcMsg 

PING command

ircPong Source #

Arguments

:: [Text]

parameters

-> RawIrcMsg 

PONG command

ircPrivmsg Source #

Arguments

:: Text

target

-> Text

message

-> RawIrcMsg 

PRIVMSG command

ircRules Source #

Arguments

:: Text

servername

-> RawIrcMsg 

RULES command

ircQuit Source #

Arguments

:: Text

quit message

-> RawIrcMsg 

QUIT command

ircRemove Source #

Arguments

:: Identifier

channel

-> Text

nickname

-> Text

message

-> RawIrcMsg 

REMOVE command

ircStats Source #

Arguments

:: [Text]

parameters

-> RawIrcMsg 

STATS command

ircTime Source #

Arguments

:: Text

servername

-> RawIrcMsg 

TIME command

ircTopic Source #

Arguments

:: Identifier

channel

-> Text

topic

-> RawIrcMsg 

TOPIC command

ircUser Source #

Arguments

:: Text

username

-> Bool

set +w

-> Bool

set +i

-> Text

realname

-> RawIrcMsg 

USER command

ircUserhost Source #

Arguments

:: [Text]

parameters

-> RawIrcMsg 

USERHOST command

ircWho Source #

Arguments

:: [Text]

parameters

-> RawIrcMsg 

WHO command

ircWhois Source #

Arguments

:: [Text]

parameters

-> RawIrcMsg 

WHOIS command

ircWhowas Source #

Arguments

:: [Text]

parameters

-> RawIrcMsg 

WHOWAS command

ircVersion Source #

Arguments

:: Text

server

-> RawIrcMsg 

VERSION command

ZNC support

ircZnc Source #

Arguments

:: [Text]

parameters

-> RawIrcMsg 

ZNC command

specific to ZNC

SASL support

ircAuthenticate :: Text -> RawIrcMsg Source #

AUTHENTICATE command

plainAuthenticationMode :: Text Source #

PLAIN authentiation mode

encodePlainAuthentication Source #

Arguments

:: Text

username

-> Text

password

-> Text 

Encoding of username and password in PLAIN authentication