Telethon/readthedocs/modules/client.rst

.. _telethon-client:

==============
TelegramClient
==============

.. currentmodule:: telethon.client

The `TelegramClient <telegramclient.TelegramClient>` aggregates several mixin
classes to provide all the common functionality in a nice, Pythonic interface.
Each mixin has its own methods, which you all can use.

**In short, to create a client you must run:**

.. code-block:: python

    from telethon import TelegramClient

    client = TelegramClient(name, api_id, api_hash)

    async def main():
        # Now you can use all client methods listed below, like for example...
        async with client.start():
            await client.send_message('me', 'Hello to myself!')

    asyncio.run(main())


You **don't** need to import these `AuthMethods`, `MessageMethods`, etc.
Together they are the `TelegramClient <telegramclient.TelegramClient>` and
you can access all of their methods.

See :ref:`client-ref` for a short summary.

.. automodule:: telethon.client.telegramclient
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.telegrambaseclient
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.account
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.auth
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.bots
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.buttons
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.chats
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.dialogs
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.downloads
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.messageparse
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.messages
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.updates
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.uploads
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: telethon.client.users
    :members:
    :undoc-members:
    :show-inheritance: