MessageFactory 类

包:

com.microsoft.bot.builder

Maven 项目:

com.microsoft.bot:bot-builder:4.14.3

• java.lang.Object
• • com.microsoft.bot.builder.MessageFactory

public final class MessageFactory

包含机器人可以返回的各种消息类型的实用工具方法。

创建并发送消息。 Activity message = MessageFactory.text("Hello World"); conext.sendActivity(message);

以下一般适用于消息操作。 有关对要发送的消息文本内容施加的限制，请参阅通道的文档。

若要控制机器人语音的各种特征（如语音、速率、音量、发音和音调），请指定语音合成标记语言 (SSML) 格式的测试。

通道决定每个卡片操作在其用户体验中的显示方式。 大多数情况下，卡是可单击的。 其他情况下，可以通过语音输入选择它们。 当通道未提供交互式激活体验（例如，通过短信进行交互）时，通道可能根本不支持激活。 有关如何呈现操作的决策是由本文档中其他位置的规范要求控制的（例如，在卡格式中，或者在建议的操作定义中）。

方法摘要

修饰符和类型	方法和描述
static Activity	attachment(Attachment attachment) 返回包含附件的邮件活动。
static Activity	attachment(Attachment attachment, String text) 返回包含附件的邮件活动。
static Activity	attachment(Attachment attachment, String text, String ssml, InputHints inputHint) 返回包含附件的邮件活动。
static Activity	attachment(List<Attachment> attachments) 返回包含附件的邮件活动。
static Activity	attachment(List<Attachment> attachments, String text, String ssml, InputHints inputHint) 返回包含附件的邮件活动。
static Activity	carousel(List<Attachment> attachments, String text) 返回列表中包含附件集合的邮件活动。
static Activity	carousel(List<Attachment> attachments, String text, String ssml, InputHints inputHint) 返回列表中包含附件集合的邮件活动。
static Activity	contentUrl(String url, String contentType) 返回包含单个图像或视频的消息活动。
static Activity	contentUrl(String url, String contentType, String name, String text, String ssml, InputHints inputHint) 返回包含单个图像或视频的消息活动。
static Activity	suggestedActions(List<String> actions, String text) 返回一条消息，其中包含一组建议的操作和可选文本。
static Activity	suggestedActions(List<String> actions, String text, String ssml, InputHints inputHint) 返回一条消息，其中包含一组建议的操作和可选文本。
static Activity	suggestedCardActions(List<CardAction> actions, String text) 返回一条消息，其中包含一组建议的操作和可选文本。
static Activity	suggestedCardActions(List<CardAction> actions, String text, String ssml, InputHints inputHint) 返回一条消息，其中包含一组建议的操作和可选文本。
static Activity	text(String text) 返回一条简单的文本消息。
static Activity	text(String text, String ssml, InputHints inputHint) 返回一条简单的文本消息。

方法继承自 java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

方法详细信息

attachment

public static Activity attachment(Attachment attachment)

返回包含附件的邮件活动。

Parameters:

attachment - 要包含在邮件中的附件。

Returns:

包含附件的邮件活动。

attachment

public static Activity attachment(Attachment attachment, String text)

返回包含附件的邮件活动。

Parameters:

attachment - 要包含在邮件中的附件。

text - （可选）要发送的消息的文本。

Returns:

包含附件的邮件活动。

attachment

public static Activity attachment(Attachment attachment, String text, String ssml, InputHints inputHint)

返回包含附件的邮件活动。

Parameters:

attachment - 要包含在邮件中的附件。

text - （可选）要发送的消息的文本。

ssml - 机器人在支持语音的通道上朗读的可选文本。

inputHint - 可选，指示机器人在消息传递到客户端后是接受、期待还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

Returns:

包含附件的邮件活动。

attachment

public static Activity attachment(List attachments)

返回包含附件的邮件活动。

Parameters:

attachments - 要包含在邮件中的附件。

Returns:

包含附件的邮件活动。

attachment

public static Activity attachment(List attachments, String text, String ssml, InputHints inputHint)

返回包含附件的邮件活动。

Parameters:

attachments - 要包含在邮件中的附件。

text - （可选）要发送的消息的文本。

ssml - 机器人在支持语音的通道上朗读的可选文本。

inputHint - 可选，指示机器人在消息传递到客户端后是接受、期待还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

Returns:

包含附件的邮件活动。

carousel

public static Activity carousel(List attachments, String text)

返回列表中包含附件集合的邮件活动。

Parameters:

attachments - 要包含在邮件中的附件。

text - （可选）要发送的消息的文本。

Returns:

包含附件的邮件活动。

carousel

public static Activity carousel(List attachments, String text, String ssml, InputHints inputHint)

返回列表中包含附件集合的邮件活动。

Parameters:

attachments - 要包含在邮件中的附件。

text - （可选）要发送的消息的文本。

ssml - 机器人在支持语音的通道上朗读的可选文本。

inputHint - 可选，指示机器人在消息传递到客户端后是接受、期待还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

Returns:

包含附件的邮件活动。

contentUrl

public static Activity contentUrl(String url, String contentType)

返回包含单个图像或视频的消息活动。

Parameters:

url - 要发送的图像或视频的 URL。

contentType - 图像或视频的 MIME 类型。

Returns:

包含附件的邮件活动。

contentUrl

public static Activity contentUrl(String url, String contentType, String name, String text, String ssml, InputHints inputHint)

返回包含单个图像或视频的消息活动。

Parameters:

url - 要发送的图像或视频的 URL。

contentType - 图像或视频的 MIME 类型。

name - （可选）图像或视频文件的名称。

text - （可选）要发送的消息的文本。

ssml - 机器人在支持语音的通道上朗读的可选文本。

inputHint - 可选，指示机器人在消息传递到客户端后是接受、期待还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

Returns:

包含附件的邮件活动。

suggestedActions

public static Activity suggestedActions(List actions, String text)

返回一条消息，其中包含一组建议的操作和可选文本。 // Create the activity and add suggested actions. Activity activity = MessageFactory.suggestedActions( new String[] { "red", "green", "blue" }, "Choose a color");

// Send the activity as a reply to the user. context.sendActivity(activity);

Parameters:

actions - 要创建的操作的文本。

text - 可选。 要发送的消息的文本。

Returns:

包含建议操作的消息活动。

suggestedActions

public static Activity suggestedActions(List actions, String text, String ssml, InputHints inputHint)

返回一条消息，其中包含一组建议的操作和可选文本。 // Create the activity and add suggested actions. Activity activity = MessageFactory.suggestedActions( new String[] { "red", "green", "blue" }, "Choose a color");

// Send the activity as a reply to the user. context.sendActivity(activity);

Parameters:

actions - 要创建的操作的文本。

text - 可选。 要发送的消息的文本。

ssml - （可选）机器人在支持语音的通道上朗读的文本。

inputHint - 可选，指示机器人在将消息传递到客户端后是接受、期望还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

Returns:

包含建议操作的消息活动。

suggestedCardActions

public static Activity suggestedCardActions(List actions, String text)

返回一条消息，其中包含一组建议的操作和可选文本。

Parameters:

actions - 要包括的卡操作。

text - 可选，要发送的消息的文本。

Returns:

包含建议操作的消息活动。

suggestedCardActions

public static Activity suggestedCardActions(List actions, String text, String ssml, InputHints inputHint)

返回一条消息，其中包含一组建议的操作和可选文本。

Parameters:

actions - 要包括的卡操作。

text - 可选，要发送的消息的文本。

ssml - （可选）机器人在支持语音的通道上朗读的文本。

inputHint - 可选，指示机器人在将消息传递到客户端后是接受、期望还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

Returns:

包含建议操作的消息活动。

text

public static Activity text(String text)

返回一条简单的文本消息。

Parameters:

text - 要发送的消息的文本。

Returns:

包含文本的消息活动。

text

public static Activity text(String text, String ssml, InputHints inputHint)

返回一条简单的文本消息。

Parameters:

text - 要发送的消息的文本。

ssml - （可选）机器人在支持语音的通道上朗读的文本。

inputHint - 可选，指示机器人在将消息传递到客户端后是接受、期望还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

Returns:

包含文本的消息活动。