documentation

This commit is contained in:
mihalin 2022-03-17 09:11:15 +03:00
parent 8efc40730f
commit 02e06863e7
4 changed files with 28 additions and 9 deletions

View File

@ -15,7 +15,7 @@
about about
quick_start quick_start
templates templates
threads options
developer developer
additional additional

View File

@ -1,6 +1,11 @@
Потоки сообщений Опции
============= =============
.. _threads:
Потоки сообщений
----------------
Olgram пересылает сообщения так, чтобы сообщения от одного и того же пользователя оставались в одном и том же Olgram пересылает сообщения так, чтобы сообщения от одного и того же пользователя оставались в одном и том же
потоке сообщений. Тогда по кнопке View Replies можно увидеть диалог с этим пользователем, а все остальные сообщения из потоке сообщений. Тогда по кнопке View Replies можно увидеть диалог с этим пользователем, а все остальные сообщения из
чата скрываются: чата скрываются:
@ -8,11 +13,26 @@ Olgram пересылает сообщения так, чтобы сообщен
.. image:: ../images/thread.gif .. image:: ../images/thread.gif
:width: 300 :width: 300
Как настроить потоки сообщений **Как настроить потоки сообщений**
---------------------
Привяжите вашего feedback бота к групповому чату :doc:`quick_start`. В настройках группового чата откройте историю Привяжите вашего feedback бота к групповому чату :doc:`quick_start`. В настройках группового чата откройте историю
чата для новых участников чата ("Chat history for new members -> Visible"). Изменение этой настройки превращает чат в чата для новых участников чата ("Chat history for new members -> Visible"). Изменение этой настройки превращает чат в
`супергруппу <https://telegram.org/blog/supergroups5k>`_: потоки сообщений работают только в таких группах `супергруппу <https://telegram.org/blog/supergroups5k>`_: потоки сообщений работают только в таких группах
Включите потоки в настройках бота Olgram Опции->Потоки сообщений Включите потоки в настройках бота Olgram Опции->Потоки сообщений
.. user_info:
Данные пользователя
-------------------
При получении входящего сообщения Olgram может пересылать дополнительную информацию об отправителе. Имя, username и
идентификатор пользователя. Например так:
.. image: ../images/user_info.jpg
:width: 300
Эта функция может быть полезной, чтобы отличить одного пользователя от другого. Имя и username можно сменить, но
идентификатор #id остаётся неизменным для одного и того же аккаунта.
Включить эту функцию можно в настройках бота Olgram Опции->Данные пользователя

View File

@ -170,8 +170,8 @@ async def send_bot_settings_menu(bot: Bot, call: types.CallbackQuery):
thread_turn = "включены" if bot.enable_threads else "выключены" thread_turn = "включены" if bot.enable_threads else "выключены"
info_turn = "включена" if bot.enable_additional_info else "выключена" info_turn = "включена" if bot.enable_additional_info else "выключена"
text = dedent(f""" text = dedent(f"""
<a href="https://olgram.readthedocs.io/ru/latest/threads.html">Потоки сообщений</a>: <b>{thread_turn}</b> <a href="https://olgram.readthedocs.io/ru/latest/options.html#threads">Потоки сообщений</a>: <b>{thread_turn}</b>
<a href="https://olgram.readthedocs.io/ru/latest/user_info.html">Дополнительная информация</a>: <b>{info_turn}</b> <a href="https://olgram.readthedocs.io/ru/latest/options.html#user_info">Данные пользователя</a>: <b>{info_turn}</b>
""") """)
await edit_or_create(call, text, reply_markup=keyboard, parse_mode="HTML") await edit_or_create(call, text, reply_markup=keyboard, parse_mode="HTML")

View File

@ -38,9 +38,8 @@ def _thread_uniqie_id(bot_id: int, chat_id: int) -> str:
async def send_user_message(message: types.Message, super_chat_id: int, bot): async def send_user_message(message: types.Message, super_chat_id: int, bot):
"""Переслать сообщение от пользователя, добавлять к нему user info при необходимости""" """Переслать сообщение от пользователя, добавлять к нему user info при необходимости"""
if bot.enable_additional_info: if bot.enable_additional_info:
user_info = "От пользователя: " user_info = "Сообщение от пользователя "
if message.from_user.full_name: user_info += message.from_user.full_name
user_info += message.from_user.full_name
if message.from_user.username: if message.from_user.username:
user_info += " | @" + message.from_user.username user_info += " | @" + message.from_user.username
user_info += f" | #{message.from_user.id}" user_info += f" | #{message.from_user.id}"