U  W[!@sdZddlmZmZGdddeZGdddeZGdddeZGd d d eZGd d d eZGd ddeZ GdddeZ dS)z Pan-protocol chat client. ) Interface Attributec@sPeZdZdZedZedZddZddZdd Z d d Z d d Z ddZ dS)IAccountz; I represent a user's account with a chat service. z} NrZ groupNamerrrgetGroup=szIAccount.getGroupcCsdS)z, @rtype: L{Person} Nr)Z personNamerrr getPersonBszIAccount.getPersonN) __name__ __module__ __qualname____doc__rclientZ gatewayTyperrr r r rrrrrrs  rc@s>eZdZedZddZddZddZdd d Zd d Z d S)IClientz!The L{IAccount} I am a Client forcCsdS)z @type account: L{IAccount} @type chatui: L{IChatUI} @param logonDeferred: Will be called back once I am logged on. @type logonDeferred: L{Deferred} Nr)accountr Z logonDeferredrrrrMszIClient.__init__cCsdS)zb @param groupName: The name of the group to join. @type groupName: string Nrr rrr joinGroupUszIClient.joinGroupcCsdS)zc @param groupName: The name of the group to leave. @type groupName: string Nrr rrr leaveGroup[szIClient.leaveGrouprcCsdSNr)namehiderrrgetGroupConversationaszIClient.getGroupConversationcCsdSrr)rrrrreszIClient.getPersonN)r) rrrrrrrrrrrrrrrIs  rc@s6eZdZddZddZddZddZd d d Zd S) IPersoncCsdS)z 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} NrrrrrrrlszIPerson.__init__cCsdS)zA Am I online right now? @rtype: boolean NrrrrrrwszIPerson.isOnlinecCsdS)zS What is my on-line status? @return: L{locals.StatusEnum} Nrrrrr getStatusszIPerson.getStatuscCsdS)z; @rtype: string (XXX: How about a scalar?) Nrrrrr getIdleTimeszIPerson.getIdleTimeNcCsdS)zi Send a message to this person. @type text: string @type metadata: dict Nrtextmetadatarrr sendMessageszIPerson.sendMessage)N)rrrrrrrr#rrrrrjs  rc@sJeZdZdZedZedZddZddZdd d Z d d Z d dZ dS)IGroupz 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. z'My C{str} name, as the server knows me.z/The L{Account} I am accessed through.cCsdS)z Initialize me. @param name: My name, as the server knows me. @type name: str @param account: The account I am accessed through. @type account: L{Account} NrrrrrrszIGroup.__init__cCsdS)zR Set this Groups topic on the server. @type text: string Nr)r!rrrsetTopicszIGroup.setTopicNcCsdS)a Send a message to this group. @type text: str @type metadata: dict @param metadata: Valid keys for this dictionary include: - C{'style'}: associated with one of: - C{'emote'}: indicates this is an action Nrr rrrsendGroupMessageszIGroup.sendGroupMessagecCsdS)z" Join this group. Nrrrrrjoinsz IGroup.joincCsdS)z$ Depart this group. Nrrrrrleavesz IGroup.leave)N) rrrrrrrrr%r&r'r(rrrrr$s  r$c@s@eZdZdZddZddZddZdd Zd d Zd d Z dS) IConversationz0 A conversation with a specific person. cCsdS)z* @type person: L{IPerson} Nr)personr rrrrszIConversation.__init__cCsdSzA doesn't seem like it belongs in this interface. NrrrrrshowszIConversation.showcCsdSz# nor this neither. NrrrrrrszIConversation.hidecCsdSrrr rrrsendTextszIConversation.sendTextcCsdSrrr rrr showMessageszIConversation.showMessagecCsdS)zR @param person: XXX Shouldn't this always be Conversation.person? Nr)r*newnickrrr changedNickszIConversation.changedNickN) rrrrrr,rr.r/r1rrrrr)sr)c@sTeZdZddZddZddZddZd d Zd d Zd dZ ddZ ddZ dS)IGroupConversationcCsdSr+rrrrrr,szIGroupConversation.showcCsdSr-rrrrrrszIGroupConversation.hidecCsdSrrr rrrr.szIGroupConversation.sendTextcCsdSrr)Zsenderr!r"rrrshowGroupMessagesz#IGroupConversation.showGroupMessagecCsdS)zT Sets the list of members in the group and displays it to the user. Nr)membersrrrsetGroupMembers sz"IGroupConversation.setGroupMemberscCsdS)z Displays the topic (from the server) for the group conversation window. @type topic: string @type author: string (XXX: Not Person?) Nr)ZtopicZauthorrrrr%szIGroupConversation.setTopiccCsdS)z 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?) Nrmemberrrr memberJoinedszIGroupConversation.memberJoinedcCsdS)z Changes the oldnick in the list of members to C{newnick} and displays this change to the user, @type oldnick: string (XXX: Not Person?) @type newnick: string NrZoldnickr0rrrmemberChangedNick$sz$IGroupConversation.memberChangedNickcCsdS)z 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?) Nrr6rrr memberLeft.szIGroupConversation.memberLeftN) rrrr,rr.r3r5r%r8r:r;rrrrr2s   r2c@sPeZdZddZddZddZddd Zdd d Zd d ZddZ ddZ dS)IChatUIcCsdS)zp Notifies user that an account has been signed on to. @type client: L{Client} NrrrrrregisterAccountClient:szIChatUI.registerAccountClientcCsdS)z~ Notifies user that an account has been signed off or disconnected. @type client: L{Client} Nrr=rrrunregisterAccountClientBszIChatUI.unregisterAccountClientcCsdS)z) @rtype: L{ContactsList} NrrrrrgetContactsListJszIChatUI.getContactsListrcCsdS)aT 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} @type Class: L{Conversation} class @type stayHidden: boolean @rtype: L{Conversation} Nr)r*Class stayHiddenrrrgetConversationRszIChatUI.getConversationcCsdS)a 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} @type Class: L{Conversation} class @type stayHidden: boolean @rtype: L{GroupConversation} Nr)grouprArBrrrr_szIChatUI.getGroupConversationcCsdS)z Get a Person for a client. Duplicates L{IAccount.getPerson}. @type name: string @type client: L{Client} @rtype: L{Person} NrrrrrrrlszIChatUI.getPersoncCsdS)z Get a Group for a client. Duplicates L{IAccount.getGroup}. @type name: string @type client: L{Client} @rtype: L{Group} NrrErrrr yszIChatUI.getGroupcCsdS)z 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 Nrr9rrrcontactChangedNickszIChatUI.contactChangedNickN)r)r) rrrr>r?r@rCrrr rFrrrrr<8s   r<N) rZzope.interfacerrrrrr$r)r2r<rrrrs 4!-9&B