botbuilder-core
Version:
Core components for Microsoft Bot Builder. Components in this library can run either in a browser or on the server.
206 lines • 7.91 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.MessageFactory = void 0;
/**
* @module botbuilder
*/
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License.
*/
const botframework_schema_1 = require("botframework-schema");
const cardFactory_1 = require("./cardFactory");
/**
* A set of utility functions to assist with the formatting of the various message types a bot can
* return.
*
* @remarks
* The following example shows sending a message containing a single hero card:
*
* ```javascript
* 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);
* ```
*/
class MessageFactory {
/**
* Returns a simple text message.
*
* @remarks
* This example shows sending a simple text message:
*
* ```JavaScript
* const message = MessageFactory.text('Greetings from example message');
* ```
* @param text Text to include in the message.
* @param speak (Optional) SSML to include in the message.
* @param inputHint (Optional) input hint for the message. Defaults to `acceptingInput`.
* @returns A message activity containing the text.
*/
static text(text, speak, inputHint) {
const msg = {
type: botframework_schema_1.ActivityTypes.Message,
text: text,
inputHint: inputHint || botframework_schema_1.InputHints.AcceptingInput,
};
if (speak) {
msg.speak = speak;
}
return msg;
}
/**
* Returns a message that includes a set of suggested actions and optional text.
*
* @remarks
* This example shows creating a message with suggested actions:
*
* ```JavaScript
* const message = MessageFactory.suggestedActions(['red', 'green', 'blue'], `Choose a color`);
* ```
* @param actions Array of card actions or strings to include. Strings will be converted to `messageBack` actions.
* @param text (Optional) text of the message.
* @param speak (Optional) SSML to include with the message.
* @param inputHint (Optional) input hint for the message. Defaults to `acceptingInput`.
* @returns A message activity that contains the suggested actions.
*/
static suggestedActions(actions, text, speak, inputHint) {
const msg = {
type: botframework_schema_1.ActivityTypes.Message,
inputHint: inputHint || botframework_schema_1.InputHints.AcceptingInput,
suggestedActions: {
actions: cardFactory_1.CardFactory.actions(actions),
},
};
if (text) {
msg.text = text;
}
if (speak) {
msg.speak = speak;
}
return msg;
}
/**
* Returns a single message activity containing an attachment.
*
* @remarks
* This example shows creating a message with a hero card attachment:
*
* ```JavaScript
* const message = MessageFactory.attachment(
* CardFactory.heroCard(
* 'White T-Shirt',
* ['https://example.com/whiteShirt.jpg'],
* ['buy']
* )
* );
* ```
* @param attachment Adaptive card to include in the message.
* @param text (Optional) text of the message.
* @param speak (Optional) SSML to include with the message.
* @param inputHint (Optional) input hint for the message. Defaults to `acceptingInput`.
* @returns A message activity containing the attachment.
*/
static attachment(attachment, text, speak, inputHint) {
return attachmentActivity(botframework_schema_1.AttachmentLayoutTypes.List, [attachment], text, speak, inputHint);
}
/**
* Returns a message that will display a set of attachments in list form.
*
* @remarks
* This example shows creating a message with a list of hero cards:
*
* ```JavaScript
* const message = MessageFactory.list([
* CardFactory.heroCard('title1', ['imageUrl1'], ['button1']),
* CardFactory.heroCard('title2', ['imageUrl2'], ['button2']),
* CardFactory.heroCard('title3', ['imageUrl3'], ['button3'])
* ]);
* ```
* @param attachments Array of attachments to include in the message.
* @param text (Optional) text of the message.
* @param speak (Optional) SSML to include with the message.
* @param inputHint (Optional) input hint for the message.
* @returns A message activity that will display a set of attachments in list form.
*/
static list(attachments, text, speak, inputHint) {
return attachmentActivity(botframework_schema_1.AttachmentLayoutTypes.List, attachments, text, speak, inputHint);
}
/**
* Returns a message that will display a set of attachments using a carousel layout.
*
* @remarks
* This example shows creating a message with a carousel of hero cards:
*
* ```JavaScript
* const message = MessageFactory.carousel([
* CardFactory.heroCard('title1', ['imageUrl1'], ['button1']),
* CardFactory.heroCard('title2', ['imageUrl2'], ['button2']),
* CardFactory.heroCard('title3', ['imageUrl3'], ['button3'])
* ]);
* ```
* @param attachments Array of attachments to include in the message.
* @param text (Optional) text of the message.
* @param speak (Optional) SSML to include with the message.
* @param inputHint (Optional) input hint for the message.
* @returns A message activity that will display a set of attachments using a carousel layout.
*/
static carousel(attachments, text, speak, inputHint) {
return attachmentActivity(botframework_schema_1.AttachmentLayoutTypes.Carousel, attachments, text, speak, inputHint);
}
/**
* Returns a message that will display a single image or video to a user.
*
* @remarks
* This example shows sending an image to the user:
*
* ```JavaScript
* const message = MessageFactory.contentUrl('https://example.com/hawaii.jpg', 'image/jpeg', 'Hawaii Trip', 'A photo from our family vacation.');
* ```
* @param url Url of the image/video to send.
* @param contentType The MIME type of the image/video.
* @param name (Optional) Name of the image/video file.
* @param text (Optional) text of the message.
* @param speak (Optional) SSML to include with the message.
* @param inputHint (Optional) input hint for the message.
* @returns A message activity that will display a single image or video to a user.
*/
static contentUrl(url, contentType, name, text, speak, inputHint) {
const a = { contentType: contentType, contentUrl: url };
if (name) {
a.name = name;
}
return attachmentActivity(botframework_schema_1.AttachmentLayoutTypes.List, [a], text, speak, inputHint);
}
}
exports.MessageFactory = MessageFactory;
/**
* @private
* @param attachmentLayout the direction in which attachments will be laid out
* @param attachments an array of attachments
* @param text the text to include
* @param speak spoken text
* @param inputHint input hint
*/
function attachmentActivity(attachmentLayout, attachments, text, speak, inputHint) {
const msg = {
type: botframework_schema_1.ActivityTypes.Message,
attachmentLayout: attachmentLayout,
attachments: attachments,
inputHint: inputHint || botframework_schema_1.InputHints.AcceptingInput,
};
if (text) {
msg.text = text;
}
if (speak) {
msg.speak = speak;
}
return msg;
}
//# sourceMappingURL=messageFactory.js.map