Class ChatMember

ehforwarderbot/chat.py:199–275

Member of a chat. Usually indicates a member in a group, or the other participant in a private chat. Chat bots created by the users of the IM platform is also considered as a plain :class:`.ChatMember`. To represent the User Themself, use :class:`.SelfChatMember`. To represent a ch

class ChatMember(BaseChat):
    """Member of a chat. Usually indicates a member in a group, or the other
    participant in a private chat. Chat bots created by the users of the
    IM platform is also considered as a plain :class:`.ChatMember`.

    To represent the User Themself, use :class:`.SelfChatMember`.

    To represent a chat member that is a part of the system, the slave channel,
    or a middleware, use :class:`.SystemChatMember`.

    :class:`.ChatMember`\\ s MUST be created with reference of the chat it
    belongs to. Different objects MUST be created even when the same person
    appears in different groups or in a private chat.

    :class:`.ChatMember`\\ s are RECOMMENDED to be created using
    :meth:`.Chat.add_member` method.

    Note:
        ``ChatMember`` objects are picklable, thus it is RECOMMENDED
        to keep any object of its subclass also picklable.
    """
    def __init__(self, chat: 'Chat', *,
                 name: str = "", alias: Optional[str] = None, uid: ChatID = ChatID(""),
                 id: ChatID = ChatID(""),
                 vendor_specific: Dict[str, Any] = None, description: str = "",
                 middleware: Optional[Middleware] = None):
        """
        Args:
            chat (:class:`~.chat.Chat`): Chat associated with this member.

        Keyword Args:
            name (str): Name of the member.
            alias (Optional[str]): Alternative name of the member, usually set by user.
            uid (:obj:`.ChatID` (str)):
                Unique ID of the member. This MUST be unique within the channel.
                This ID can be the same with a private chat of the same person.
            description (str):
                A text description of the member, usually known as “bio”,
                “description”, “summary” or “introduction” of the member.
            middleware (:class:`.Middleware`): Initialize this chat as a part
                of a middleware.
        """
        if middleware:
            super().__init__(module_name=middleware.middleware_name, channel_emoji="",
                             module_id=middleware.middleware_id, name=name, alias=alias, id=id, uid=uid,
                             vendor_specific=vendor_specific, description=description)
        else:
            super().__init__(module_name=chat.module_name, channel_emoji=chat.channel_emoji,
                             module_id=chat.module_id, name=name, alias=alias, id=id, uid=uid,
                             vendor_specific=vendor_specific, description=description)
        self.chat: 'Chat' = chat

    def verify(self):
        super().verify()
        assert isinstance(self.chat, Chat)

    def __eq__(self, other):
        return (