Telethon/readthedocs/extra/basic/telegram-client.rst

.. _telegram-client:

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


Introduction
************

.. note::

    Make sure to use the friendly methods described in :ref:`telethon-client`!
    This section is just an introduction to using the client, but all the
    available methods are in the :ref:`telethon-client` reference, including
    detailed descriptions to what they do.

The :ref:`TelegramClient <telethon-client>` is the
central class of the library, the one you will be using most of the time. For
this reason, it's important to know what it offers.

Since we're working with Python, one must not forget that we can do
``help(client)`` or ``help(TelegramClient)`` at any time for a more
detailed description and a list of all the available methods. Calling
``help()`` from an interactive Python session will always list all the
methods for any object, even yours!

Interacting with the Telegram API is done through sending **requests**,
this is, any "method" listed on the API. There are a few methods (and
growing!) on the :ref:`TelegramClient <telethon-client>` class that abstract
you from the need of manually importing the requests you need.

For instance, retrieving your own user can be done in a single line
(assuming you have ``from telethon import sync`` or ``import telethon.sync``):

.. code-block:: python

    myself = client.get_me()

Internally, this method has sent a request to Telegram, who replied with
the information about your own user, and then the desired information
was extracted from their response.

If you want to retrieve any other user, chat or channel (channels are a
special subset of chats), you want to retrieve their "entity". This is
how the library refers to either of these:

.. code-block:: python

    # The method will infer that you've passed an username
    # It also accepts phone numbers, and will get the user
    # from your contact list.
    lonami = client.get_entity('lonami')

The so called "entities" are another important whole concept on its own,
but for now you don't need to worry about it. Simply know that they are
a good way to get information about an user, chat or channel.

Many other common methods for quick scripts are also available:

.. code-block:: python

    # Note that you can use 'me' or 'self' to message yourself
    client.send_message('username', 'Hello World from Telethon!')

    # .send_message's parse mode defaults to markdown, so you
    # can use **bold**, __italics__, [links](https://example.com), `code`,
    # and even [mentions](@username)/[mentions](tg://user?id=123456789)
    client.send_message('username', '**Using** __markdown__ `too`!')

    client.send_file('username', '/home/myself/Pictures/holidays.jpg')

    # The utils package has some goodies, like .get_display_name()
    from telethon import utils
    for message in client.iter_messages('username', limit=10):
        print(utils.get_display_name(message.sender), message.message)

    # Dialogs are the conversations you have open
    for dialog in client.get_dialogs(limit=10):
        print(dialog.name, dialog.draft.text)

    # Default path is the working directory
    client.download_profile_photo('username')

    # Call .disconnect() when you're done
    client.disconnect()

Remember that you can call ``.stringify()`` to any object Telegram returns
to pretty print it. Calling ``str(result)`` does the same operation, but on
a single line.


Available methods
*****************

The :ref:`reference <telethon-package>` lists all the "handy" methods
available for you to use in the :ref:`TelegramClient <telethon-client>` class.
These are simply wrappers around the "raw" Telegram API, making it much more
manageable and easier to work with.

Please refer to :ref:`accessing-the-full-api` if these aren't enough,
and don't be afraid to read the source code of the InteractiveTelegramClient_
or even the TelegramClient_ itself to learn how it works.

See the mentioned :ref:`telethon-client` to find the available methods.

.. _InteractiveTelegramClient: https://github.com/LonamiWebs/Telethon/blob/master/telethon_examples/interactive_telegram_client.py
.. _TelegramClient: https://github.com/LonamiWebs/Telethon/blob/master/telethon/telegram_client.py