Class Card

constructor

• new Card(appContext: AppContext): Card

  Карточка с изображениями, заголовком и кнопками.

  Предоставляет унифицированный интерфейс для описания контента. Фактическая адаптация под формат целевой платформы происходит в адаптере платформы при вызове метода getCards().

  Parameters

  • appContext: AppContext

    Контекст приложения. Обычно не создаётся вручную — передаётся через контроллер (this.card.addImage('token', 'Title')).

  Returns Card

button

card.addButton('Купить');
card.addButton({
    title: 'Подробнее',
    url: 'http://localhost'
});
Copy

desc

card.setDescription('Подробное описание товара');
Copy

images

card.addImage('product.jpg', 'Название товара', 'Описание товара');
Copy

isOne

card.isOne = true; // Отобразить только первый элемент
Copy

isUsedGallery

card.isUsedGallery = true; // Включить режим галереи
Copy

template

card.template = {
    type: 'custom_card',
    content: { ... }
};
Copy

title

card.setTitle('Название товара');
Copy

addButton

• addButton(button: TButton): this

  Добавляет кнопку в карточку.

  Parameters

  • button: TButton

    Кнопка для добавления (строка или объект)

  Returns this

  Example

  // Добавление простой кнопки
  card.addButton('Купить');
  
  // Добавление кнопки с дополнительными параметрами
  card.addButton({
      title: 'Подробнее',
      url: 'http://localhost',
      payload: { action: 'details' }
  });
  Copy

addImage

• addImage(
      image: string | null,
      title?: string,
      desc?: string,
      button?: TButton | null,
  ): this

  Добавляет изображение в карточку.

  Parameters

  • image: string | null

    Идентификатор или URL изображения

  • title: string = ''

    Заголовок изображения

  • Optionaldesc: string = ''

    Описание изображения

  • Optionalbutton: TButton | null = null

    Кнопки для элемента

  Returns this

  Remarks

  Ограничения на изображения:

  • Алиса: до 1MB, 1024x1024px, JPG/PNG
  • VK: до 5MB, рекомендуется 13:8, JPG/PNG/GIF
  • Telegram: до 10MB, 1280x1280px, JPG/PNG/WEBP
  • Viber: до 1MB, рекомендуется 400x400px, JPG/PNG

  Example

  // Добавление одного изображения
  card.addImage('image.jpg', 'Название', 'Описание');
  
  // Добавление изображения с кнопкой
  card.addImage('product.jpg', 'Товар', 'Описание', {
      title: 'Купить',
      url: 'http://localhost/product',
      payload: { action: 'buy', id: 123 }
  });
  
  // Добавление нескольких изображений в галерею
  card.isUsedGallery = true;
  card.addImage('image1.jpg', 'Фото 1')
      .addImage('image2.jpg', 'Фото 2')
      .addImage('image3.jpg', 'Фото 3');
  Copy

addOneImage

• addOneImage(
      image: string | null,
      title?: string,
      desc?: string,
      button?: TButton | null,
  ): this

  Добавляет одно изображение в виде карточки. Внутри себя выставляет isOne в true. Если ранее были указаны другие изображения, то они очистятся. Стоит использовать в том случае, если у вас всегда должно отобразиться только 1 изображение.

  Parameters

  • image: string | null

    Идентификатор или URL изображения

  • title: string = ''

    Заголовок изображения

  • Optionaldesc: string = ''

    Описание изображения

  • Optionalbutton: TButton | null = null

    Кнопки для элемента

  Returns this

clear

• clear(): void

  Очищает все элементы карточки, включая заголовок, описание, шаблон и кнопки карточки, а также сбрасывает флаги isOne и isUsedGallery.

  Сбрасывается всё: при переиспользовании контроллера (BotTest, _setBotController) иначе заголовок, описание и template прошлого запроса попали бы в новый ответ.

  Returns void

  Example

  card.clear(); // Удалить все изображения, заголовок, описание, шаблон и флаги
  Copy

getCards

• getCards<TResult = unknown>(
      cardProcessing: TCardProcessing<TResult>,
      controller: BotController,
  ): TResult

  Получает карточку в формате для текущей платформы.

  Метод возвращает результат cardProcessing как есть: если процессор адаптера асинхронный (Telegram, VK, Алиса, Маруся, MAX) — вернётся Promise и вызов нужно делать с await; синхронные процессоры (Viber, SmartApp) дополнительного await не требуют.

  Type Parameters

  • TResult = unknown

  Parameters

  • cardProcessing: TCardProcessing<TResult>

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

  • controller: BotController

    Контроллер бота

  Returns TResult

  Карточка в формате платформы

  Example

  // Асинхронный процессор (Telegram, VK, Алиса, Маруся, MAX) — нужен await:
  const cardData = await card.getCards(myAsyncCardProcessing, controller);
  
  // Синхронный процессор (Viber, SmartApp) — без await:
  const cardData = card.getCards(mySyncCardProcessing, controller);
  Copy

setAppContext

• setAppContext(appContext: AppContext): this

  Устанавливает контекст приложения (обновляет и вложенную коллекцию кнопок).

  Parameters

  • appContext: AppContext

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

  Returns this

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

setDescription

• setDescription(description: string): this

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

  Parameters

  • description: string

    Описание карточки

  Returns this

  Example

  card.setDescription('Подробное описание товара');
  Copy

setTitle

• setTitle(title: string): this

  Устанавливает заголовок для карточки.

  Parameters

  • title: string

    Заголовок карточки

  Returns this

  Example

  card.setTitle('Название товара');
  Copy