Compartilhar via


CardFactory class

Fornece métodos para formatar os vários tipos de cartão que um bot pode retornar.

Comentários

Todas essas funções retornam um objeto Attachment, que pode ser adicionado aos anexos de uma atividade existente coleção diretamente ou passado como entrada para um dos métodos MessageFactory para gerar uma nova atividade.

Este exemplo envia uma mensagem que contém um único cartão 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);

Propriedades

contentTypes

Lista o esquema de tipo de conteúdo para cada estilo de cartão.

Métodos

actions(string | CardAction[] | undefined)

Retorna uma matriz de ações formatada corretamente.

adaptiveCard(any)

Retorna um anexo para um Cartão Adaptável.

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

Retorna um anexo para um cartão de animação.

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

Retorna um anexo para um cartão de áudio.

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

Retorna um anexo para um cartão de herói.

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

Retorna um anexo para um cartão de herói.

images(string | CardImage[] | undefined)

Retorna uma matriz formatada corretamente de imagens de cartão.

media(string | MediaUrl[] | undefined)

Retorna uma matriz formatada corretamente de objetos de URL de mídia.

o365ConnectorCard(O365ConnectorCard)

Retorna um anexo para um cartão de conector do Office 365.

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

Retorna um anexo para um cartão OAuth.

receiptCard(ReceiptCard)

Retorna um anexo para um cartão de confirmação.

signinCard(string, string, string)

Retorna um anexo para um cartão de entrada.

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

Retorna um anexo para um cartão em miniatura.

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

Retorna um anexo para um cartão em miniatura.

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

Retorna um anexo para uma placa de vídeo.

Detalhes da propriedade

contentTypes

Lista o esquema de tipo de conteúdo para cada estilo de cartão.

static contentTypes: any

Valor da propriedade

any

Detalhes do método

actions(string | CardAction[] | undefined)

Retorna uma matriz de ações formatada corretamente.

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

Parâmetros

actions

string | CardAction[] | undefined

A matriz de ação a ser incluída no cartão. Cada string na matriz é convertido em um botão imBack com um título e um valor definidos para o valor da cadeia de caracteres.

Retornos

CardAction[]

Uma matriz de ações formatada corretamente.

adaptiveCard(any)

Retorna um anexo para um Cartão Adaptável.

static function adaptiveCard(card: any): Attachment

Parâmetros

card

any

Uma descrição do Cartão Adaptável a ser retornado.

Retornos

Attachment

Um anexo .

Comentários

Cartões Adaptáveis são um formato de troca de cartão aberto que permite que os desenvolvedores troquem conteúdo da interface do usuário de maneira comum e consistente. Para canais que ainda não dão suporte a Cartões Adaptáveis nativamente, o Bot Framework renderizará o cartão para uma imagem que foi estilizada para ficar boa no canal de destino. Para canais que dão suporte a cartões hero você pode continuar a incluir ações de Cartão Adaptável e eles serão enviados como botões junto com a versão renderizada do cartão.

Para obter mais informações sobre Cartões Adaptáveis e para baixar o SDK mais recente, visite adaptivecards.io.

Por exemplo:

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

Retorna um anexo para um cartão de animação.

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

Parâmetros

title

string

O título do cartão.

media

string | MediaUrl[]

As URLs de mídia do cartão.

buttons

string | CardAction[]

Opcional. A matriz de botões a ser incluída no cartão. Cada string na matriz é convertido em um botão imBack com um título e um valor definidos para o valor da cadeia de caracteres.

other

Partial<AnimationCard>

Opcional. Quaisquer propriedades adicionais a serem incluídas no cartão.

Retornos

Attachment

Um anexo .

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

Retorna um anexo para um cartão de áudio.

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

Parâmetros

title

string

O título do cartão.

media

string | MediaUrl[]

A URL de mídia do cartão.

buttons

string | CardAction[]

Opcional. A matriz de botões a ser incluída no cartão. Cada string na matriz é convertido em um botão imBack com um título e um valor definidos para o valor da cadeia de caracteres.

other

Partial<AudioCard>

Opcional. Quaisquer propriedades adicionais a serem incluídas no cartão.

Retornos

Attachment

Um anexo .

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

Retorna um anexo para um cartão de herói.

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

Parâmetros

title

string

O título do cartão.

images

string | CardImage[]

Opcional. A matriz de imagens a ser incluída no cartão. Cada elemento pode ser um CardImage ou a URL da imagem a ser incluída.

buttons

string | CardAction[]

Opcional. A matriz de botões a ser incluída no cartão. Cada string na matriz é convertido em um botão imBack com um título e um valor definidos para o valor da cadeia de caracteres.

other

Partial<HeroCard>

Opcional. Quaisquer propriedades adicionais a serem incluídas no cartão.

Retornos

Attachment

Um anexo .

Comentários

Cartas hero tendem a ter uma imagem dominante de largura total. Os canais normalmente renderizam o texto e os botões do cartão abaixo da imagem.

Por exemplo:

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

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

Retorna um anexo para um cartão de herói.

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

Parâmetros

title

string

O título do cartão.

text

string

O texto do cartão.

images

string | CardImage[]

Opcional. A matriz de imagens a ser incluída no cartão. Cada elemento pode ser um CardImage ou a URL da imagem a ser incluída.

buttons

string | CardAction[]

Opcional. A matriz de botões a ser incluída no cartão. Cada string na matriz é convertido em um botão imBack com um título e um valor definidos para o valor da cadeia de caracteres.

other

Partial<HeroCard>

Opcional. Quaisquer propriedades adicionais a serem incluídas no cartão.

Retornos

Attachment

Um anexo .

Comentários

Cartas hero tendem a ter uma imagem dominante de largura total. Os canais normalmente renderizam o texto e os botões do cartão abaixo da imagem. Por exemplo:

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

images(string | CardImage[] | undefined)

Retorna uma matriz formatada corretamente de imagens de cartão.

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

Parâmetros

images

string | CardImage[] | undefined

A matriz de imagens a ser incluída no cartão. Cada elemento pode ser um CardImage ou a URL da imagem a ser incluída.

Retornos

CardImage[]

Uma matriz formatada corretamente de imagens de cartão.

media(string | MediaUrl[] | undefined)

Retorna uma matriz formatada corretamente de objetos de URL de mídia.

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

Parâmetros

links

string | MediaUrl[] | undefined

As URLs de mídia. Cada string é convertido em um objeto de URL de mídia.

Retornos

MediaUrl[]

Uma matriz formatada corretamente de objetos de URL de mídia.

o365ConnectorCard(O365ConnectorCard)

Retorna um anexo para um cartão de conector do Office 365.

static function o365ConnectorCard(card: O365ConnectorCard): Attachment

Parâmetros

card

O365ConnectorCard

uma descrição do cartão do conector do Office 365 a ser retornado.

Retornos

Attachment

Um anexo .

Comentários

Por exemplo:

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)

Retorna um anexo para um cartão OAuth.

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

Parâmetros

connectionName

string

O nome da conexão OAuth a ser usada.

title

string

O título do botão de entrada do cartão.

text

string

Opcional. Texto adicional a ser incluído no cartão.

link

string

Opcional. O link de entrada a ser usado.

tokenExchangeResource

TokenExchangeResource

opcional. O recurso com o qual tentar executar a troca de tokens.

Retornos

Attachment

Um anexo .

Comentários

Os cartões OAuth dão suporte ao serviço de SSO (logon único) do Bot Framework.

receiptCard(ReceiptCard)

Retorna um anexo para um cartão de confirmação.

static function receiptCard(card: ReceiptCard): Attachment

Parâmetros

card

ReceiptCard

Uma descrição do cartão de recebimento a ser retornado.

Retornos

Attachment

Um anexo .

signinCard(string, string, string)

Retorna um anexo para um cartão de entrada.

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

Parâmetros

title

string

O título do botão de entrada do cartão.

url

string

A URL da página de entrada a ser usada.

text

string

Opcional. Texto adicional a ser incluído no cartão.

Retornos

Attachment

Um anexo .

Comentários

Para canais que não dão suporte nativo a cartões de entrada, uma mensagem alternativa é renderizada.

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

Retorna um anexo para um cartão em miniatura.

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

Parâmetros

title

string

O título do cartão.

images

string | CardImage[]

Opcional. A matriz de imagens a ser incluída no cartão. Cada elemento pode ser um CardImage ou a URL da imagem a ser incluída.

buttons

string | CardAction[]

Opcional. A matriz de botões a ser incluída no cartão. Cada string na matriz é convertido em um botão imBack com um título e um valor definidos para o valor da cadeia de caracteres.

other

Partial<ThumbnailCard>

Opcional. Quaisquer propriedades adicionais a serem incluídas no cartão.

Retornos

Attachment

Um anexo .

Comentários

Cartões em miniatura são semelhantes a cartões hero, mas em vez de uma imagem de largura total, eles normalmente são renderizados com uma versão em miniatura menor da imagem. Os canais normalmente renderizam o texto do cartão em um lado da imagem, com todos os botões exibidos abaixo do cartão.

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

Retorna um anexo para um cartão em miniatura.

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

Parâmetros

title

string

O título do cartão.

text

string

O texto do cartão.

images

string | CardImage[]

Opcional. A matriz de imagens a ser incluída no cartão. Cada elemento pode ser um CardImage ou a URL da imagem a ser incluída.

buttons

string | CardAction[]

Opcional. A matriz de botões a ser incluída no cartão. Cada string na matriz é convertido em um botão imBack com um título e um valor definidos para o valor da cadeia de caracteres.

other

Partial<ThumbnailCard>

Opcional. Quaisquer propriedades adicionais a serem incluídas no cartão.

Retornos

Attachment

Um anexo .

Comentários

Cartões em miniatura são semelhantes a cartões hero, mas em vez de uma imagem de largura total, eles normalmente são renderizados com uma versão em miniatura menor da imagem. Os canais normalmente renderizam o texto do cartão em um lado da imagem, com todos os botões exibidos abaixo do cartão.

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

Retorna um anexo para uma placa de vídeo.

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

Parâmetros

title

string

O título do cartão.

media

string | MediaUrl[]

As URLs de mídia do cartão.

buttons

string | CardAction[]

Opcional. A matriz de botões a ser incluída no cartão. Cada string na matriz é convertido em um botão imBack com um título e um valor definidos para o valor da cadeia de caracteres.

other

Partial<VideoCard>

Opcional. Quaisquer propriedades adicionais a serem incluídas no cartão.

Retornos

Attachment

Um anexo .