Class Buttons

isRemove

• get isRemove(): boolean

  Признак того, что клавиатуру нужно убрать (см. remove).

  Returns boolean

constructor

• new Buttons(appContext: AppContext): Buttons

  Создает новый экземпляр коллекции кнопок: инициализирует пустой массив кнопок и сохраняет контекст приложения.

  Parameters

  • appContext: AppContext

    Контекст приложения. Обычно не создаётся вручную — передаётся через контроллер (this.buttons.addBtn('caption')).

  Returns Buttons

addBtn

• addBtn(
      title: string | null,
      url?: string | null,
      payload?: TButtonPayload,
      options?: IButtonOptions,
  ): this

  Добавляет интерактивную кнопку в коллекцию.

  Parameters

  • title: string | null

    Текст кнопки

  • Optionalurl: string | null = ''

    URL для перехода

  • Optionalpayload: TButtonPayload = ''

    Дополнительные данные

  • Optionaloptions: IButtonOptions = {}

    Дополнительные параметры

  Returns this

  Remarks

  Кнопка с пустым title молча игнорируется (не добавляется в коллекцию).

  Example

  // Простая кнопка
  buttons.addBtn('Нажми меня');
  
  // Кнопка с URL и payload
  buttons.addBtn('Перейти', 'http://localhost', { action: 'navigate' });
  Copy

addLink

• addLink(
      title: string | null,
      url?: string,
      payload?: TButtonPayload,
      options?: IButtonOptions,
  ): this

  Добавляет кнопку-ссылку в коллекцию.

  Parameters

  • title: string | null

    Текст кнопки

  • Optionalurl: string = ''

    URL для перехода

  • Optionalpayload: TButtonPayload = ''

    Дополнительные данные

  • Optionaloptions: IButtonOptions = {}

    Дополнительные параметры

  Returns this

  Example

  // Простая ссылка
  buttons.addLink('Перейти на сайт', 'http://localhost');
  
  // Ссылка с payload
  buttons.addLink('Документация', 'http://localhost', { section: 'api' });
  Copy

clear

• clear(): void

  Очищает массив кнопок.

  Это именно «начать список заново», а не «убрать клавиатуру у пользователя»: пустой список кнопок платформе не отправляется. Чтобы снять уже показанную клавиатуру, используйте remove.

  Returns void

getButtonJson

• getButtonJson<T = unknown, TType = string | Record<string, unknown> | null>(
      buttonProcessing: TButtonProcessing<T | null, TType>,
  ): string | null

  Возвращает JSON-представление кнопок для указанной платформы.

  Type Parameters

  • T = unknown
  • TType = string | Record<string, unknown> | null

  Parameters

  • buttonProcessing: TButtonProcessing<T | null, TType>

    Функция обработки кнопок для платформы

  Returns string | null

  JSON-строка кнопок или null если кнопок нет

getButtons

• getButtons<T = unknown, TType = string | Record<string, unknown> | null>(
      buttonProcessing: TButtonProcessing<T | null, TType>,
  ): T | null

  Возвращает кнопки в формате указанной платформы.

  Метод сам не преобразует кнопки: он передаёт массив во внешнюю функцию buttonProcessing (её предоставляет адаптер платформы) и возвращает её результат.

  Type Parameters

  • T = unknown
  • TType = string | Record<string, unknown> | null

  Parameters

  • buttonProcessing: TButtonProcessing<T | null, TType>

    Функция обработки кнопок для платформы

  Returns T | null

  Результат функции обработки (формат зависит от платформы) или null

remove

• remove(): this

  Просит платформу убрать ранее показанную клавиатуру.

  Актуально только для платформ, где клавиатура «прилипает» к диалогу и живёт до следующего явного изменения — Telegram (reply-клавиатура) и VK. У остальных клавиатура привязана к конкретному сообщению и исчезает сама, там вызов ничего не меняет. clear для этого не подходит: пустой список кнопок платформе не отправляется.

  Returns this

  Example

  // Диалог закончился — убираем клавиатуру
  ctx.buttons.remove();
  ctx.text = 'Спасибо, заказ оформлен!';
  Copy

row

• row(): this

  Завершает текущий ряд кнопок: следующие кнопки пойдут в новую строку.

  Кнопки, добавленные до первого вызова, образуют первый ряд. Без вызова row() раскладка прежняя — каждая кнопка отдельной строкой. Ряд учитывают чат-платформы (Telegram, VK, MAX, Viber); если в ряду больше кнопок, чем разрешает платформа, лишние переносятся на следующую строку с предупреждением в лог. Голосовые платформы (Алиса, Маруся, SmartApp) раскладку кнопок не поддерживают — у них ряд ни на что не влияет.

  Технически ряд — это общая группа options._group: кнопки, у которых группа задана явно, её сохраняют.

  Returns this

  Example

  ctx.buttons
      .addBtn('Да')
      .addBtn('Нет')
      .row()
      .addBtn('Помощь');
  // Telegram/VK/MAX/Viber: [Да] [Нет]
  //                        [Помощь]
  Copy

setAppContext

• setAppContext(appContext: AppContext): this

  Устанавливает контекст приложения.

  Parameters

  • appContext: AppContext

    Контекст приложения

  Returns this

  Текущий экземпляр для цепочки вызовов

buttons

Static ReadonlyB_BTN

Static ReadonlyB_LINK