HEX

File: //usr/lib/python3/dist-packages/twisted/words/im/__pycache__/interfaces.cpython-310.pyc
o

�b�!�@s�dZddlmZmZGdd�de�ZGdd�de�ZGdd�de�ZGd	d
�d
e�ZGdd�de�ZGd
d�de�Z	Gdd�de�Z
dS)z
Pan-protocol chat client.
�)�	Attribute�	Interfacec@sPeZdZdZed�Zed�Zdd�Zdd�Zdd	�Z	d
d�Z
dd
�Zdd�ZdS)�IAccountz;
    I represent a user's account with a chat service.
    z<The L{IClient} currently connecting to this account, if any.z;A C{str} that identifies the protocol used by this account.cC�dS)a
        @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
        N�)�accountName�	autoLogin�username�password�host�portrr�=/usr/lib/python3/dist-packages/twisted/words/im/interfaces.py�__init__�zIAccount.__init__cCr)z7
        Am I online?

        @rtype: boolean
        Nrrrrr
�isOnline*rzIAccount.isOnlinecCr)z�
        Go on-line.

        @type chatui: Implementor of C{IChatUI}

        @rtype: L{Deferred} with an eventual L{IClient} result.
        Nr)�chatuirrr
�logOn1rzIAccount.logOncCr)z
        Sign off.
        Nrrrrr
�logOff:rzIAccount.logOffcCr)z*
        @rtype: L{Group<IGroup>}
        Nr��	groupNamerrr
�getGroup?rzIAccount.getGroupcCr)z,
        @rtype: L{Person<IPerson>}
        Nr)�
personNamerrr
�	getPersonDrzIAccount.getPersonN)
�__name__�
__module__�__qualname__�__doc__r�client�gatewayTyperrrrrrrrrr
rs�	rc@s>eZdZed�Zdd�Zdd�Zdd�Zdd	d
�Zdd�Z	d
S)�IClientz!The L{IAccount} I am a Client forcCr)z�
        @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>}
        Nr)�accountr�
logonDeferredrrr
rNrzIClient.__init__cCr)zb
        @param groupName: The name of the group to join.
        @type groupName: string
        Nrrrrr
�	joinGroupVrzIClient.joinGroupcCr)zc
        @param groupName: The name of the group to leave.
        @type groupName: string
        Nrrrrr
�
leaveGroup\rzIClient.leaveGrouprcC�dS�Nr)�name�hiderrr
�getGroupConversationb�zIClient.getGroupConversationcCr$r%r)r&rrr
rer)zIClient.getPersonN�r)
rrrrr rr"r#r(rrrrr
rJs
rc@s6eZdZdd�Zdd�Zdd�Zdd�Zdd
d�Zd	S)
�IPersoncCr)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}
        Nr�r&r rrr
rjrzIPerson.__init__cCr)zA
        Am I online right now?

        @rtype: boolean
        Nrrrrr
rtrzIPerson.isOnlinecCr)zS
        What is my on-line status?

        @return: L{locals.StatusEnum}
        Nrrrrr
�	getStatus{rzIPerson.getStatuscCr)z;
        @rtype: string (XXX: How about a scalar?)
        Nrrrrr
�getIdleTime�rzIPerson.getIdleTimeNcCr)zi
        Send a message to this person.

        @type text: string
        @type metadata: dict
        Nr��text�metadatarrr
�sendMessage�rzIPerson.sendMessager%)rrrrrr-r.r2rrrr
r+is
r+c@sJeZdZdZed�Zed�Zdd�Zdd�Zdd	d
�Z	dd�Z
d
d�ZdS)�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<IAccount>} I am accessed through.cCr)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<IAccount>}
        Nrr,rrr
r�rzIGroup.__init__cCr)zR
        Set this Groups topic on the server.

        @type text: string
        Nr)r0rrr
�setTopic�rzIGroup.setTopicNcCr)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/rrr
�sendGroupMessage�rzIGroup.sendGroupMessagecCr)z"
        Join this group.
        Nrrrrr
�join�rzIGroup.joincCr)z$
        Depart this group.
        Nrrrrr
�leave�rzIGroup.leaver%)rrrrrr&r rr4r5r6r7rrrr
r3�s


r3c@s@eZdZdZdd�Zdd�Zdd�Zdd	�Zd
d�Zdd
�Z	dS)�
IConversationz0
    A conversation with a specific person.
    cCr)z*
        @type person: L{IPerson}
        Nr)�personrrrr
r�rzIConversation.__init__cCr�zA
        doesn't seem like it belongs in this interface.
        Nrrrrr
�show�rzIConversation.showcCr�z#
        nor this neither.
        Nrrrrr
r'�rzIConversation.hidecCr$r%rr/rrr
�sendText�r)zIConversation.sendTextcCr$r%rr/rrr
�showMessage�r)zIConversation.showMessagecCr)zR
        @param person: XXX Shouldn't this always be Conversation.person?
        Nr)r9�newnickrrr
�changedNick�rzIConversation.changedNickN)
rrrrrr;r'r=r>r@rrrr
r8�sr8c@sTeZdZdd�Zdd�Zdd�Zdd�Zd	d
�Zdd�Zd
d�Z	dd�Z
dd�ZdS)�IGroupConversationcCrr:rrrrr
r;�rzIGroupConversation.showcCrr<rrrrr
r'�rzIGroupConversation.hidecCr$r%rr/rrr
r=�r)zIGroupConversation.sendTextcCr$r%r)�senderr0r1rrr
�showGroupMessage�r)z#IGroupConversation.showGroupMessagecCr)zT
        Sets the list of members in the group and displays it to the user.
        Nr)�membersrrr
�setGroupMembers�rz"IGroupConversation.setGroupMemberscCr)z�
        Displays the topic (from the server) for the group conversation window.

        @type topic: string
        @type author: string (XXX: Not Person?)
        Nr)�topic�authorrrr
r4�rzIGroupConversation.setTopiccCr)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?)
        Nr��memberrrr
�memberJoinedrzIGroupConversation.memberJoinedcCr)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
        Nr��oldnickr?rrr
�memberChangedNick
rz$IGroupConversation.memberChangedNickcCr)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?)
        NrrHrrr
�
memberLeftrzIGroupConversation.memberLeftN)rrrr;r'r=rCrEr4rJrMrNrrrr
rA�s	rAc@sPeZdZdd�Zdd�Zdd�Zddd	�Zdd
d�Zdd
�Zdd�Z	dd�Z
dS)�IChatUIcCr)zp
        Notifies user that an account has been signed on to.

        @type client: L{Client<IClient>}
        Nr�rrrr
�registerAccountClientrzIChatUI.registerAccountClientcCr)z~
        Notifies user that an account has been signed off or disconnected.

        @type client: L{Client<IClient>}
        NrrPrrr
�unregisterAccountClient$rzIChatUI.unregisterAccountClientcCr)z)
        @rtype: L{ContactsList}
        Nrrrrr
�getContactsList+rzIChatUI.getContactsListrcCr)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<IPerson>}
        @type Class: L{Conversation<IConversation>} class
        @type stayHidden: boolean

        @rtype: L{Conversation<IConversation>}
        Nr)r9�Class�
stayHiddenrrr
�getConversation3rzIChatUI.getConversationcCr)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<interfaces.IGroup>}
        @type Class: L{Conversation<interfaces.IConversation>} class
        @type stayHidden: boolean

        @rtype: L{GroupConversation<interfaces.IGroupConversation>}
        Nr)�grouprTrUrrr
r(?rzIChatUI.getGroupConversationcCr)z�
        Get a Person for a client.

        Duplicates L{IAccount.getPerson}.

        @type name: string
        @type client: L{Client<IClient>}

        @rtype: L{Person<IPerson>}
        Nr�r&rrrr
rKrzIChatUI.getPersoncCr)z�
        Get a Group for a client.

        Duplicates L{IAccount.getGroup}.

        @type name: string
        @type client: L{Client<IClient>}

        @rtype: L{Group<IGroup>}
        NrrXrrr
rWrzIChatUI.getGroupcCr)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
        NrrKrrr
�contactChangedNickcrzIChatUI.contactChangedNickNr*)rrrrQrRrSrVr(rrrYrrrr
rOs

rON)r�zope.interfacerrrrr+r3r8rArOrrrr
�<module>s5'4 8