MessageFactory class
봇이 반환할 수 있는 다양한 메시지 형식의 서식을 지원하는 유틸리티 함수 집합입니다.
설명
다음 예제에서는 단일 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);
메서드
| attachment(Attachment, string, string, Input |
첨부 파일이 포함된 단일 메시지 활동을 반환합니다. |
| carousel(Attachment[], string, string, Input |
회전식 레이아웃을 사용하여 첨부 파일 집합을 표시하는 메시지를 반환합니다. |
| content |
사용자에게 단일 이미지 또는 비디오를 표시하는 메시지를 반환합니다. |
| list(Attachment[], string, string, Input |
첨부 파일 집합을 목록 형식으로 표시하는 메시지를 반환합니다. |
| suggested |
제안된 작업 및 선택적 텍스트 집합이 포함된 메시지를 반환합니다. |
| text(string, string, Input |
간단한 문자 메시지를 반환합니다. |
메서드 세부 정보
attachment(Attachment, string, string, InputHints | string)
첨부 파일이 포함된 단일 메시지 활동을 반환합니다.
static function attachment(attachment: Attachment, text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>매개 변수
- attachment
-
Attachment
메시지에 포함할 적응형 카드입니다.
- text
-
string
(선택 사항) 메시지의 텍스트입니다.
- speak
-
string
(선택 사항) 메시지에 포함할 SSML입니다.
- inputHint
-
InputHints | string
(선택 사항) 메시지에 대한 입력 힌트입니다. 기본값은 acceptingInput.
반환
Partial<Activity>
첨부 파일이 포함된 메시지 활동입니다.
설명
이 예제에서는 Hero 카드 첨부 파일이 있는 메시지를 만드는 방법을 보여 있습니다.
const message = MessageFactory.attachment(
CardFactory.heroCard(
'White T-Shirt',
['https://example.com/whiteShirt.jpg'],
['buy']
)
);
carousel(Attachment[], string, string, InputHints | string)
회전식 레이아웃을 사용하여 첨부 파일 집합을 표시하는 메시지를 반환합니다.
static function carousel(attachments: Attachment[], text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>매개 변수
- attachments
-
Attachment[]
메시지에 포함할 첨부 파일의 배열입니다.
- text
-
string
(선택 사항) 메시지의 텍스트입니다.
- speak
-
string
(선택 사항) 메시지에 포함할 SSML입니다.
- inputHint
-
InputHints | string
(선택 사항) 메시지에 대한 입력 힌트입니다.
반환
Partial<Activity>
회전식 레이아웃을 사용하여 첨부 파일 집합을 표시하는 메시지 활동입니다.
설명
이 예제에서는 영웅 카드의 회전식으로 메시지를 만드는 방법을 보여 줍니다.
const message = MessageFactory.carousel([
CardFactory.heroCard('title1', ['imageUrl1'], ['button1']),
CardFactory.heroCard('title2', ['imageUrl2'], ['button2']),
CardFactory.heroCard('title3', ['imageUrl3'], ['button3'])
]);
contentUrl(string, string, string, string, string, InputHints | string)
사용자에게 단일 이미지 또는 비디오를 표시하는 메시지를 반환합니다.
static function contentUrl(url: string, contentType: string, name?: string, text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>매개 변수
- url
-
string
보낼 이미지/비디오의 URL입니다.
- contentType
-
string
이미지/비디오의 MIME 형식입니다.
- name
-
string
(선택 사항) 이미지/비디오 파일의 이름입니다.
- text
-
string
(선택 사항) 메시지의 텍스트입니다.
- speak
-
string
(선택 사항) 메시지에 포함할 SSML입니다.
- inputHint
-
InputHints | string
(선택 사항) 메시지에 대한 입력 힌트입니다.
반환
Partial<Activity>
사용자에게 단일 이미지 또는 비디오를 표시하는 메시지 활동입니다.
설명
이 예제에서는 사용자에게 이미지를 보내는 방법을 보여줍니다.
const message = MessageFactory.contentUrl('https://example.com/hawaii.jpg', 'image/jpeg', 'Hawaii Trip', 'A photo from our family vacation.');
list(Attachment[], string, string, InputHints | string)
첨부 파일 집합을 목록 형식으로 표시하는 메시지를 반환합니다.
static function list(attachments: Attachment[], text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>매개 변수
- attachments
-
Attachment[]
메시지에 포함할 첨부 파일의 배열입니다.
- text
-
string
(선택 사항) 메시지의 텍스트입니다.
- speak
-
string
(선택 사항) 메시지에 포함할 SSML입니다.
- inputHint
-
InputHints | string
(선택 사항) 메시지에 대한 입력 힌트입니다.
반환
Partial<Activity>
목록 양식에 첨부 파일 집합을 표시하는 메시지 활동입니다.
설명
이 예제에서는 Hero 카드 목록을 사용하여 메시지를 만드는 방법을 보여 줍니다.
const message = MessageFactory.list([
CardFactory.heroCard('title1', ['imageUrl1'], ['button1']),
CardFactory.heroCard('title2', ['imageUrl2'], ['button2']),
CardFactory.heroCard('title3', ['imageUrl3'], ['button3'])
]);
suggestedActions(string | CardAction[], string, string, InputHints | string)
제안된 작업 및 선택적 텍스트 집합이 포함된 메시지를 반환합니다.
static function suggestedActions(actions: string | CardAction[], text?: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>매개 변수
- actions
-
string | CardAction[]
포함할 카드 동작 또는 문자열의 배열입니다. 문자열은 messageBack 작업으로 변환됩니다.
- text
-
string
(선택 사항) 메시지의 텍스트입니다.
- speak
-
string
(선택 사항) 메시지에 포함할 SSML입니다.
- inputHint
-
InputHints | string
(선택 사항) 메시지에 대한 입력 힌트입니다. 기본값은 acceptingInput.
반환
Partial<Activity>
제안된 작업이 포함된 메시지 활동입니다.
설명
이 예제에서는 제안된 작업을 사용하여 메시지를 만드는 방법을 보여 줍니다.
const message = MessageFactory.suggestedActions(['red', 'green', 'blue'], `Choose a color`);
text(string, string, InputHints | string)
간단한 문자 메시지를 반환합니다.
static function text(text: string, speak?: string, inputHint?: InputHints | string): Partial<Activity>매개 변수
- text
-
string
메시지에 포함할 텍스트입니다.
- speak
-
string
(선택 사항) 메시지에 포함할 SSML입니다.
- inputHint
-
InputHints | string
(선택 사항) 메시지에 대한 입력 힌트입니다. 기본값은 acceptingInput.
반환
Partial<Activity>
텍스트가 포함된 메시지 활동입니다.
설명
이 예제에서는 간단한 문자 메시지를 보내는 방법을 보여줍니다.
const message = MessageFactory.text('Greetings from example message');