Welcome to TgBot’s documentation!¶
bot module¶
dialog_flow module¶
Модуль для взаимодействия с DialogFlow
| author: | Melnikov Dmitry |
|---|
-
class
dialog_flow.DialogFlow(token)¶ Bases:
objectКласс, предоставляющий интерфейс для взаимодействия с Dialog Flow
-
sendMessage(text, sessionId)¶ Метод отправки сообщения в Dialog Flow
Parameters: text – текст отправляемого сообщения Returns: словарь, содержащий поля “speech”, “intentName” и “parametrs” Return type: dict Raise: DialogFlowException
-
-
exception
dialog_flow.DialogFlowException¶ Bases:
ExceptionКласс исключений, возникающих при обращении к Dialog Flow
handlers package¶
Submodules¶
handlers.base_handler module¶
-
class
handlers.base_handler.BaseHandler(bot, message, server, df=None)¶ Bases:
objectБазовый класс обработчика сообщений
-
handle()¶ Метод для обработки сообщения. Переопределяется в дочерних классах
-
sendMessage(id, text)¶ Метод отправки сообщения пользователю
Parameters: - id – id пользователя
- text – текст сообщения
-
handlers.text_handler module¶
-
class
handlers.text_handler.TextHandler(bot, message, server, df=None)¶ Bases:
handlers.base_handler.BaseHandlerКласс обработчика текстовых сообщений
-
handle()¶ Метод обработки сообщения
-
handlers.voice_handler module¶
Module contents¶
main_server module¶
Модуль для взаимодействия с главным сервером
-
class
main_server.MainServer(host)¶ Bases:
objectКласс для взаимодействия с главным сервером приложения
-
createRoom(message)¶ Запрос на создание комнаты
Parameters: message – сообщение пользователя (telebot.types.Message) Returns: результат запроса(True/False), признак дополнения сообщения, сообщение
-
getRoomInfo(message, roomId)¶ Запрос на получение списка комнат
Parameters: - message – сообщение пользователя (telebot.types.Message)
- roomId – id группы
Returns: результат запроса(True/False), признак дополнения сообщения, сооsщение
-
getRoomsList(message, role)¶ Запрос на получение списка комнат
Parameters: - message – сообщение пользователя (telebot.types.Message)
- role – роль пользователя в группе (админ, читатель, модератор)
Returns: результат запроса(True/False), признак дополнения сообщения, сообщение
-
sendMessage(message, roomId, text)¶ Запрос на отправку сообщения в группу
Parameters: - message – сообщение пользователя (telebot.types.Message)
- roomId – id группы
- text – текст для рассылки членам группы
Returns: результат запроса(True/False), признак дополнения сообщения, сообщение
-
sendRequest(intentName, message, parameters)¶ - Метод для отправки запроса на сервер.
- На основании значения intentName принимается решение, какой запрос отправлять.
Parameters: - intentName – имя интента, полученноe из Dialog Flow
- message – сообщение пользователя (telebot.types.Message)
- parameters – данные для запроса
Returns: результат запроса(True/False), признак дополнения сообщения, сообщение
-
subscribe(message, roomId)¶ Запрос на подписку в группу
Parameters: - message – сообщение пользователя (telebot.types.Message)
- roomId – id группы
Returns: результат запроса(True/False), признак дополнения сообщения, сообщение
-