Index: third_party/twisted_8_1/twisted/words/im/interfaces.py |
diff --git a/third_party/twisted_8_1/twisted/words/im/interfaces.py b/third_party/twisted_8_1/twisted/words/im/interfaces.py |
deleted file mode 100644 |
index e0872bb53b8bc43f1ca80511b3b1aac53374afae..0000000000000000000000000000000000000000 |
--- a/third_party/twisted_8_1/twisted/words/im/interfaces.py |
+++ /dev/null |
@@ -1,324 +0,0 @@ |
-# -*- Python -*- |
-""" |
-Pan-protocol chat client. |
-""" |
-from zope.interface import Interface |
- |
-from twisted.words.im import locals |
- |
-# (Random musings, may not reflect on current state of code:) |
-# |
-# Accounts have Protocol components (clients) |
-# Persons have Conversation components |
-# Groups have GroupConversation components |
-# Persons and Groups are associated with specific Accounts |
-# At run-time, Clients/Accounts are slaved to a User Interface |
-# (Note: User may be a bot, so don't assume all UIs are built on gui toolkits) |
- |
- |
-class IAccount(Interface): |
- """I represent a user's account with a chat service. |
- |
- @cvar gatewayType: Identifies the protocol used by this account. |
- @type gatewayType: string |
- |
- @ivar client: The Client currently connecting to this account, if any. |
- @type client: L{IClient} |
- """ |
- |
- def __init__(accountName, autoLogin, username, password, host, port): |
- """ |
- @type accountName: string |
- @param accountName: A name to refer to the account by locally. |
- @type autoLogin: boolean |
- @type username: string |
- @type password: string |
- @type host: string |
- @type port: integer |
- """ |
- |
- def isOnline(): |
- """Am I online? |
- |
- @returntype: boolean |
- """ |
- |
- def logOn(chatui): |
- """Go on-line. |
- |
- @type chatui: Implementor of C{IChatUI} |
- |
- @returntype: Deferred L{Client} |
- """ |
- |
- def logOff(): |
- """Sign off. |
- """ |
- |
- def getGroup(groupName): |
- """ |
- @returntype: L{Group<IGroup>} |
- """ |
- |
- def getPerson(personName): |
- """ |
- @returntype: L{Person<IPerson>} |
- """ |
- |
-class IClient(Interface): |
- """ |
- @ivar account: The Account I am a Client for. |
- @type account: L{IAccount} |
- """ |
- def __init__(account, chatui, logonDeferred): |
- """ |
- @type account: L{IAccount} |
- @type chatui: L{IChatUI} |
- @param logonDeferred: Will be called back once I am logged on. |
- @type logonDeferred: L{Deferred<twisted.internet.defer.Deferred>} |
- """ |
- |
- def joinGroup(groupName): |
- """ |
- @param groupName: The name of the group to join. |
- @type groupName: string |
- """ |
- |
- def leaveGroup(groupName): |
- """ |
- @param groupName: The name of the group to leave. |
- @type groupName: string |
- """ |
- |
- def getGroupConversation(name,hide=0): |
- pass |
- |
- def getPerson(name): |
- pass |
- |
- |
-class IPerson(Interface): |
- def __init__(name, account): |
- """Initialize me. |
- |
- @param name: My name, as the server knows me. |
- @type name: string |
- @param account: The account I am accessed through. |
- @type account: I{Account} |
- """ |
- |
- def isOnline(): |
- """Am I online right now? |
- |
- @returntype: boolean |
- """ |
- |
- def getStatus(): |
- """What is my on-line status? |
- |
- @returns: L{locals.StatusEnum} |
- """ |
- |
- def getIdleTime(): |
- """ |
- @returntype: string (XXX: How about a scalar?) |
- """ |
- |
- def sendMessage(text, metadata=None): |
- """Send a message to this person. |
- |
- @type text: string |
- @type metadata: dict |
- """ |
- |
- |
-class IGroup(Interface): |
- """A group which you may have a conversation with. |
- |
- Groups generally have a loosely-defined set of members, who may |
- leave and join at any time. |
- |
- @ivar name: My name, as the server knows me. |
- @type name: string |
- @ivar account: The account I am accessed through. |
- @type account: I{Account<IAccount>} |
- """ |
- |
- def __init__(name, account): |
- """Initialize me. |
- |
- @param name: My name, as the server knows me. |
- @type name: string |
- @param account: The account I am accessed through. |
- @type account: I{Account<IAccount>} |
- """ |
- |
- def setTopic(text): |
- """Set this Groups topic on the server. |
- |
- @type text: string |
- """ |
- |
- def sendGroupMessage(text, metadata=None): |
- """Send a message to this group. |
- |
- @type text: string |
- |
- @type metadata: dict |
- @param metadata: Valid keys for this dictionary include: |
- |
- - C{'style'}: associated with one of: |
- - C{'emote'}: indicates this is an action |
- """ |
- |
- def join(): |
- pass |
- |
- def leave(): |
- """Depart this group""" |
- |
- |
-class IConversation(Interface): |
- """A conversation with a specific person.""" |
- def __init__(person, chatui): |
- """ |
- @type person: L{IPerson} |
- """ |
- |
- def show(): |
- """doesn't seem like it belongs in this interface.""" |
- |
- def hide(): |
- """nor this neither.""" |
- |
- def sendText(text, metadata): |
- pass |
- |
- def showMessage(text, metadata): |
- pass |
- |
- def changedNick(person, newnick): |
- """ |
- @param person: XXX Shouldn't this always be Conversation.person? |
- """ |
- |
-class IGroupConversation(Interface): |
- def show(): |
- """doesn't seem like it belongs in this interface.""" |
- |
- def hide(): |
- """nor this neither.""" |
- |
- def sendText(text, metadata): |
- pass |
- |
- def showGroupMessage(sender, text, metadata): |
- pass |
- |
- def setGroupMembers(members): |
- """Sets the list of members in the group and displays it to the user |
- """ |
- |
- def setTopic(topic, author): |
- """Displays the topic (from the server) for the group conversation window |
- |
- @type topic: string |
- @type author: string (XXX: Not Person?) |
- """ |
- |
- def memberJoined(member): |
- """Adds the given member to the list of members in the group conversation |
- and displays this to the user |
- |
- @type member: string (XXX: Not Person?) |
- """ |
- |
- def memberChangedNick(oldnick, newnick): |
- """Changes the oldnick in the list of members to newnick and displays this |
- change to the user |
- |
- @type oldnick: string (XXX: Not Person?) |
- @type newnick: string |
- """ |
- |
- def memberLeft(member): |
- """Deletes the given member from the list of members in the group |
- conversation and displays the change to the user |
- |
- @type member: string (XXX: Not Person?) |
- """ |
- |
- |
-class IChatUI(Interface): |
- def registerAccountClient(client): |
- """Notifies user that an account has been signed on to. |
- |
- @type client: L{Client<IClient>} |
- """ |
- |
- def unregisterAccountClient(client): |
- """Notifies user that an account has been signed off or disconnected |
- |
- @type client: L{Client<IClient>} |
- """ |
- |
- def getContactsList(): |
- """ |
- @returntype: L{ContactsList} |
- """ |
- |
- # WARNING: You'll want to be polymorphed into something with |
- # intrinsic stoning resistance before continuing. |
- |
- def getConversation(person, Class, stayHidden=0): |
- """For the given person object, returns the conversation window |
- or creates and returns a new conversation window if one does not exist. |
- |
- @type person: L{Person<IPerson>} |
- @type Class: L{Conversation<IConversation>} class |
- @type stayHidden: boolean |
- |
- @returntype: L{Conversation<IConversation>} |
- """ |
- |
- def getGroupConversation(group,Class,stayHidden=0): |
- """For the given group object, returns the group conversation window or |
- creates and returns a new group conversation window if it doesn't exist. |
- |
- @type group: L{Group<interfaces.IGroup>} |
- @type Class: L{Conversation<interfaces.IConversation>} class |
- @type stayHidden: boolean |
- |
- @returntype: L{GroupConversation<interfaces.IGroupConversation>} |
- """ |
- |
- def getPerson(name, client): |
- """Get a Person for a client. |
- |
- Duplicates L{IAccount.getPerson}. |
- |
- @type name: string |
- @type client: L{Client<IClient>} |
- |
- @returntype: L{Person<IPerson>} |
- """ |
- |
- def getGroup(name, client): |
- """Get a Group for a client. |
- |
- Duplicates L{IAccount.getGroup}. |
- |
- @type name: string |
- @type client: L{Client<IClient>} |
- |
- @returntype: L{Group<IGroup>} |
- """ |
- |
- def contactChangedNick(oldnick, newnick): |
- """For the given person, changes the person's name to newnick, and |
- tells the contact list and any conversation windows with that person |
- to change as well. |
- |
- @type oldnick: string |
- @type newnick: string |
- """ |