События¶
Каждое событие наследуется от класса SimpleBotEvent
vkwave.bots.addons.easy.easy_handlers.SimpleBotEvent (BotEvent)
¶
Базовый класс события.
api_ctx: APIOptionsRequestContext
inherited
property
readonly
¶
Контекст API ВК. Позволяет использовать все методы API ВК от имени бота.
Returns:
| Type | Description |
|---|---|
APIOptionsRequestContext |
Контекст API |
attachments: Optional[List[vkwave.bots.addons.easy.easy_handlers.SimpleAttachment]]
property
readonly
¶
Получает список вложений
Returns:
| Type | Description |
|---|---|
Optional[List[SimpleAttachment]] |
список вложений |
from_id: int
property
readonly
¶
Получает идентификатор отправителя
Returns:
| Type | Description |
|---|---|
int |
идентификатор отправителя |
payload: Optional[dict]
property
readonly
¶
Получает payload события
Returns:
| Type | Description |
|---|---|
int |
payload события |
peer_id: int
property
readonly
¶
Получает идентификатор чата
Returns:
| Type | Description |
|---|---|
int |
идентификатор чата |
text: str
property
readonly
¶
Получает текст сообщения
Returns:
| Type | Description |
|---|---|
str |
Текст |
user_id: int
property
readonly
¶
Шорткат для выбора from_id или peer_id
Returns:
| Type | Description |
|---|---|
int |
идентификатор пользователя |
answer(self, message=None, domain=None, lat=None, long=None, attachment=None, reply_to=None, forward_messages=None, forward=None, sticker_id=None, group_id=None, keyboard=None, template=None, payload=None, content_source=None, dont_parse_links=None, disable_mentions=None, intent=None, subscribe_id=None, expire_ttl=None, silent=None)
async
¶
Шорткат для отправки сообщения пользователю, от которого пришло событие.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message |
Optional[str] |
Текст. |
None |
domain |
Optional[str] |
Короткая ссылка пользователя. |
None |
lat |
Optional[int] |
Широта. |
None |
long |
Optional[int] |
Долгота. |
None |
attachment |
Optional[str] |
Вложения (строка с идентификаторами, разделёнными запятой). |
None |
reply_to |
Optional[int] |
Идентификатор сообщения, на которое нужно ответить. |
None |
forward_messages |
Optional[List[int]] |
Идентификаторы пересылаемых сообщений. |
None |
forward |
Optional[str] |
JSON-объект (подробнее в документации ВК). |
None |
sticker_id |
Optional[int] |
Идентификатор прикрепляемого стикера. |
None |
group_id |
Optional[int] |
Идентификатор группы. |
None |
keyboard |
Optional[str] |
Клавиатура. |
None |
template |
Optional[str] |
Шаблон (карусель, например). |
None |
payload |
Optional[str] |
Payload. |
None |
content_source |
Optional[str] |
Источник пользовательского контента. |
None |
dont_parse_links |
Optional[bool] |
1 — не создавать сниппет ссылки из сообщения. |
None |
disable_mentions |
Optional[bool] |
1 — отключить создание упоминаний. |
None |
intent |
Optional[str] |
Строка, описывающая интенты. |
None |
subscribe_id |
Optional[int] |
число, которое в будущем будет предназначено для работы с интентами. |
None |
expire_ttl |
Optional[int] |
???. |
None |
silent |
Optional[bool] |
???. |
None |
Returns:
| Type | Description |
|---|---|
MessagesSendResponse |
Ответ сервера |
callback_answer(self, event_data)
async
¶
Ответ на нажатие callback кнопки.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
event_data |
Dict[str, str] |
описание данных для ответа на callback |
required |
Exceptions:
| Type | Description |
|---|---|
RuntimeError |
Если вызван, когда событие не MessageEvent типа. |
Returns:
| Type | Description |
|---|---|
BaseOkResponse |
Результат запроса |
edit(self, message=None, lat=None, long=None, attachment=None, keep_forward_messages=None, keep_snippets=None, group_id=None, dont_parse_links=None, disable_mentions=None, message_id=None, conversation_message_id=None, template=None, keyboard=None)
async
¶
Шорткат для редактирования своего сообщения.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message |
Optional[str] |
Текст. |
None |
lat |
Optional[int] |
Широта. |
None |
long |
Optional[int] |
Долгота. |
None |
attachment |
Optional[str] |
Вложения (строка с идентификаторами, разделёнными запятой). |
None |
keep_forward_messages |
Optional[BaseBoolInt] |
— сохранить прикрепленные пересланные сообщения. |
None |
keep_snippets |
Optional[BaseBoolInt] |
1 — сохранить прикрепленные внешние ссылки (сниппеты). |
None |
group_id |
Optional[int] |
Идентификатор группы. |
None |
dont_parse_links |
Optional[bool] |
1 — не создавать сниппет ссылки из сообщения. |
None |
disable_mentions |
Optional[bool] |
1 — отключить уведомление об упоминании в сообщении. |
None |
message_id |
Optional[int] |
Идентификатор сообщения. |
None |
conversation_message_id |
Optional[int] |
Идентификатор сообщения в беседе. |
None |
template |
Optional[str] |
Шаблон. |
None |
keyboard |
Optional[str] |
Клавиатура. |
None |
Returns:
| Type | Description |
|---|---|
MessagesEditResponse |
Ответ сервера |
get_user(self, raw_mode=False, **kwargs)
async
¶
Получение объекта пользователя
Returns:
| Type | Description |
|---|---|
Union["UsersUser", dict] |
Объект пользователя |
reply(self, message=None, domain=None, lat=None, long=None, attachment=None, sticker_id=None, group_id=None, keyboard=None, template=None, payload=None, content_source=None, dont_parse_links=None, disable_mentions=None, intent=None, subscribe_id=None, expire_ttl=None, silent=None, json_serialize=<function dumps at 0x00000256D4FD4DC0>)
async
¶
Шорткат для отправки ответа на сообщение пользователю, от которого пришло событие
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message |
Optional[str] |
Текст. |
None |
domain |
Optional[str] |
Короткая ссылка пользователя. |
None |
lat |
Optional[int] |
Широта. |
None |
long |
Optional[int] |
Долгота. |
None |
attachment |
Optional[str] |
Вложения (строка с идентификаторами, разделёнными запятой). |
None |
sticker_id |
Optional[int] |
Идентификатор прикрепляемого стикера. |
None |
group_id |
Optional[int] |
Идентификатор группы. |
None |
keyboard |
Optional[str] |
Клавиатура. |
None |
template |
Optional[str] |
Шаблон (карусель, например). |
None |
payload |
Optional[str] |
Payload. |
None |
content_source |
Optional[str] |
Источник пользовательского контента. |
None |
dont_parse_links |
Optional[bool] |
1 — не создавать сниппет ссылки из сообщения. |
None |
disable_mentions |
Optional[bool] |
1 — отключить создание упоминаний. |
None |
intent |
Optional[str] |
Строка, описывающая интенты. |
None |
subscribe_id |
Optional[int] |
число, которое в будущем будет предназначено для работы с интентами. |
None |
expire_ttl |
Optional[int] |
???. |
None |
silent |
Optional[bool] |
???. |
None |
json_serialize |
JSONEncoder |
сериализация. |
<function dumps at 0x00000256D4FD4DC0> |
Returns:
| Type | Description |
|---|---|
MessagesSendResponse |
MessagesSendResponse - Ответ сервера |
set_activity(self, type=None, user_id=None, group_id=None)
async
¶
Изменение статуса активности
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type |
Optional[str] |
Тип активности. ( |
None |
user_id |
Optional[int] |
Идентификатор пользователя-получателя. |
None |
group_id |
Optional[int] |
Идентификатор группы. |
None |
Returns:
| Type | Description |
|---|---|
MessagesSendResponse |
Результат запроса. |