Перейти к содержанию

Package: maxapi.types.attachments.buttons

maxapi.types.attachments.buttons

attachment_button

AttachmentButton

Bases: Attachment

Модель кнопки вложения для сообщения.

Attributes:

Name Type Description
type Literal[INLINE_KEYBOARD]

Тип кнопки, фиксированное значение 'inline_keyboard'

payload Optional[Union[AttachmentUpload, PhotoAttachmentPayload, OtherAttachmentPayload, ButtonsPayload, ContactAttachmentPayload, StickerAttachmentPayload]]

Полезная нагрузка кнопки (массив рядов кнопок)

button

Button

Bases: BaseModel

Базовая модель кнопки для сообщений.

Attributes:

Name Type Description
type ButtonType

Тип кнопки (определяет её поведение и функционал)

text str

Текст, отображаемый на кнопке (1-64 символа)

callback_button

CallbackButton

Bases: Button

Кнопка с callback-действием.

Attributes:

Name Type Description
type ButtonType

Тип кнопки (фиксированное значение ButtonType.CALLBACK)

text str

Текст, отображаемый на кнопке (наследуется от Button)

payload Optional[str]

Дополнительные данные (до 256 символов), передаваемые при нажатии

intent Intent

Намерение кнопки (визуальный стиль и поведение)

chat_button

ChatButton(**data)

Bases: Button

.. deprecated:: 0.9.14 Используйте другие типы кнопок.

Attributes:

Name Type Description
text str

Текст кнопки (наследуется от Button)

chat_title str

Название чата (до 128 символов)

chat_description Optional[str]

Описание чата (до 256 символов)

start_payload Optional[str]

Данные, передаваемые при старте чата (до 512 символов)

uuid Optional[int]

Уникальный идентификатор чата

Source code in maxapi/types/attachments/buttons/chat_button.py
def __init__(self, **data):
    super().__init__(**data)
    warnings.warn(
        "ChatButton устарел и будет удален в будущих версиях. "
        "Используйте другие типы кнопок.",
        DeprecationWarning,
        stacklevel=2,
    )

Bases: Button

Кнопка с внешней ссылкой.

Attributes:

Name Type Description
url Optional[str]

Ссылка для перехода (должна содержать http/https)

message_button

MessageButton

Bases: Button

Кнопка для отправки текста

Attributes:

Name Type Description
type ButtonType

Тип кнопки (определяет её поведение и функционал)

text str

Отправляемый текст

open_app_button

OpenAppButton

Bases: Button

Кнопка для открытия приложения

Attributes:

Name Type Description
text str

Видимый текст кнопки

web_app Optional[str]

Публичное имя (username) бота или ссылка на него, чьё мини-приложение надо запустить

contact_id Optional[int]

Идентификатор бота, чьё мини-приложение надо запустить

payload Optional[str]

Параметр запуска, который будет передан в initData мини-приложения

request_contact

RequestContactButton

Bases: Button

Кнопка с контактом

Attributes:

Name Type Description
text str

Текст кнопки

request_geo_location_button

RequestGeoLocationButton

Bases: Button

Кнопка запроса геолокации пользователя.

Attributes:

Name Type Description
quick bool

Если True, запрашивает геолокацию без дополнительного подтверждения пользователя (по умолчанию False)