Freigeben über

CardFactory class

  • Referenz
Paket:
botbuilder-core

Stellt Methoden zum Formatieren der verschiedenen Kartentypen bereit, die ein Bot zurückgeben kann.

Hinweise

Alle diese Funktionen geben ein Attachment-Objekt zurück, das der Attachments-Auflistung einer vorhandenen Aktivität direkt hinzugefügt oder als Eingabe an eine der MessageFactory-Methoden übergeben werden kann, um eine neue Aktivität zu generieren.

In diesem Beispiel wird eine Nachricht gesendet, die eine einzelne Herokarte enthält.

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);

Eigenschaften

contentTypes

Listet das Inhaltstypschema für die einzelnen Kartenstile auf.

Methoden

actions(string | CardAction[] | undefined)

Gibt ein ordnungsgemäß formatiertes Array von Aktionen zurück.
adaptiveCard(any)

Gibt eine Anlage für eine adaptive Karte zurück.
animationCard(string, string | MediaUrl[], string | CardAction[], Partial<AnimationCard>)

Gibt eine Anlage für eine Animationskarte zurück.
audioCard(string, string | MediaUrl[], string | CardAction[], Partial<AudioCard>)

Gibt eine Anlage für eine Audiokarte zurück.
heroCard(string, string | CardImage[], string | CardAction[], Partial<HeroCard>)

Gibt eine Anlage für eine Heldenkarte zurück.
heroCard(string, string, string | CardImage[], string | CardAction[], Partial<HeroCard>)

Gibt eine Anlage für eine Heldenkarte zurück.
images(string | CardImage[] | undefined)

Gibt ein ordnungsgemäß formatiertes Array von Kartenbildern zurück.
media(string | MediaUrl[] | undefined)

Gibt ein ordnungsgemäß formatiertes Array von Medien-URL-Objekten zurück.
o365ConnectorCard(O365ConnectorCard)

Gibt eine Anlage für eine Office 365-Verbinderkarte zurück.
oauthCard(string, string, string, string, TokenExchangeResource)

Gibt eine Anlage für eine OAuth-Karte zurück.
receiptCard(ReceiptCard)

Gibt eine Anlage für eine Belegkarte zurück.
signinCard(string, string, string)

Gibt eine Anlage für eine Anmeldekarte zurück.
thumbnailCard(string, string | CardImage[], string | CardAction[], Partial<ThumbnailCard>)

Gibt eine Anlage für eine Miniaturansichtskarte zurück.
thumbnailCard(string, string, string | CardImage[], string | CardAction[], Partial<ThumbnailCard>)

Gibt eine Anlage für eine Miniaturansichtskarte zurück.
videoCard(string, string | MediaUrl[], string | CardAction[], Partial<VideoCard>)

Gibt eine Anlage für eine Grafikkarte zurück.

Details zur Eigenschaft

contentTypes

Listet das Inhaltstypschema für die einzelnen Kartenstile auf.

static contentTypes: any

Eigenschaftswert

any

Details zur Methode

actions(string | CardAction[] | undefined)

Gibt ein ordnungsgemäß formatiertes Array von Aktionen zurück.

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

Parameter

actions

string | CardAction[] | undefined

Das Aktionsarray, das auf der Karte enthalten sein soll. Jedes string im Array wird in eine imBack Schaltfläche konvertiert, deren Titel und Wert auf den Wert der Zeichenfolge festgelegt sind.

Gibt zurück

CardAction[]

Ein ordnungsgemäß formatiertes Array von Aktionen.

adaptiveCard(any)

Gibt eine Anlage für eine adaptive Karte zurück.

static function adaptiveCard(card: any): Attachment

Parameter

card

any

Eine Beschreibung der zurückzugebenden adaptiven Karte.

Gibt zurück

Attachment

Eine Anlage.

Hinweise

Adaptive Karten sind ein offenes Kartenaustauschformat, mit dem Entwickler UI-Inhalte auf einheitliche und konsistente Weise austauschen können. Für Kanäle, die adaptive Karten noch nicht nativ unterstützen, rendert das Bot Framework die Karte auf ein Bild herunter, das so formatiert wurde, dass es auf dem Zielkanal gut aussieht. Für Kanäle, die Heldenkarten unterstützen, können Sie weiterhin Adaptive Kartenaktionen einschließen, die zusammen mit der gerenderten Version der Karte als Schaltflächen gesendet werden.

Weitere Informationen zu adaptiven Karten und zum Herunterladen des neuesten SDK finden Sie unter adaptivecards.io.

Beispiel:

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>)

Gibt eine Anlage für eine Animationskarte zurück.

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

Parameter

title

string

Der Kartentitel.

media

string | MediaUrl[]

Die Medien-URLs für die Karte.

buttons

string | CardAction[]

Optional. Das Array von Schaltflächen, die auf der Karte enthalten sein sollen. Jedes string im Array wird in eine imBack Schaltfläche konvertiert, deren Titel und Wert auf den Wert der Zeichenfolge festgelegt sind.

other

Partial<AnimationCard>

Optional. Alle zusätzlichen Eigenschaften, die auf der Karte eingeschlossen werden sollen.

Gibt zurück

Attachment

Eine Anlage.

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

Gibt eine Anlage für eine Audiokarte zurück.

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

Parameter

title

string

Der Kartentitel.

media

string | MediaUrl[]

Die Medien-URL für die Karte.

buttons

string | CardAction[]

Optional. Das Array von Schaltflächen, die auf der Karte enthalten sein sollen. Jedes string im Array wird in eine imBack Schaltfläche konvertiert, deren Titel und Wert auf den Wert der Zeichenfolge festgelegt sind.

other

Partial<AudioCard>

Optional. Alle zusätzlichen Eigenschaften, die auf der Karte eingeschlossen werden sollen.

Gibt zurück

Attachment

Eine Anlage.

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

Gibt eine Anlage für eine Heldenkarte zurück.

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

Parameter

title

string

Der Kartentitel.

images

string | CardImage[]

Optional. Das Array von Bildern, die auf der Karte enthalten sein sollen. Jedes Element kann ein CardImage oder die URL des einzuschließenden Bilds sein.

buttons

string | CardAction[]

Optional. Das Array von Schaltflächen, die auf der Karte enthalten sein sollen. Jedes string im Array wird in eine imBack Schaltfläche konvertiert, deren Titel und Wert auf den Wert der Zeichenfolge festgelegt sind.

other

Partial<HeroCard>

Optional. Alle zusätzlichen Eigenschaften, die auf der Karte eingeschlossen werden sollen.

Gibt zurück

Attachment

Eine Anlage.

Hinweise

Heldenkarten haben in der Regel ein dominantes Bild mit voller Breite. Kanäle rendern normalerweise den Text und die Schaltflächen der Karte unter dem Bild.

Beispiel:

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

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

Gibt eine Anlage für eine Heldenkarte zurück.

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

Parameter

title

string

Der Kartentitel.

text

string

Der Kartentext.

images

string | CardImage[]

Optional. Das Array von Bildern, die auf der Karte enthalten sein sollen. Jedes Element kann ein CardImage oder die URL des einzuschließenden Bilds sein.

buttons

string | CardAction[]

Optional. Das Array von Schaltflächen, die auf der Karte enthalten sein sollen. Jedes string im Array wird in eine imBack Schaltfläche konvertiert, deren Titel und Wert auf den Wert der Zeichenfolge festgelegt sind.

other

Partial<HeroCard>

Optional. Alle zusätzlichen Eigenschaften, die auf der Karte eingeschlossen werden sollen.

Gibt zurück

Attachment

Eine Anlage.

Hinweise

Heldenkarten haben in der Regel ein dominantes Bild mit voller Breite. Kanäle rendern normalerweise den Text und die Schaltflächen der Karte unter dem Bild. Beispiel:

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

images(string | CardImage[] | undefined)

Gibt ein ordnungsgemäß formatiertes Array von Kartenbildern zurück.

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

Parameter

images

string | CardImage[] | undefined

Das Array von Bildern, die auf der Karte enthalten sein sollen. Jedes Element kann ein CardImage oder die URL des einzuschließenden Bilds sein.

Gibt zurück

CardImage[]

Ein ordnungsgemäß formatiertes Array von Kartenbildern.

media(string | MediaUrl[] | undefined)

Gibt ein ordnungsgemäß formatiertes Array von Medien-URL-Objekten zurück.

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

Parameter

links

string | MediaUrl[] | undefined

Die Medien-URLs. Jede string wird in ein Medien-URL-Objekt konvertiert.

Gibt zurück

MediaUrl[]

Ein ordnungsgemäß formatiertes Array von Medien-URL-Objekten.

o365ConnectorCard(O365ConnectorCard)

Gibt eine Anlage für eine Office 365-Verbinderkarte zurück.

static function o365ConnectorCard(card: O365ConnectorCard): Attachment

Parameter

card

O365ConnectorCard

eine Beschreibung der zurückzugebenden Office 365 Connectorkarte.

Gibt zurück

Attachment

Eine Anlage.

Hinweise

Beispiel:

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)

Gibt eine Anlage für eine OAuth-Karte zurück.

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

Parameter

connectionName

string

Der Name der zu verwendenden OAuth-Verbindung.

title

string

Der Titel für die Anmeldeschaltfläche der Karte.

text

string

Optional. Zusätzlicher Text, der auf der Karte enthalten sein soll.

link

string

Optional. Der zu verwendende Anmeldelink.

tokenExchangeResource

TokenExchangeResource

Optional. Die Ressource, mit der versucht werden soll, den Tokenaustausch durchzuführen.

Gibt zurück

Attachment

Eine Anlage.

Hinweise

OAuth-Karten unterstützen den Dienst des einmaligen Anmeldens (Single Sign On, SSO) von Bot Framework.

receiptCard(ReceiptCard)

Gibt eine Anlage für eine Belegkarte zurück.

static function receiptCard(card: ReceiptCard): Attachment

Parameter

card

ReceiptCard

Eine Beschreibung der zurückzugebenden Belegkarte.

Gibt zurück

Attachment

Eine Anlage.

signinCard(string, string, string)

Gibt eine Anlage für eine Anmeldekarte zurück.

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

Parameter

title

string

Der Titel für die Anmeldeschaltfläche der Karte.

url

string

Die URL der zu verwendenden Anmeldeseite.

text

string

Optional. Zusätzlicher Text, der auf der Karte enthalten sein soll.

Gibt zurück

Attachment

Eine Anlage.

Hinweise

Für Kanäle, die Anmeldekarten nicht nativ unterstützen, wird eine alternative Nachricht gerendert.

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

Gibt eine Anlage für eine Miniaturansichtskarte zurück.

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

Parameter

title

string

Der Kartentitel.

images

string | CardImage[]

Optional. Das Array von Bildern, die auf der Karte enthalten sein sollen. Jedes Element kann ein CardImage oder die URL des einzuschließenden Bilds sein.

buttons

string | CardAction[]

Optional. Das Array von Schaltflächen, die auf der Karte enthalten sein sollen. Jedes string im Array wird in eine imBack Schaltfläche konvertiert, deren Titel und Wert auf den Wert der Zeichenfolge festgelegt sind.

other

Partial<ThumbnailCard>

Optional. Alle zusätzlichen Eigenschaften, die auf der Karte enthalten sein sollen.

Gibt zurück

Attachment

Eine Anlage.

Hinweise

Miniaturansichtskarten ähneln Hero-Karten, werden jedoch anstelle eines Bilds mit voller Breite in der Regel mit einer kleineren Miniaturansichtsversion des Bilds gerendert. Kanäle rendern den Text der Karte in der Regel auf eine Seite des Bilds, wobei alle Schaltflächen unterhalb der Karte angezeigt werden.

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

Gibt eine Anlage für eine Miniaturansichtskarte zurück.

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

Parameter

title

string

Der Kartentitel.

text

string

Der Kartentext.

images

string | CardImage[]

Optional. Das Array von Bildern, die auf der Karte enthalten sein sollen. Jedes Element kann ein CardImage oder die URL des einzuschließenden Bilds sein.

buttons

string | CardAction[]

Optional. Das Array von Schaltflächen, die auf der Karte enthalten sein sollen. Jedes string im Array wird in eine imBack Schaltfläche konvertiert, deren Titel und Wert auf den Wert der Zeichenfolge festgelegt sind.

other

Partial<ThumbnailCard>

Optional. Alle zusätzlichen Eigenschaften, die auf der Karte enthalten sein sollen.

Gibt zurück

Attachment

Eine Anlage.

Hinweise

Miniaturansichtskarten ähneln Hero-Karten, werden jedoch anstelle eines Bilds mit voller Breite in der Regel mit einer kleineren Miniaturansichtsversion des Bilds gerendert. Kanäle rendern den Text der Karte in der Regel auf eine Seite des Bilds, wobei alle Schaltflächen unterhalb der Karte angezeigt werden.

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

Gibt eine Anlage für eine Grafikkarte zurück.

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

Parameter

title

string

Der Kartentitel.

media

string | MediaUrl[]

Die Medien-URLs für die Karte.

buttons

string | CardAction[]

Optional. Das Array von Schaltflächen, die auf der Karte enthalten sein sollen. Jedes string im Array wird in eine imBack Schaltfläche konvertiert, deren Titel und Wert auf den Wert der Zeichenfolge festgelegt sind.

other

Partial<VideoCard>

Optional. Alle zusätzlichen Eigenschaften, die auf der Karte enthalten sein sollen.

Gibt zurück

Attachment

Eine Anlage.