Class User

src/telegram/_user.py:81–3067

This object represents a Telegram user or bot. Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`id` is equal. .. versionchanged:: 20.0 The following are now keyword-only arguments in Bot methods:

class User(TelegramObject):
    """This object represents a Telegram user or bot.

    Objects of this class are comparable in terms of equality. Two objects of this class are
    considered equal, if their :attr:`id` is equal.

    .. versionchanged:: 20.0
        The following are now keyword-only arguments in Bot methods:
        ``location``, ``filename``, ``venue``, ``contact``,
        ``{read, write, connect, pool}_timeout`` ``api_kwargs``. Use a named argument for those,
        and notice that some positional arguments changed position as a result.

    Args:
        id (:obj:`int`): Unique identifier for this user or bot.
        is_bot (:obj:`bool`): :obj:`True`, if this user is a bot.
        first_name (:obj:`str`): User's or bot's first name.
        last_name (:obj:`str`, optional): User's or bot's last name.
        username (:obj:`str`, optional): User's or bot's username.
        language_code (:obj:`str`, optional): IETF language tag of the user's language.
        can_join_groups (:obj:`str`, optional): :obj:`True`, if the bot can be invited to groups.
            Returned only in :meth:`telegram.Bot.get_me`.
        can_read_all_group_messages (:obj:`str`, optional): :obj:`True`, if privacy mode is
            disabled for the bot. Returned only in :meth:`telegram.Bot.get_me`.
        supports_inline_queries (:obj:`str`, optional): :obj:`True`, if the bot supports inline
            queries. Returned only in :meth:`telegram.Bot.get_me`.

        is_premium (:obj:`bool`, optional): :obj:`True`, if this user is a Telegram Premium user.

            .. versionadded:: 20.0
        added_to_attachment_menu (:obj:`bool`, optional): :obj:`True`, if this user added
            the bot to the attachment menu.

            .. versionadded:: 20.0
        can_connect_to_business (:obj:`bool`, optional): :obj:`True`,  if the bot can be connected
            to a user account to manage it. Returned only in
            :meth:`telegram.Bot.get_me`.

            .. versionadded:: 21.1
        has_main_web_app (:obj:`bool`, optional): :obj:`True`, if the bot has the main Web App.
            Returned only in :meth:`telegram.Bot.get_me`.

            .. versionadded:: 21.5
        has_topics_enabled (:obj:`bool`, optional): :obj:`True`, if the bot has forum topic mode
            enabled in private chats. Returned only in :meth:`telegram.Bot.get_me`.

            .. versionadded:: 22.6
        allows_users_to_create_topics (:obj:`bool`, optional): :obj:`True`, if the bot allows
            users to create and delete topics in private chats. Returned only in
            :meth:`telegram.Bot.get_me`.

            .. versionadded:: 22.7
        can_manage_bots (:obj:`bool`, optional): :obj:`True`, if other bots can be created to be
            controlled by the bot. Returned only in :meth:`telegram.Bot.get_me`.

            .. versionadded:: 22.8
        supports_guest_queries (:obj:`bool`, optional): :obj:`True`, if the bot supports guest
            queries from chats it is not a member of. Returned only in
            :meth:`telegram.Bot.get_me`.