다음을 통해 공유


CardFactory class

봇이 반환할 수 있는 다양한 카드 형식의 서식을 지정하는 메서드를 제공합니다.

설명

이러한 모든 함수는 기존 활동의 첨부 파일 컬렉션에 직접 추가하거나 MessageFactory 메서드 중 하나에 입력으로 전달하여 새 활동을 생성할 수 있는 Attachment 개체를 반환합니다.

이 예제에서는 단일 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);

속성

contentTypes

각 카드 스타일에 대한 콘텐츠 형식 스키마를 나열합니다.

메서드

actions(string | CardAction[] | undefined)

올바른 형식의 작업 배열을 반환합니다.

adaptiveCard(any)

적응형 카드에 대한 첨부 파일을 반환합니다.

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

애니메이션 카드에 대한 첨부 파일을 반환합니다.

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

오디오 카드의 첨부 파일을 반환합니다.

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

영웅 카드에 대한 첨부 파일을 반환합니다.

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

영웅 카드에 대한 첨부 파일을 반환합니다.

images(string | CardImage[] | undefined)

올바른 형식의 카드 이미지 배열을 반환합니다.

media(string | MediaUrl[] | undefined)

미디어 URL 개체의 형식이 올바르게 지정된 배열을 반환합니다.

o365ConnectorCard(O365ConnectorCard)

Office 365 커넥터 카드에 대한 첨부 파일을 반환합니다.

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

OAuth 카드에 대한 첨부 파일을 반환합니다.

receiptCard(ReceiptCard)

영수증 카드의 첨부 파일을 반환합니다.

signinCard(string, string, string)

로그인 카드에 대한 첨부 파일을 반환합니다.

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

썸네일 카드에 대한 첨부 파일을 반환합니다.

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

썸네일 카드에 대한 첨부 파일을 반환합니다.

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

비디오 카드의 첨부 파일을 반환합니다.

속성 세부 정보

contentTypes

각 카드 스타일에 대한 콘텐츠 형식 스키마를 나열합니다.

static contentTypes: any

속성 값

any

메서드 세부 정보

actions(string | CardAction[] | undefined)

올바른 형식의 작업 배열을 반환합니다.

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

매개 변수

actions

string | CardAction[] | undefined

카드에 포함할 동작의 배열입니다. 배열의 각 string 은 제목과 값이 문자열 값으로 설정된 단추로 변환 imBack 됩니다.

반환

CardAction[]

적절한 형식의 작업 배열입니다.

adaptiveCard(any)

적응형 카드에 대한 첨부 파일을 반환합니다.

static function adaptiveCard(card: any): Attachment

매개 변수

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

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

애니메이션 카드에 대한 첨부 파일을 반환합니다.

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

매개 변수

title

string

카드 제목입니다.

media

string | MediaUrl[]

카드의 미디어 URL입니다.

buttons

string | CardAction[]

선택 사항입니다. 카드에 포함할 단추의 배열입니다. 배열의 각 string 은 제목과 값이 문자열 값으로 설정된 단추로 변환 imBack 됩니다.

other

Partial<AnimationCard>

선택 사항입니다. 카드에 포함할 추가 속성입니다.

반환

Attachment

첨부 파일입니다.

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

오디오 카드의 첨부 파일을 반환합니다.

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

매개 변수

title

string

카드 제목입니다.

media

string | MediaUrl[]

카드의 미디어 URL입니다.

buttons

string | CardAction[]

선택 사항입니다. 카드에 포함할 단추의 배열입니다. 배열의 각 string 은 제목과 값이 문자열 값으로 설정된 단추로 변환 imBack 됩니다.

other

Partial<AudioCard>

선택 사항입니다. 카드에 포함할 추가 속성입니다.

반환

Attachment

첨부 파일입니다.

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

영웅 카드에 대한 첨부 파일을 반환합니다.

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

매개 변수

title

string

카드 제목입니다.

images

string | CardImage[]

선택 사항입니다. 카드에 포함할 이미지의 배열입니다. 각 요소는 포함할 이미지의 URL 또는 CardImage 일 수 있습니다.

buttons

string | CardAction[]

선택 사항입니다. 카드에 포함할 단추의 배열입니다. 배열의 각 string 은 제목과 값이 문자열 값으로 설정된 단추로 변환 imBack 됩니다.

other

Partial<HeroCard>

선택 사항입니다. 카드에 포함할 추가 속성입니다.

반환

Attachment

첨부 파일입니다.

설명

영웅 카드에는 하나의 지배적 인 전체 너비 이미지가 있는 경향이 있습니다. 채널은 일반적으로 이미지 아래에 카드의 텍스트와 단추를 렌더링합니다.

예:

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

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

영웅 카드에 대한 첨부 파일을 반환합니다.

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

매개 변수

title

string

카드 제목입니다.

text

string

카드 텍스트입니다.

images

string | CardImage[]

선택 사항입니다. 카드에 포함할 이미지의 배열입니다. 각 요소는 포함할 이미지의 URL 또는 CardImage 일 수 있습니다.

buttons

string | CardAction[]

선택 사항입니다. 카드에 포함할 단추의 배열입니다. 배열의 각 string 은 제목과 값이 문자열 값으로 설정된 단추로 변환 imBack 됩니다.

other

Partial<HeroCard>

선택 사항입니다. 카드에 포함할 추가 속성입니다.

반환

Attachment

첨부 파일입니다.

설명

영웅 카드에는 하나의 지배적 인 전체 너비 이미지가 있는 경향이 있습니다. 채널은 일반적으로 이미지 아래에 카드의 텍스트와 단추를 렌더링합니다. 예:

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

images(string | CardImage[] | undefined)

올바른 형식의 카드 이미지 배열을 반환합니다.

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

매개 변수

images

string | CardImage[] | undefined

카드에 포함할 이미지의 배열입니다. 각 요소는 포함할 이미지의 URL 또는 CardImage 일 수 있습니다.

반환

CardImage[]

올바른 형식의 카드 이미지 배열입니다.

media(string | MediaUrl[] | undefined)

미디어 URL 개체의 형식이 올바르게 지정된 배열을 반환합니다.

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

매개 변수

links

string | MediaUrl[] | undefined

미디어 URL입니다. 각각 string 은 미디어 URL 개체로 변환됩니다.

반환

MediaUrl[]

미디어 URL 개체의 형식이 올바르게 지정된 배열입니다.

o365ConnectorCard(O365ConnectorCard)

Office 365 커넥터 카드에 대한 첨부 파일을 반환합니다.

static function o365ConnectorCard(card: O365ConnectorCard): Attachment

매개 변수

card

O365ConnectorCard

반환할 Office 365 커넥터 카드에 대한 설명입니다.

반환

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

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

OAuth 카드에 대한 첨부 파일을 반환합니다.

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

매개 변수

connectionName

string

사용할 OAuth 연결의 이름입니다.

title

string

카드 로그인 단추의 제목입니다.

text

string

선택 사항입니다. 카드에 포함할 추가 텍스트입니다.

link

string

선택 사항입니다. 사용할 로그인 링크입니다.

tokenExchangeResource

TokenExchangeResource

선택적. 토큰 교환을 수행하려고 하는 리소스입니다.

반환

Attachment

첨부 파일입니다.

설명

OAuth 카드는 Bot Framework의 SSO(Single Sign-On) 서비스를 지원합니다.

receiptCard(ReceiptCard)

영수증 카드의 첨부 파일을 반환합니다.

static function receiptCard(card: ReceiptCard): Attachment

매개 변수

card

ReceiptCard

반환할 영수증 카드에 대한 설명입니다.

반환

Attachment

첨부 파일입니다.

signinCard(string, string, string)

로그인 카드에 대한 첨부 파일을 반환합니다.

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

매개 변수

title

string

카드 로그인 단추의 제목입니다.

url

string

사용할 로그인 페이지의 URL입니다.

text

string

선택 사항입니다. 카드에 포함할 추가 텍스트입니다.

반환

Attachment

첨부 파일입니다.

설명

기본적으로 로그인 카드를 지원하지 않는 채널의 경우 대체 메시지가 렌더링됩니다.

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

썸네일 카드에 대한 첨부 파일을 반환합니다.

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

매개 변수

title

string

카드 제목입니다.

images

string | CardImage[]

선택 사항입니다. 카드에 포함할 이미지의 배열입니다. 각 요소는 포함할 이미지의 URL 또는 CardImage 일 수 있습니다.

buttons

string | CardAction[]

선택 사항입니다. 카드에 포함할 단추의 배열입니다. 배열의 각 string 은 제목과 값이 문자열 값으로 설정된 단추로 변환 imBack 됩니다.

other

Partial<ThumbnailCard>

선택 사항입니다. 카드에 포함할 추가 속성입니다.

반환

Attachment

첨부 파일입니다.

설명

축소판 그림 카드는 영웅 카드와 비슷하지만 전체 너비 이미지 대신 일반적으로 이미지의 작은 축소판 그림 버전으로 렌더링됩니다. 채널은 일반적으로 카드의 텍스트를 이미지의 한쪽으로 렌더링하며 카드 아래에 단추가 표시됩니다.

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

썸네일 카드에 대한 첨부 파일을 반환합니다.

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

매개 변수

title

string

카드 제목입니다.

text

string

카드 텍스트입니다.

images

string | CardImage[]

선택 사항입니다. 카드에 포함할 이미지의 배열입니다. 각 요소는 포함할 이미지의 URL 또는 CardImage 일 수 있습니다.

buttons

string | CardAction[]

선택 사항입니다. 카드에 포함할 단추의 배열입니다. 배열의 각 string 은 제목과 값이 문자열 값으로 설정된 단추로 변환 imBack 됩니다.

other

Partial<ThumbnailCard>

선택 사항입니다. 카드에 포함할 추가 속성입니다.

반환

Attachment

첨부 파일입니다.

설명

축소판 그림 카드는 영웅 카드와 비슷하지만 전체 너비 이미지 대신 일반적으로 이미지의 작은 축소판 그림 버전으로 렌더링됩니다. 채널은 일반적으로 카드의 텍스트를 이미지의 한쪽으로 렌더링하며 카드 아래에 단추가 표시됩니다.

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

비디오 카드의 첨부 파일을 반환합니다.

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

매개 변수

title

string

카드 제목입니다.

media

string | MediaUrl[]

카드의 미디어 URL입니다.

buttons

string | CardAction[]

선택 사항입니다. 카드에 포함할 단추의 배열입니다. 배열의 각 string 은 제목과 값이 문자열 값으로 설정된 단추로 변환 imBack 됩니다.

other

Partial<VideoCard>

선택 사항입니다. 카드에 포함할 추가 속성입니다.

반환

Attachment

첨부 파일입니다.