CardFactory class

Fornisce metodi per la formattazione dei vari tipi di scheda che un bot può restituire.

Commenti

Tutte queste funzioni restituiscono un oggetto Attachment , che può essere aggiunto all'insieme allegati di un'attività esistente direttamente o passato come input a uno dei metodi MessageFactory per generare una nuova attività.

In questo esempio viene inviato un messaggio contenente una singola scheda hero.

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

Proprietà

contentTypes

Elenca lo schema del tipo di contenuto per ogni stile di scheda.

Metodi

actions(string | CardAction[] | undefined)

Restituisce una matrice formattata correttamente delle azioni.

adaptiveCard(any)

Restituisce un allegato per una scheda adattiva.

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

Restituisce un allegato per una scheda di animazione.

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

Restituisce un allegato per una scheda audio.

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

Restituisce un allegato per una scheda hero.

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

Restituisce un allegato per una scheda hero.

images(string | CardImage[] | undefined)

Restituisce una matrice formattata correttamente delle immagini della scheda.

media(string | MediaUrl[] | undefined)

Restituisce una matrice formattata correttamente degli oggetti URL multimediali.

o365ConnectorCard(O365ConnectorCard)

Restituisce un allegato per una scheda connettore Office 365.

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

Restituisce un allegato per una scheda OAuth.

receiptCard(ReceiptCard)

Restituisce un allegato per una scheda di ricezione.

signinCard(string, string, string)

Restituisce un allegato per una scheda di accesso.

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

Restituisce un allegato per una scheda di anteprima.

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

Restituisce un allegato per una scheda di anteprima.

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

Restituisce un allegato per una scheda video.

Dettagli proprietà

contentTypes

Elenca lo schema del tipo di contenuto per ogni stile di scheda.

static contentTypes: any

Valore della proprietà

any

Dettagli metodo

actions(string | CardAction[] | undefined)

Restituisce una matrice formattata correttamente delle azioni.

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

Parametri

actions

string | CardAction[] | undefined

Matrice di azione da includere nella scheda. Ogni string oggetto della matrice viene convertito in un imBack pulsante con un titolo e un valore impostato sul valore della stringa.

Restituisce

CardAction[]

Matrice formattata correttamente delle azioni.

adaptiveCard(any)

Restituisce un allegato per una scheda adattiva.

static function adaptiveCard(card: any): Attachment

Parametri

card

any

Descrizione della scheda adattiva da restituire.

Restituisce

Attachment

Allegato.

Commenti

Le schede adattive sono un formato aperto per lo scambio di schede che consente agli sviluppatori di scambiare contenuti dell'interfaccia utente in un modo coerente e comune. Per i canali che non supportano ancora le schede adattive in modo nativo, Bot Framework eseguirà il rendering della scheda a un'immagine con stile per essere ottimale nel canale di destinazione. Per i canali che supportano le schede hero, è possibile continuare a includere le azioni della scheda adattiva e verranno inviate come pulsanti insieme alla versione di cui è stato eseguito il rendering della scheda.

Per altre informazioni sulle schede adattive e per scaricare l'SDK più recente, visitare adaptivecards.io.

Ad esempio:

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

Restituisce un allegato per una scheda di animazione.

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

Parametri

title

string

Titolo della scheda.

media

string | MediaUrl[]

URL multimediali per la scheda.

buttons

string | CardAction[]

Facoltativa. Matrice di pulsanti da includere nella scheda. Ogni string oggetto della matrice viene convertito in un imBack pulsante con un titolo e un valore impostato sul valore della stringa.

other

Partial<AnimationCard>

Facoltativa. Eventuali proprietà aggiuntive da includere nella scheda.

Restituisce

Attachment

Allegato.

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

Restituisce un allegato per una scheda audio.

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

Parametri

title

string

Titolo della scheda.

media

string | MediaUrl[]

URL multimediale per la scheda.

buttons

string | CardAction[]

Facoltativa. Matrice di pulsanti da includere nella scheda. Ogni string oggetto della matrice viene convertito in un imBack pulsante con un titolo e un valore impostato sul valore della stringa.

other

Partial<AudioCard>

Facoltativa. Eventuali proprietà aggiuntive da includere nella scheda.

Restituisce

Attachment

Allegato.

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

Restituisce un allegato per una scheda hero.

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

Parametri

title

string

Titolo della scheda.

images

string | CardImage[]

Facoltativa. Matrice di immagini da includere nella scheda. Ogni elemento può essere cardImage o l'URL dell'immagine da includere.

buttons

string | CardAction[]

Facoltativa. Matrice di pulsanti da includere nella scheda. Ogni string oggetto della matrice viene convertito in un imBack pulsante con un titolo e un valore impostato sul valore della stringa.

other

Partial<HeroCard>

Facoltativa. Eventuali proprietà aggiuntive da includere nella scheda.

Restituisce

Attachment

Allegato.

Commenti

Le carte eroe tendono ad avere un'immagine dominante e a larghezza intera. I canali in genere eseguono il rendering del testo e dei pulsanti della scheda sotto l'immagine.

Ad esempio:

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

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

Restituisce un allegato per una scheda hero.

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

Parametri

title

string

Titolo della scheda.

text

string

Testo della scheda.

images

string | CardImage[]

Facoltativa. Matrice di immagini da includere nella scheda. Ogni elemento può essere cardImage o l'URL dell'immagine da includere.

buttons

string | CardAction[]

Facoltativa. Matrice di pulsanti da includere nella scheda. Ogni string oggetto della matrice viene convertito in un imBack pulsante con un titolo e un valore impostato sul valore della stringa.

other

Partial<HeroCard>

Facoltativa. Eventuali proprietà aggiuntive da includere nella scheda.

Restituisce

Attachment

Allegato.

Commenti

Le carte eroe tendono ad avere un'immagine dominante e a larghezza intera. I canali in genere eseguono il rendering del testo e dei pulsanti della scheda sotto l'immagine. Ad esempio:

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

images(string | CardImage[] | undefined)

Restituisce una matrice formattata correttamente delle immagini della scheda.

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

Parametri

images

string | CardImage[] | undefined

Matrice di immagini da includere nella scheda. Ogni elemento può essere cardImage o l'URL dell'immagine da includere.

Restituisce

CardImage[]

Matrice formattata correttamente delle immagini della scheda.

media(string | MediaUrl[] | undefined)

Restituisce una matrice formattata correttamente degli oggetti URL multimediali.

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

Parametri

links

string | MediaUrl[] | undefined

URL multimediali. Ogni string oggetto viene convertito in un oggetto URL multimediale.

Restituisce

MediaUrl[]

Matrice formattata correttamente di oggetti URL multimediali.

o365ConnectorCard(O365ConnectorCard)

Restituisce un allegato per una scheda connettore Office 365.

static function o365ConnectorCard(card: O365ConnectorCard): Attachment

Parametri

card

O365ConnectorCard

una descrizione della scheda del connettore Office 365 da restituire.

Restituisce

Attachment

Allegato.

Commenti

Ad esempio:

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)

Restituisce un allegato per una scheda OAuth.

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

Parametri

connectionName

string

Nome della connessione OAuth da usare.

title

string

Titolo del pulsante di accesso della scheda.

text

string

Facoltativa. Testo aggiuntivo da includere nella scheda.

link

string

Facoltativa. Collegamento di accesso da usare.

tokenExchangeResource

TokenExchangeResource

Opzionale. Risorsa con cui provare a eseguire lo scambio di token.

Restituisce

Attachment

Allegato.

Commenti

Le schede OAuth supportano il servizio Single Sign-On (SSO) di Bot Framework.

receiptCard(ReceiptCard)

Restituisce un allegato per una scheda di ricezione.

static function receiptCard(card: ReceiptCard): Attachment

Parametri

card

ReceiptCard

Descrizione della scheda di ricezione da restituire.

Restituisce

Attachment

Allegato.

signinCard(string, string, string)

Restituisce un allegato per una scheda di accesso.

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

Parametri

title

string

Titolo del pulsante di accesso della scheda.

url

string

URL della pagina di accesso da usare.

text

string

Facoltativa. Testo aggiuntivo da includere nella scheda.

Restituisce

Attachment

Allegato.

Commenti

Per i canali che non supportano in modo nativo le schede di accesso, viene eseguito il rendering di un messaggio alternativo.

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

Restituisce un allegato per una scheda di anteprima.

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

Parametri

title

string

Titolo della scheda.

images

string | CardImage[]

Facoltativa. Matrice di immagini da includere nella scheda. Ogni elemento può essere cardImage o l'URL dell'immagine da includere.

buttons

string | CardAction[]

Facoltativa. Matrice di pulsanti da includere nella scheda. Ogni string oggetto della matrice viene convertito in un imBack pulsante con un titolo e un valore impostato sul valore della stringa.

other

Partial<ThumbnailCard>

Facoltativa. Eventuali proprietà aggiuntive da includere nella scheda.

Restituisce

Attachment

Allegato.

Commenti

Le schede di anteprima sono simili alle schede hero, ma invece di un'immagine a larghezza completa, vengono in genere visualizzate con una versione di anteprima più piccola dell'immagine. I canali in genere eseguono il rendering del testo della scheda su un lato dell'immagine, con i pulsanti visualizzati sotto la scheda.

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

Restituisce un allegato per una scheda di anteprima.

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

Parametri

title

string

Titolo della scheda.

text

string

Testo della scheda.

images

string | CardImage[]

Facoltativa. Matrice di immagini da includere nella scheda. Ogni elemento può essere cardImage o l'URL dell'immagine da includere.

buttons

string | CardAction[]

Facoltativa. Matrice di pulsanti da includere nella scheda. Ogni string oggetto della matrice viene convertito in un imBack pulsante con un titolo e un valore impostato sul valore della stringa.

other

Partial<ThumbnailCard>

Facoltativa. Eventuali proprietà aggiuntive da includere nella scheda.

Restituisce

Attachment

Allegato.

Commenti

Le schede di anteprima sono simili alle schede hero, ma invece di un'immagine a larghezza completa, vengono in genere visualizzate con una versione di anteprima più piccola dell'immagine. I canali in genere eseguono il rendering del testo della scheda su un lato dell'immagine, con i pulsanti visualizzati sotto la scheda.

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

Restituisce un allegato per una scheda video.

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

Parametri

title

string

Titolo della scheda.

media

string | MediaUrl[]

URL multimediali per la scheda.

buttons

string | CardAction[]

Facoltativa. Matrice di pulsanti da includere nella scheda. Ogni string oggetto della matrice viene convertito in un imBack pulsante con un titolo e un valore impostato sul valore della stringa.

other

Partial<VideoCard>

Facoltativa. Eventuali proprietà aggiuntive da includere nella scheda.

Restituisce

Attachment

Allegato.