CardFactory class

Répertorie le schéma de type de contenu pour chaque style de carte.

static contentTypes: any

Valeur de propriété

Retourne un tableau d’actions correctement mis en forme.

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

Paramètres

Retours

Tableau d’actions correctement mis en forme.

Retourne une pièce jointe pour une carte adaptative.

static function adaptiveCard(card: any): Attachment

Paramètres

Retours

Pièce jointe.

Remarques

Le format Cartes adaptatives est un format d’échange de cartes ouvert qui permet aux développeurs d’échanger du contenu d’interface utilisateur de manière commune et cohérente. Pour les canaux qui ne prennent pas encore en charge les cartes adaptatives en mode natif, Bot Framework effectue un rendu inférieur de la carte à une image dont le style est correct sur le canal cible. Pour les canaux qui prennent en charge les cartes héros , vous pouvez continuer à inclure des actions de carte adaptative et celles-ci seront envoyées sous forme de boutons avec la version rendue de la carte.

Pour plus d’informations sur les cartes adaptatives et pour télécharger le dernier kit sdk, consultez adaptivecards.io.

Par exemple :

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"
      }
  ]
});

Retourne une pièce jointe pour une carte d’animation.

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

Paramètres

Retours

Pièce jointe.

Retourne une pièce jointe pour une carte audio.

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

Paramètres

Retours

Pièce jointe.

Retourne une pièce jointe pour une carte de héros.

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

Paramètres

Retours

Pièce jointe.

Remarques

Les cartes héros ont tendance à avoir une image dominante pleine largeur. Les canaux affichent généralement le texte et les boutons de la carte sous l’image.

Par exemple :

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

Retourne une pièce jointe pour une carte de héros.

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

Paramètres

Retours

Pièce jointe.

Remarques

Les cartes héros ont tendance à avoir une image dominante pleine largeur. Les canaux affichent généralement le texte et les boutons de la carte sous l’image. Par exemple :

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

Retourne un tableau d’images de carte correctement mis en forme.

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

Paramètres

Retours

Tableau d’images de carte correctement mis en forme.

Retourne un tableau correctement mis en forme d’objets d’URL multimédia.

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

Paramètres

Retours

Tableau correctement mis en forme d’objets d’URL multimédia.

Retourne une pièce jointe pour une carte de connecteur Office 365.

static function o365ConnectorCard(card: O365ConnectorCard): Attachment

Paramètres

Retours

Pièce jointe.

Remarques

Par exemple :

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",
      }
  ]
});

Retourne une pièce jointe pour une carte OAuth.

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

Paramètres

Retours

Pièce jointe.

Remarques

Les cartes OAuth prennent en charge le service d’authentification unique (SSO) de Bot Framework.

Retourne une pièce jointe pour une carte de reçu.

static function receiptCard(card: ReceiptCard): Attachment

Paramètres

Retours

Pièce jointe.

Retourne une pièce jointe pour une carte de connexion.

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

Paramètres

Retours

Pièce jointe.

Remarques

Pour les canaux qui ne prennent pas en charge les cartes de connexion en mode natif, un autre message est affiché.

Retourne une pièce jointe pour une carte miniature.

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

Paramètres

Retours

Pièce jointe.

Remarques

Les cartes miniatures sont similaires aux cartes héros, mais au lieu d’une image pleine largeur, elles sont généralement rendues avec une version miniature plus petite de l’image. Les canaux restituent généralement le texte de la carte sur un côté de l’image, avec tous les boutons affichés sous la carte.

Retourne une pièce jointe pour une carte miniature.

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

Paramètres

Retours

Pièce jointe.

Remarques

Les cartes miniatures sont similaires aux cartes héros, mais au lieu d’une image pleine largeur, elles sont généralement rendues avec une version miniature plus petite de l’image. Les canaux restituent généralement le texte de la carte sur un côté de l’image, avec tous les boutons affichés sous la carte.

Retourne une pièce jointe pour une carte vidéo.

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

Paramètres

Retours

Pièce jointe.