Table of Contents

Class: IRCChatter | Twisted-0.17.4/twisted/words/ircservice.py
--- | ---

Base Classes |
--- | ---
irc.IRC service.WordsClientInterface

Methods |
--- | ---

callRemote
connectionLost
failedLogin
irc_AWAY
irc_CONNECT
irc_DIE
irc_ERROR
irc_INFO
irc_INVITE
irc_ISON
irc_JOIN
irc_KICK
irc_KILL
irc_LINKS
irc_LIST
irc_LUSERS
irc_MODE
irc_MOTD
irc_NAMES
irc_NICK
irc_NOTICE

irc_OPER
irc_PART
irc_PASS
irc_PING
irc_PONG
irc_PRIVMSG
irc_QUIT
irc_REHASH
irc_RESTART
irc_SERVICE
irc_SERVLIST
irc_SQUERY
irc_SQUIT
irc_STATS
irc_SUMMON
irc_TIME
irc_TOPIC
irc_TRACE
irc_USER
irc_USERHOST
irc_USERS

irc_VERSION
irc_WALLOPS
irc_WHO
irc_WHOIS
irc_WHOWAS
irc_channelMODE
irc_unknown
logInAs
loggedInAs
memberJoined
memberLeft
notLoggedIn
notifyStatusChanged
receiveContactList
receiveDirectMessage
receiveGroupMessage
sendMessage
setGroupMetadata
successfulLogin

| callRemote

    callRemote (
            self,
            key,
            *args,
            *kw,
            )

| connectionLost

    connectionLost ( self )

| failedLogin

    failedLogin ( self,  error )

| irc_AWAY

    irc_AWAY (
            self,
            prefix,
            params,
            )

### Away

Parameters: [ <text> ]

[Optional]

| irc_CONNECT

    irc_CONNECT (
            self,
            prefix,
            params,
            )

### Connect message

Parameters: <target server> <port> [ <remote server> ]

[REQUIRED]

| irc_DIE

    irc_DIE (
            self,
            prefix,
            params,
            )

### Die message

Parameters: None

[Optional]

| irc_ERROR

    irc_ERROR (
            self,
            prefix,
            params,
            )

### Error

Parameters: <error message>

[REQUIRED]

| irc_INFO

    irc_INFO (
            self,
            prefix,
            params,
            )

### Admin command

Parameters: [ <target> ]

[REQUIRED]

| irc_INVITE

    irc_INVITE (
            self,
            prefix,
            params,
            )

### Invite message

Parameters: <nickname> <channel>

[REQUIRED]

| irc_ISON

    irc_ISON (
            self,
            prefix,
            params,
            )

### Ison message

Parameters: <nickname> *( SPACE <nickname> )

[Optional]

| irc_JOIN

    irc_JOIN (
            self,
            prefix,
            params,
            )

### Join message

Parameters: ( <channel> ( "," <channel> ) [ <key> ( "," <key> ) ] )

[REQUIRED]

| irc_KICK

    irc_KICK (
            self,
            prefix,
            params,
            )

### Kick command

Parameters: <channel> ( "," <channel> ) <user> ( "," <user> )

[REQUIRED]

| irc_KILL

    irc_KILL (
            self,
            prefix,
            params,
            )

### Kill message

Parameters: <nickname> <comment>

[REQUIRED]

| irc_LINKS

    irc_LINKS (
            self,
            prefix,
            params,
            )

### Links message

Parameters: [ [ <remote server> ] <server mask> ]

[REQUIRED]

| irc_LIST

    irc_LIST (
            self,
            prefix,
            params,
            )

### List message

Parameters: [ <channel> *( "," <channel> ) [ <target> ] ]

[REQUIRED]

| irc_LUSERS

    irc_LUSERS (
            self,
            prefix,
            params,
            )

### Lusers message

Parameters: [ <mask> [ <target> ] ]

[REQUIRED]

| irc_MODE

    irc_MODE (
            self,
            prefix,
            params,
            )

### User mode message

Parameters: <nickname> ( ( "+" / "-" ) ( "i" / "w" / "o" / "O" / "r" ) )

[REQUIRED]

| irc_MOTD

    irc_MOTD (
            self,
            prefix,
            params,
            )

### Motd message

Parameters: [ <target> ]

[REQUIRED]

| irc_NAMES

    irc_NAMES (
            self,
            prefix,
            params,
            )

### Names message

Parameters: [ <channel> *( "," <channel> ) [ <target> ] ]

[REQUIRED]

| irc_NICK

    irc_NICK (
            self,
            prefix,
            params,
            )

Nick message
  Set your nickname.

  Parameters: <nickname>

  [REQUIRED]

  This is also probably the first thing the client sends us (except possibly PASS), so the rest of the sign-on junk is in here.

| irc_NOTICE

    irc_NOTICE (
            self,
            prefix,
            params,
            )

### Notice

Parameters: <msgtarget> <text>

[REQUIRED]

| irc_OPER

    irc_OPER (
            self,
            prefix,
            params,
            )

### Oper message

Parameters: <name> <password>

[REQUIRED]

| irc_PART

    irc_PART (
            self,
            prefix,
            params,
            )

### Part message

Parameters: <channel> *( "," <channel> ) [ <Part Message> ]

[REQUIRED]

| irc_PASS

    irc_PASS (
            self,
            prefix,
            params,
            )

Password message
  Register a password.

  Parameters: <password>

  [REQUIRED]

  Note that IRC requires the client send this before NICK and USER.

| irc_PING

    irc_PING (
            self,
            prefix,
            params,
            )

### Ping message

Parameters: <server1> [ <server2> ]

[REQUIRED]

| irc_PONG

    irc_PONG (
            self,
            prefix,
            params,
            )

### Pong message

Parameters: <server> [ <server2> ]

[REQUIRED]

| irc_PRIVMSG

    irc_PRIVMSG (
            self,
            prefix,
            params,
            )

### Send a (private) message.

Parameters: <msgtarget> <text to be sent>

[REQUIRED]

| irc_QUIT

    irc_QUIT (
            self,
            prefix,
            params,
            )

### Quit

Parameters: [ <Quit Message> ]

[REQUIRED]

| irc_REHASH

    irc_REHASH (
            self,
            prefix,
            params,
            )

### Rehash message

Parameters: None

[Optional]

| irc_RESTART

    irc_RESTART (
            self,
            prefix,
            params,
            )

### Restart message

Parameters: None

[Optional]

| irc_SERVICE

    irc_SERVICE (
            self,
            prefix,
            params,
            )

### Service message

Parameters: <nickname> <reserved> <distribution> <type>

[REQUIRED]

| irc_SERVLIST

    irc_SERVLIST (
            self,
            prefix,
            params,
            )

### Servlist message

Parameters: [ <mask> [ <type> ] ]

[REQUIRED]

| irc_SQUERY

    irc_SQUERY (
            self,
            prefix,
            params,
            )

### Squery

Parameters: <servicename> <text>

[REQUIRED]

| irc_SQUIT

    irc_SQUIT (
            self,
            prefix,
            params,
            )

### SQuit

Parameters: <server> <comment>

[REQUIRED]

| irc_STATS

    irc_STATS (
            self,
            prefix,
            params,
            )

### Stats message

Parameters: [ <query> [ <target> ] ]

[REQUIRED]

| irc_SUMMON

    irc_SUMMON (
            self,
            prefix,
            params,
            )

### Summon message

Parameters: <user> [ <target> [ <channel> ] ]

[Optional]

| irc_TIME

    irc_TIME (
            self,
            prefix,
            params,
            )

### Time message

Parameters: [ <target> ]

[REQUIRED]

| irc_TOPIC

    irc_TOPIC (
            self,
            prefix,
            params,
            )

### Topic message

Parameters: <channel> [ <topic> ]

[REQUIRED]

| irc_TRACE

    irc_TRACE (
            self,
            prefix,
            params,
            )

### Trace message

Parameters: [ <target> ]

[REQUIRED]

| irc_USER

    irc_USER (
            self,
            prefix,
            params,
            )

User message
  Set your realname.

  Parameters: <user> <mode> <unused> <realname>

  [REQUIRED] for backwards compatibility to IRC clients.

| irc_USERHOST

    irc_USERHOST (
            self,
            prefix,
            params,
            )

### Userhost message

Parameters: <nickname> *( SPACE <nickname> )

[Optional]

| irc_USERS

    irc_USERS (
            self,
            prefix,
            params,
            )

### Users

Parameters: [ <target> ]

[Optional]

| irc_VERSION

    irc_VERSION (
            self,
            prefix,
            params,
            )

### Version message

Parameters: [ <target> ]

[REQUIRED]

| irc_WALLOPS

    irc_WALLOPS (
            self,
            prefix,
            params,
            )

### Operwall message

Parameters: <Text to be sent>

[Optional]

| irc_WHO

    irc_WHO (
            self,
            prefix,
            params,
            )

### Who query

Parameters: [ <mask> [ "o" ] ]

[REQUIRED]

| irc_WHOIS

    irc_WHOIS (
            self,
            prefix,
            params,
            )

### Whois query

Parameters: [ <target> ] <mask> *( "," <mask> )

[REQUIRED]

| irc_WHOWAS

    irc_WHOWAS (
            self,
            prefix,
            params,
            )

### Whowas

Parameters: <nickname> *( "," <nickname> ) [ <count> [ <target> ] ]

[REQUIRED]

| irc_channelMODE

    irc_channelMODE (
            self,
            prefix,
            params,
            )

### Channel mode message

Parameters: <channel> ( ( "-" / "+" ) <modes> *<modeparams> )

[REQUIRED]

| irc_unknown

    irc_unknown (
            self,
            prefix,
            command,
            params,
            )

| logInAs

    logInAs (
            self,
            participant,
            password,
            )

Spawn appropriate callbacks to log in as this participant.

| loggedInAs

    loggedInAs ( self,  ident )

Successfully logged in.

| memberJoined

    memberJoined (
            self,
            member,
            group,
            )

| memberLeft

    memberLeft (
            self,
            member,
            group,
            )

| notLoggedIn

    notLoggedIn ( self,  message )

Login failed.

| notifyStatusChanged

    notifyStatusChanged (
            self,
            name,
            status,
            )

| receiveContactList

    receiveContactList ( self,  contactList )

| receiveDirectMessage

    receiveDirectMessage (
            self,
            senderName,
            message,
            metadata=None,
            )

| receiveGroupMessage

    receiveGroupMessage (
            self,
            sender,
            group,
            message,
            metadata=None,
            )

| sendMessage

    sendMessage (
            self,
            command,
            *parameter_list,
            *kw,
            )

| setGroupMetadata

    setGroupMetadata (
            self,
            metadata,
            groupName,
            )

| successfulLogin

    successfulLogin (
            self,
            msg,
            ident,
            )

Table of Contents

This document was automatically generated on Sat Apr 20 01:31:59 2002 by HappyDoc version 2.0