Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ma-Mush authored Oct 1, 2021
1 parent 295c5a7 commit 5e1efe6
Showing 1 changed file with 6 additions and 11 deletions.
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ photo | Массив с путями до фотографий, которые
files | Массив с путями до файлов, которые нужно отправить
keyboard | Клавиатура, полученная с помощью _.new_keyboard()

## _.check_new_msg()
## _.check_new_msg(chat=False)
Используется для проверки новых сообщений (возвращает True / False)
Параметры:
Название | Что это?
Expand All @@ -79,25 +79,23 @@ chat | Для беседы вы используете бота или нет (T
## _.get_event()
Возвращает данные о новом сообщении при его наличии. Основные параметры выданных данных - user_id / chat_id, text. Подробнее в документации vk_api.

## _.send_photo(file_names, userid, msg=None, chats=False)
## _.send_photo(file_names, userid, msg=None)
Отправляет фото с сообщением / без него пользователю/беседе.
Параметры:
Название | Что это?
------------- | -------------
file_name | массив файлов в директории запущенного питон-файла или полный путь к нему
userid | ID пользователя/беседы для отправкии сообщеия
msg | Текст сообщения (по умолчанию без него)
chat | Для беседы вы используете бота или нет (True / False)? По умолчанию False

## _.send_file(file_names, userid, msg=None, chats=False)
## _.send_file(file_names, userid, msg=None)
Отправляет файл с сообщением / без него пользователю/беседе.
Параметры:
Название | Что это?
------------- | -------------
file_names | Массив файлов в директории запущенного питон-файла или полный путь к нему
userid | ID пользователя/беседы для отправкии сообщеия
msg | Текст сообщения (по умолчанию без него)
chat | Для беседы вы используете бота или нет (True / False)? По умолчанию False

## _.new_keyboard(dict, perm=True)
Создание клавиатуры (возвращает данные в переменную для отправки)
Expand All @@ -116,34 +114,31 @@ perm | Будет ли сохранятся клавиатура после на
+ Для открытия ссылки на любой ресурс - {"open_link":{"label":текст кнопки, "link":ссылка с http / https}}
+ Для создания callback (inline) кнопки - {"callback":{"label":текст кнопки, "color":цвет кнопки, "payload":данные для callback api (по умолчанию None)}}

## _.send_keyboard(keyboard, userid, msg='Клавиатура!', chats=False)
## _.send_keyboard(keyboard, userid, msg='Клавиатура!')
Отправляем пользователю созданнуб раннее клавиатуру
Параметры:
Название | Что это?
------------- | -------------
keyboard | Клавиатура, созданная раннее
userid | Ид пользователя / беседы
msg | Сообщение при отправке клавиатуры (по умолчанию 'Клавиатура!')
chats | Для беседы вы используете бота или нет (True / False)? По умолчанию False

## _.delete_keyboard(userid, msg='Клавиатура закрыта!', chats=False)
## _.delete_keyboard(userid, msg='Клавиатура закрыта!')
Удаляет клавиатуру у пользователя.
Параметры:
Название | Что это?
------------- | -------------
userid | Ид пользователя / беседы
msg | Сообщение при удалении клавиатуры (по умолчанию 'Клавиатура закрыта!')
chats | Для беседы вы используете бота или нет (True / False)? По умолчанию False

## _.mailing(text, userids, safe=[], chats=False)
## _.mailing(text, userids, safe=[])
Делает рассылку независимо от других действий (бот будет отвечать во время рассылки).
Параметры:
Название | Что это?
------------- | -------------
text | Текст сообщения
userids | Массив с ID пользователей / бесед (например - [123456, 1234567, 12345678])
safe | Массив с ID пользователей / бесед, которые отказались от рассылки, по умолчанию таких нет
chat | Для беседы вы используете бота или нет (True / False)? По умолчанию False

## _.get_all_message_data()
Возвращает массив со словарями с данными о последних сообщениях всех чатов, где находился бот (и ЛС, и беседы, и боты). Внимание! Функция достаточно долгая для ботов с большой аудиторией. Может занимать от долей секунды до нескольких минут.
Expand Down

0 comments on commit 5e1efe6

Please sign in to comment.