CardFactory class

パッケージ:

botbuilder-core

ボットが返すことができるさまざまなカードの種類を書式設定するためのメソッドを提供します。

注釈

これらの関数はすべて Attachment オブジェクトを返します。 Attachment オブジェクトは、既存のアクティビティの attachments コレクションに直接追加することも、新しいアクティビティを生成するために MessageFactory メソッドの 1 つに入力として渡すこともできます。

この例では、1 つのヒーロー カードを含むメッセージを送信します。

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

添付ファイル。

注釈

アダプティブ カードは、カード交換のオープン フォーマットであり、開発者は一貫性のある共通した方法で UI コンテンツを交換できます。 アダプティブ カードをネイティブでまだサポートしていないチャネルの場合、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

添付ファイル。

注釈

ヒーロー カードは、1 つの主要な全角画像を持つ傾向があります。 通常、チャネルはカードのテキストとボタンを画像の下にレンダリングします。

以下に例を示します。

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

添付ファイル。

注釈

ヒーロー カードは、1 つの主要な全角画像を持つ傾向があります。 通常、チャネルはカードのテキストとボタンを画像の下にレンダリングします。 以下に例を示します。

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 のシングル サインオン (SSO) サービスをサポートしています。

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

添付ファイル。