Class Buttons

constructor

• new Buttons(appContext: AppContext): Buttons

  Создает новый экземпляр коллекции кнопок. Инициализирует все массивы и устанавливает тип кнопок по умолчанию для Алисы.

  Parameters

  • appContext: AppContext

    Контекст приложения. ⚠️ Обычно НЕ создаётся вручную — автоматически передаётся через контроллер:

    // Правильно — через контроллер:
    this.buttons.addBtn('caption');
    
    // НЕ рекомендуется — ручное создание:
    new Buttons(this.appContext); // appContext берётся из контроллера
    Copy

  Returns Buttons

buttons

Static ReadonlyB_BTN

Static ReadonlyB_LINK

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

  Example

  // Простая кнопка
  buttons.addBtn('Нажми меня');
  
  // Кнопка с URL и payload
  buttons.addBtn('Перейти', 'https://example.com', { 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('Перейти на сайт', 'https://example.com');
  
  // Ссылка с payload
  buttons.addLink('Документация', 'https://docs.example.com', { section: 'api' });
  Copy

clear

• clear(): void

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

  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

getButtons

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

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

  Type Parameters

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

  Parameters

  • buttonProcessing: TButtonProcessing<T | null, TType>

  Returns T | null

setAppContext

• setAppContext(appContext: AppContext): this

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

  Parameters

  • appContext: AppContext

  Returns this