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)

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

参数:

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

返回:

包含附件的邮件活动。

attachment

public static Activity attachment(Attachment attachment, String text)

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

参数:

attachment - 要包含在邮件中的附件。
text - 可选，要发送的消息的文本。

返回:

包含附件的邮件活动。

attachment

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

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

参数:

attachment - 要包含在邮件中的附件。
text - 可选，要发送的消息的文本。
ssml - （可选）在启用语音的通道上由机器人朗读的文本。
inputHint - 可选，指示在将消息传递到客户端后机器人是接受、期望还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

返回:

包含附件的邮件活动。

attachment

public static Activity attachment(List attachments)

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

参数:

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

返回:

包含附件的邮件活动。

attachment

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

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

参数:

attachments - 要包含在邮件中的附件。
text - 可选，要发送的消息的文本。
ssml - （可选）在启用语音的通道上由机器人朗读的文本。
inputHint - 可选，指示在将消息传递到客户端后机器人是接受、期望还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

返回:

包含附件的邮件活动。

carousel

public static Activity carousel(List attachments, String text)

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

参数:

attachments - 要包含在邮件中的附件。
text - 可选，要发送的消息的文本。

返回:

包含附件的邮件活动。

carousel

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

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

参数:

attachments - 要包含在邮件中的附件。
text - 可选，要发送的消息的文本。
ssml - （可选）在启用语音的通道上由机器人朗读的文本。
inputHint - 可选，指示在将消息传递到客户端后机器人是接受、期望还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

返回:

包含附件的邮件活动。

contentUrl

public static Activity contentUrl(String url, String contentType)

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

参数:

url - 要发送的图像或视频的 URL。
contentType - 图像或视频的 MIME 类型。

返回:

包含附件的邮件活动。

contentUrl

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

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

参数:

url - 要发送的图像或视频的 URL。
contentType - 图像或视频的 MIME 类型。
name - 可选，图像或视频文件的名称。
text - 可选，要发送的消息的文本。
ssml - （可选）在启用语音的通道上由机器人朗读的文本。
inputHint - 可选，指示在将消息传递到客户端后机器人是接受、期望还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

返回:

包含附件的邮件活动。

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);

参数:

actions - 要创建的作的文本。
text - 自选。 要发送的消息的文本。

返回:

包含建议作的消息活动。

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);

参数:

actions - 要创建的作的文本。
text - 自选。 要发送的消息的文本。
ssml - （可选）在启用语音的通道上由机器人朗读的文本。
inputHint - 可选，指示在将消息传递到客户端后机器人是接受、期望还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

返回:

包含建议作的消息活动。

suggestedCardActions

public static Activity suggestedCardActions(List actions, String text)

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

参数:

actions - 要包括的卡片作。
text - 可选，要发送的消息的文本。

返回:

包含建议作的消息活动。

suggestedCardActions

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

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

参数:

actions - 要包括的卡片作。
text - 可选，要发送的消息的文本。
ssml - （可选）在启用语音的通道上由机器人朗读的文本。
inputHint - 可选，指示在将消息传递到客户端后机器人是接受、期望还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

返回:

包含建议作的消息活动。

text

public static Activity text(String text)

返回一个简单的短信。

参数:

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

返回:

包含文本的消息活动。

text

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

返回一个简单的短信。

参数:

text - 要发送的消息的文本。
ssml - （可选）在启用了语音的通道上由机器人朗读的文本。
inputHint - 可选，指示在将消息传递到客户端后机器人是接受、期望还是忽略用户输入。 默认值为 ACCEPTING_INPUT。

返回:

包含文本的消息活动。

适用于