MessageFactory class
Набор служебных функций, помогающих с форматированием различных типов сообщений, которые бот может возвращать.
Комментарии
В следующем примере показано, как отправить сообщение, содержащее одну карточку героя:
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>
Действие сообщения, содержащее вложение.
Комментарии
В этом примере показано создание сообщения с вложением карточки героя:
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>
Действие сообщения, отображающее набор вложений в форме списка.
Комментарии
В этом примере показано создание сообщения со списком карточек героев:
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');