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

CardFactory class

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

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

Комментарии

Все эти функции возвращают объект вложения вложения, которые можно добавить в вложения существующего действия, коллекцию напрямую или передать в качестве входных данных одному из методов 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 поддерживают службу единого входа 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

вложения.