HalChat

HalChat - главный класс библиотеки

Информация

Последнею версию можно скачать на https://pypi.org/project/HalChat/

HalChatPy - это HalChat API библиотека для Python. Библиотека асинхронна, что позволяет использовать бота на заднем фоне основного кода. Объединяет: - шифрование (HalChatEncryption) - HTTP API (HalChatAPI) - WebSocket (HalChatWS) - события (onNewMessage и т.д.)

__init__

def __init__(self, code: str, save_file_passwords: str = 'HalChatPasswords.json',
                 auto_join_chats: bool = True,
                 check_bots_messages: bool = False,
                 log_level: int = 1):

Инициализация главного класса Параметры code - ключ API от бота save_file_passwords - путь к файлу где хранятся пароли от чатов auto_join_chats - присоединятся при приглашение в чат автоматически check_bots_messages - получать ли сообщения по протоколу общения между ботами или устройствами log_level - уровень логирования библиотеки Пример

hca = HalChat(codeBot)

event

def event(self, name: str)

Регистрация события Параметры name - имя Пример

@hca.event('onNewMessage')
async def on_new_message(msg,isExistPassword):
    if not isExistPassword:
        return

run

def run(self):

Запуск асинхронного цикла Пример

if __name__ == "__main__":
    hca.run()

close

async def close(self):

Завершение работы Пример

await hca.close()

join_chat_by_invite_id

def join_chat_by_invite_id(self, invite_id: int):

Присоединение к чату по приглашению Параметры invite_id - целочисленный идентификатор приглашения Пример

@hca.event('onNewChat')
async def on_new_chat(chatId,fromId,inviteId):
    hca.join_chat_by_invite_id(inviteId)
    await hca.request_password(chatId)

set_menu

async def set_menu(self, chat_id: int, menu: list):

Установка меню бота в чате Параметры chat_id - целочисленный идентификатор чата menu - список команд Пример

test_menu=[
    {
        "icon":"DxKGzw4YNCPyMBW5VoIcGEKL6HG22bYoE9V43jiaFyPbGSjfXj64x3SrKxnyhEHAVG0GBhiTH8u3gyrjxgoK96RE6Js12wcAhnmf",
        "command":"тест",
        "description":"Тестовая команда"
    }
]
await hca.set_menu(chatId,test_menu)

send_message

async def send_message(self,
                           chat_id: int,
                           message: str,
                           encrypt_id: str=None,
                           attachments: list=[],
                           answer_msg: int=-1,
                           comment_msg: int=-1,
                           sound_msg: str='-1',
                           buttons: list=None,
                           plugins=None
                           ):

Отправка сообщения Параметры chat_Id - целочисленный идентификатор чата message - незашифрованное текстовое сообщение encrypt_id - дополнительный идентификатор шифрования для сообщения, если не указан, будет сгенерирован attachments - список прикреплённых файлов (id HalDrive файлов) answer_msg - целочисленный идентификатор сообщения, на которое отвечает отправляемое comment_msg - целочисленный идентификатор поста, если это сообщение-комментарий sound_msg - звук прихода сообщения (id HalDrive файла) buttons - список кнопок в сообщении plugins - данные для плагинов Пример

buttons_topics=[
    {"text":"Программирование","color":"#ff4f4f"},
    {"text":"Разное","color":"#ff8aeb"},
    {"text":"Чёрный юмор","color":"#000000"},
    {"text":"Каламбуры","color":"#5c7ae5"},
    {"text":"Жуткие","color":"#5ce56a"},
    {"text":"Новогодние","color":"#915ce5"}
]
await hca.send_message(chatId,"Выберите тему анекдотов:",buttons=buttons_topics)

delete_message

async def delete_message(self, chat_id: int, msg_id: int):

Удаление сообщения Параметры chat_id - целочисленный идентификатор чата msg_id - целочисленный идентификатор сообщения Пример

await hca.delete_message(100,102)

edit_message

async def edit_message(self, chat_id: int, msg_id: int, message: str,
                           encrypt_id: str=None, attachments: list=[]):

Изменение сообщения Параметры chat_id - целочисленный идентификатор чата msg_id - целочисленный идентификатор сообщения message - незашифрованное текстовое сообщение encrypt_id - дополнительный идентификатор шифрования для сообщения, если не указан, будет сгенерирован attachments - список прикреплённых файлов (id HalDrive файлов) Пример

await hca.edit_message(
    100, 103, "Новый текст", 
    attachments = [
        "DxKGzw4YNCPyMBW5VoIcGEKL6HG22bYoE9V43jiaFyPbGSjfXj64x3SrKxnyhEHAVG0GBhiTH8u3gyrjxgoK96RE6Js12wcAhnmf"
    ]
)

get_message

async def get_message(self, chat_id: int, msg_id: int):

Получение сообщения Параметры chat_id - целочисленный идентификатор чата msg_id - целочисленный идентификатор сообщения Пример

msg = await hca.get_message(100, 103)

send_bot_message

async def send_bot_message(self, to_id: int, data: str):

Отправка сообщения по протоколу общения между устройствами или ботами. Находится в разработке и сообщения не шифруются. Используется для системы умного дома. Параметры to_id - целочисленный идентификатор получателя data - текст сообщения или json данные Пример

await hca.send_bot_message(2, '{"hi": 0}')