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

Каналы определяют, как каждое действие карточки проявляется в пользовательском интерфейсе. В большинстве случаев карточки доступны для щелчка. В других приложениях они могут быть выбраны с помощью входных данных речи. В случаях, когда канал не предлагает интерактивный интерфейс активации (например, при взаимодействии по SMS), канал может не поддерживать активацию в любом случае. Решение о том, как выполнять действия, контролируется нормативными требованиями в этом документе (например, в формате карточки или в определении предлагаемых действий).

Сводка по методу

Модификатор и тип Метод и описание
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.

Возвращаемое значение:

Действие сообщения, содержащее текст.

Применяется к