Поделиться через

CardFactory class

  • Ссылка
Пакет:
botbuilder-core

Предоставляет методы форматирования различных типов карточек, которые может возвращать бот.

Комментарии

Все эти функции возвращают объект Attachment , который можно добавить в коллекцию вложений существующего действия напрямую или передать в качестве входных данных одному из методов MessageFactory для создания нового действия.

В этом примере отправляется сообщение, содержащее одну карточку главного героя.

const { MessageFactory, CardFactory } = require('botbuilder');

const card = CardFactory.heroCard(
     'White T-Shirt',
     ['https://example.com/whiteShirt.jpg'],
     ['buy']
);
const message = MessageFactory.attachment(card);
await context.sendActivity(message);

Свойства

contentTypes

Перечисляет схему типов контента для каждого стиля карточки.

Методы

actions(string | CardAction[] | undefined)

Возвращает правильно отформатированный массив действий.
adaptiveCard(any)

Возвращает вложение для адаптивной карточки.
animationCard(string, string | MediaUrl[], string | CardAction[], Partial<AnimationCard>)

Возвращает вложение для карточки анимации.
audioCard(string, string | MediaUrl[], string | CardAction[], Partial<AudioCard>)

Возвращает вложение для звуковой карточки.
heroCard(string, string | CardImage[], string | CardAction[], Partial<HeroCard>)

Возвращает вложение для карточки главного имиджевого баннера.
heroCard(string, string, string | CardImage[], string | CardAction[], Partial<HeroCard>)

Возвращает вложение для карточки главного имиджевого баннера.
images(string | CardImage[] | undefined)

Возвращает правильно отформатированный массив изображений карточек.
media(string | MediaUrl[] | undefined)

Возвращает правильно отформатированный массив объектов URL-адреса мультимедиа.
o365ConnectorCard(O365ConnectorCard)

Возвращает вложение для карточки соединителя Office 365.
oauthCard(string, string, string, string, TokenExchangeResource)

Возвращает вложение для карточки OAuth.
receiptCard(ReceiptCard)

Возвращает вложение для карточки квитанции.
signinCard(string, string, string)

Возвращает вложение для карточки входа.
thumbnailCard(string, string | CardImage[], string | CardAction[], Partial<ThumbnailCard>)

Возвращает вложение для карточки эскиза.
thumbnailCard(string, string, string | CardImage[], string | CardAction[], Partial<ThumbnailCard>)

Возвращает вложение для карточки эскиза.
videoCard(string, string | MediaUrl[], string | CardAction[], Partial<VideoCard>)

Возвращает вложение для видеоадаптер.

Сведения о свойстве

contentTypes

Перечисляет схему типов контента для каждого стиля карточки.

static contentTypes: any

Значение свойства

any

Сведения о методе

actions(string | CardAction[] | undefined)

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

static function actions(actions: string | CardAction[] | undefined): CardAction[]

Параметры

actions

string | CardAction[] | undefined

Массив действий, включаемых в карточку. Каждый string элемент в массиве преобразуется в кнопку imBack с заголовком и значением, равным значению строки.

Возвращаемое значение

CardAction[]

Правильно отформатированный массив действий.

adaptiveCard(any)

Возвращает вложение для адаптивной карточки.

static function adaptiveCard(card: any): Attachment

Параметры

card

any

Описание возвращаемой адаптивной карточки.

Возвращаемое значение

Attachment

Вложение.

Комментарии

Адаптивные карточки — это открытый формат обмена данными, который обеспечивает унифицированную и согласованную передачу содержимого пользовательского интерфейса между разработчиками. Для каналов, которые еще не поддерживают адаптивные карточки изначально, Bot Framework отрисовывает карточку до изображения, которое было хорошо выглядеть в целевом канале. Для каналов, поддерживающих карточки главного имиджевого баннера, можно по-прежнему включать действия адаптивной карточки, и они будут отправляться в виде кнопок вместе с отображаемой версией карточки.

Дополнительные сведения об адаптивных карточках и скачивании последней версии пакета SDK см. на странице adaptivecards.io.

Например:

const card = CardFactory.adaptiveCard({
  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
  "type": "AdaptiveCard",
  "version": "1.0",
  "body": [
      {
         "type": "TextBlock",
         "text": "Default text input"
      }
  ],
  "actions": [
      {
         "type": "Action.Submit",
         "title": "OK"
      }
  ]
});

animationCard(string, string | MediaUrl[], string | CardAction[], Partial<AnimationCard>)

Возвращает вложение для карточки анимации.

static function animationCard(title: string, media: string | MediaUrl[], buttons?: string | CardAction[], other?: Partial<AnimationCard>): Attachment

Параметры

title

string

Название карточки.

media

string | MediaUrl[]

URL-адреса носителя для карточки.

buttons

string | CardAction[]

Необязательный элемент. Массив кнопок, включаемых в карточку. Каждый string элемент в массиве преобразуется в кнопку imBack с заголовком и значением, равным значению строки.

other

Partial<AnimationCard>

Необязательный элемент. Любые дополнительные свойства, которые необходимо включить в карточку.

Возвращаемое значение

Attachment

Вложение.

audioCard(string, string | MediaUrl[], string | CardAction[], Partial<AudioCard>)

Возвращает вложение для звуковой карточки.

static function audioCard(title: string, media: string | MediaUrl[], buttons?: string | CardAction[], other?: Partial<AudioCard>): Attachment

Параметры

title

string

Название карточки.

media

string | MediaUrl[]

URL-адрес носителя для карточки.

buttons

string | CardAction[]

Необязательный элемент. Массив кнопок, включаемых в карточку. Каждый string элемент в массиве преобразуется в кнопку imBack с заголовком и значением, равным значению строки.

other

Partial<AudioCard>

Необязательный элемент. Любые дополнительные свойства, которые необходимо включить в карточку.

Возвращаемое значение

Attachment

Вложение.

heroCard(string, string | CardImage[], string | CardAction[], Partial<HeroCard>)

Возвращает вложение для карточки главного имиджевого баннера.

static function heroCard(title: string, images?: string | CardImage[], buttons?: string | CardAction[], other?: Partial<HeroCard>): Attachment

Параметры

title

string

Название карточки.

images

string | CardImage[]

Необязательный элемент. Массив изображений, включаемых в карточку. Каждый элемент может быть CardImage или URL-адрес включаемого изображения.

buttons

string | CardAction[]

Необязательный элемент. Массив кнопок, включаемых в карточку. Каждый string элемент в массиве преобразуется в кнопку imBack с заголовком и значением, равным значению строки.

other

Partial<HeroCard>

Необязательный элемент. Любые дополнительные свойства, которые необходимо включить в карточку.

Возвращаемое значение

Attachment

Вложение.

Комментарии

Карточки главного имиджевого баннера, как правило, имеют одно доминирующее изображение полной ширины. Каналы обычно отображают текст и кнопки карточки под изображением.

Например:

const card = CardFactory.heroCard(
     'White T-Shirt',
     ['https://example.com/whiteShirt.jpg'],
     ['buy']
);

heroCard(string, string, string | CardImage[], string | CardAction[], Partial<HeroCard>)

Возвращает вложение для карточки главного имиджевого баннера.

static function heroCard(title: string, text: string, images?: string | CardImage[], buttons?: string | CardAction[], other?: Partial<HeroCard>): Attachment

Параметры

title

string

Название карточки.

text

string

Текст карточки.

images

string | CardImage[]

Необязательный элемент. Массив изображений, включаемых в карточку. Каждый элемент может быть CardImage или URL-адрес включаемого изображения.

buttons

string | CardAction[]

Необязательный элемент. Массив кнопок, включаемых в карточку. Каждый string элемент в массиве преобразуется в кнопку imBack с заголовком и значением, равным значению строки.

other

Partial<HeroCard>

Необязательный элемент. Любые дополнительные свойства, которые необходимо включить в карточку.

Возвращаемое значение

Attachment

Вложение.

Комментарии

Карточки главного имиджевого баннера, как правило, имеют одно доминирующее изображение полной ширины. Каналы обычно отображают текст и кнопки карточки под изображением. Например:

const card = CardFactory.heroCard(
     'White T-Shirt',
     ['https://example.com/whiteShirt.jpg'],
     ['buy']
);

images(string | CardImage[] | undefined)

Возвращает правильно отформатированный массив изображений карточек.

static function images(images: string | CardImage[] | undefined): CardImage[]

Параметры

images

string | CardImage[] | undefined

Массив изображений, включаемых в карточку. Каждый элемент может быть CardImage или URL-адрес включаемого изображения.

Возвращаемое значение

CardImage[]

Правильно отформатированный массив изображений карточек.

media(string | MediaUrl[] | undefined)

Возвращает правильно отформатированный массив объектов URL-адреса мультимедиа.

static function media(links: string | MediaUrl[] | undefined): MediaUrl[]

Параметры

links

string | MediaUrl[] | undefined

URL-адреса мультимедиа. Каждый из них string преобразуется в объект URL-адреса носителя.

Возвращаемое значение

MediaUrl[]

Правильно отформатированный массив объектов URL-адресов мультимедиа.

o365ConnectorCard(O365ConnectorCard)

Возвращает вложение для карточки соединителя Office 365.

static function o365ConnectorCard(card: O365ConnectorCard): Attachment

Параметры

card

O365ConnectorCard

описание возвращаемой карточки соединителя Office 365.

Возвращаемое значение

Attachment

Вложение.

Комментарии

Например:

const card = CardFactory.o365ConnectorCard({
  "title": "card title",
  "text": "card text",
  "summary": "O365 card summary",
  "themeColor": "#E67A9E",
  "sections": [
      {
          "title": "**section title**",
          "text": "section text",
          "activityTitle": "activity title",
      }
  ]
});

oauthCard(string, string, string, string, TokenExchangeResource)

Возвращает вложение для карточки OAuth.

static function oauthCard(connectionName: string, title: string, text?: string, link?: string, tokenExchangeResource?: TokenExchangeResource): Attachment

Параметры

connectionName

string

Имя используемого подключения OAuth.

title

string

Заголовок кнопки входа карточки.

text

string

Необязательный элемент. Дополнительный текст для добавления на карточку.

link

string

Необязательный элемент. Используемая ссылка для входа.

tokenExchangeResource

TokenExchangeResource

Дополнительные. Ресурс, с которым нужно выполнить обмен маркерами.

Возвращаемое значение

Attachment

Вложение.

Комментарии

Карты OAuth поддерживают службу единого входа (SSO) Bot Framework.

receiptCard(ReceiptCard)

Возвращает вложение для карточки квитанции.

static function receiptCard(card: ReceiptCard): Attachment

Параметры

card

ReceiptCard

Описание возвращаемой карточки квитанции.

Возвращаемое значение

Attachment

Вложение.

signinCard(string, string, string)

Возвращает вложение для карточки входа.

static function signinCard(title: string, url: string, text?: string): Attachment

Параметры

title

string

Заголовок кнопки входа карточки.

url

string

URL-адрес используемой страницы входа.

text

string

Необязательный элемент. Дополнительный текст для добавления на карточку.

Возвращаемое значение

Attachment

Вложение.

Комментарии

Для каналов, которые изначально не поддерживают карточки входа, отображается альтернативное сообщение.

thumbnailCard(string, string | CardImage[], string | CardAction[], Partial<ThumbnailCard>)

Возвращает вложение для карточки эскиза.

static function thumbnailCard(title: string, images?: string | CardImage[], buttons?: string | CardAction[], other?: Partial<ThumbnailCard>): Attachment

Параметры

title

string

Название карточки.

images

string | CardImage[]

Необязательный элемент. Массив изображений, включаемых на карточку. Каждый элемент может быть CardImage или URL-адрес включаемого изображения.

buttons

string | CardAction[]

Необязательный элемент. Массив кнопок, включаемых на карточку. Каждый string элемент в массиве преобразуется в кнопку imBack с заголовком и значением, равным значению строки.

other

Partial<ThumbnailCard>

Необязательный элемент. Любые дополнительные свойства, которые необходимо включить в карточку.

Возвращаемое значение

Attachment

Вложение.

Комментарии

Карточки эскизов похожи на карточки с изображением,но вместо изображения полной ширины они обычно отрисовываются с уменьшенной версией эскиза изображения. Каналы обычно отображают текст карточки на одной стороне изображения с любыми кнопками, отображаемыми под карточкой.

thumbnailCard(string, string, string | CardImage[], string | CardAction[], Partial<ThumbnailCard>)

Возвращает вложение для карточки эскиза.

static function thumbnailCard(title: string, text: string, images?: string | CardImage[], buttons?: string | CardAction[], other?: Partial<ThumbnailCard>): Attachment

Параметры

title

string

Название карточки.

text

string

Текст карточки.

images

string | CardImage[]

Необязательный элемент. Массив изображений, включаемых на карточку. Каждый элемент может быть CardImage или URL-адрес включаемого изображения.

buttons

string | CardAction[]

Необязательный элемент. Массив кнопок, включаемых на карточку. Каждый string элемент в массиве преобразуется в кнопку imBack с заголовком и значением, равным значению строки.

other

Partial<ThumbnailCard>

Необязательный элемент. Любые дополнительные свойства, которые необходимо включить в карточку.

Возвращаемое значение

Attachment

Вложение.

Комментарии

Карточки эскизов похожи на карточки с изображением,но вместо изображения полной ширины они обычно отрисовываются с уменьшенной версией эскиза изображения. Каналы обычно отображают текст карточки на одной стороне изображения с любыми кнопками, отображаемыми под карточкой.

videoCard(string, string | MediaUrl[], string | CardAction[], Partial<VideoCard>)

Возвращает вложение для видеоадаптер.

static function videoCard(title: string, media: string | MediaUrl[], buttons?: string | CardAction[], other?: Partial<VideoCard>): Attachment

Параметры

title

string

Название карточки.

media

string | MediaUrl[]

URL-адреса мультимедиа для карточки.

buttons

string | CardAction[]

Необязательный элемент. Массив кнопок, включаемых на карточку. Каждый string элемент в массиве преобразуется в кнопку imBack с заголовком и значением, равным значению строки.

other

Partial<VideoCard>

Необязательный элемент. Любые дополнительные свойства, которые необходимо включить в карточку.

Возвращаемое значение

Attachment

Вложение.