CardFactory class

各カード スタイルのコンテンツ タイプ スキーマを一覧表示します。

static contentTypes: any

プロパティ値

正しく書式設定されたアクションの配列を返します。

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

パラメーター

戻り値

適切に書式設定されたアクションの配列。

アダプティブ カードの添付ファイルを返します。

static function adaptiveCard(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"
      }
  ]
});

アニメーション カードの添付ファイルを返します。

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

パラメーター

戻り値

添付ファイル。

オーディオ カードの添付ファイルを返します。

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

パラメーター

戻り値

添付ファイル。

ヒーロー カードの添付ファイルを返します。

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

パラメーター

戻り値

添付ファイル。

注釈

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

例えば：

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

ヒーロー カードの添付ファイルを返します。

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

パラメーター

戻り値

添付ファイル。

注釈

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

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

正しく書式設定されたカードイメージの配列を返します。

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

パラメーター

戻り値

適切に書式設定されたカード画像の配列。

メディア URL オブジェクトの正しく書式設定された配列を返します。

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

パラメーター

戻り値

適切に書式設定されたメディア URL オブジェクトの配列。

Office 365 コネクタ カードの添付ファイルを返します。

static function o365ConnectorCard(card: O365ConnectorCard): 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",
      }
  ]
});

OAuth カードの添付ファイルを返します。

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

パラメーター

戻り値

添付ファイル。

注釈

OAuth カードは、Bot Framework のシングル サインオン (SSO) サービスをサポートします。

レシート カードの添付ファイルを返します。

static function receiptCard(card: ReceiptCard): Attachment

パラメーター

戻り値

添付ファイル。

サインイン カードの添付ファイルを返します。

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

パラメーター

戻り値

添付ファイル。

注釈

ネイティブでサインイン カードをサポートしていないチャネルの場合は、代替メッセージが表示されます。

サムネイル カードの添付ファイルを返します。

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

パラメーター

戻り値

添付ファイル。

注釈

サムネイル カードはヒーロー カードに似ていますが、全幅の画像ではなく、通常は縮小版の画像でレンダリングされます。 通常、チャネルはカードのテキストを画像の一方の側にレンダリングし、カードの下にボタンが表示されます。

サムネイル カードの添付ファイルを返します。

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

パラメーター

戻り値

添付ファイル。

注釈

サムネイル カードはヒーロー カードに似ていますが、全幅の画像ではなく、通常は縮小版の画像でレンダリングされます。 通常、チャネルはカードのテキストを画像の一方の側にレンダリングし、カードの下にボタンが表示されます。

ビデオ カードの添付ファイルを返します。

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

パラメーター

戻り値

添付ファイル。