Поделиться через

IMessage interface

  • Ссылка
Пакет:
botbuilder

Сообщение чата, отправленное между пользователем и ботом. Сообщения от бота пользователю доступны в двух вариантах:

  • реактивные сообщения — это сообщения, отправляемые ботом пользователю в качестве ответа на входящее сообщение от пользователя.
  • упреждающие сообщения — это сообщения, отправляемые ботом пользователю в ответ на некоторые внешние события, такие как триггер сигнализации.

В реактивном случае необходимо скопировать поле адрес из входящего сообщения в исходящее сообщение (если вы используете класс построителя сообщения и инициализировать его с помощью сеанса это произойдет автоматически), а затем задайте текстовые или вложения. Для упреждающих сообщений вам потребуется сохранить адрес из входящего сообщения в внешнее хранилище. Затем вы можете передать это в UniversalBot.beginDialog() или скопировать его в исходящее сообщение, переданное UniversalBot.send().

Создание сообщения пользователю с помощью входящего объекта адреса по умолчанию отправляет ответ пользователю в контексте текущей беседы. Некоторые каналы позволяют начать новые беседы с пользователем. Чтобы начать новую упреждающую беседу с пользователем, просто удалите поле беседы из объекта адреса перед созданием исходящего сообщения.

Extends
IEvent

Свойства

address

Сведения о маршрутизации адресов для события. Сохраните это поле в внешнем хранилище где-то, чтобы позже создать упреждающее сообщение пользователю.
agent

Пакет SDK, обрабатывающий событие. Всегда будет "botbuilder".
attachmentLayout

Указание о том, как клиенты должны макетировать несколько вложений. Значение по умолчанию — list.
attachments

Для входящих сообщений содержит вложения, такие как изображения, отправленные пользователем. Для исходящих сообщений содержатся такие объекты, как карточки или изображения для отправки пользователю.
code

Код, указывающий, почему беседа закончилась.
deliveryMode

Указание доставки для сигнала получателю альтернативных путей доставки для действия. Режим доставки по умолчанию — "по умолчанию".
entities

Структурированные объекты, передаваемые боту или пользователю.
expriation

Время, в течение которого действие должно считаться "истекшим сроком действия" и не должно быть представлено получателю.
importance

Важность действия.
inputHint

Подсказка для клиентов, которые дают им знать, ожидает ли бот дальнейших входных данных или нет. Встроенные запросы автоматически заполняют это значение для исходящих сообщений.
label

Описательная метка для действия.
listenFor

Список фраз и ссылок на то, что системы приведения речи и языка должны прослушивать.
localTimestamp

Местное время отправки сообщения (задано клиентом или ботом, ex: 2016-09-23T13:07:49.4714686-07:00.)
localTimezone

Содержит имя часового пояса, в котором сообщение в локальном времени выражается в формате базы данных часового пояса IANA. Например, Америка/Los_Angeles.
name

Имя операции для вызова или имени события.
relatesTo

Ссылка на другую беседу или сообщение.
replyToId

Идентификатор события, с которое это обновление связано.
semanticAction

Необязательное программное действие, сопровождающее этот запрос.
source

Исходный источник события (т. е. "facebook", "skype", "slack" и т. д.)
sourceEvent

Исходное событие в собственной схеме источников. Для исходящих сообщений можно использовать для передачи данных о событиях источника, таких как пользовательские вложения.
speak

Произнесенное сообщение как язык разметки синтеза речи.
summary

Текст, отображаемый в качестве резервного копирования и как краткое описание содержимого сообщения, например в списке последних бесед.
text

Текст сообщения.
textFormat

Формат текстовых полей. Значение по умолчанию — Markdown.
textHighlights

Коллекция фрагментов текста для выделения, когда действие содержит значение ReplyToId.
textLocale

Определяемый язык текста сообщения, если он известен.
timestamp

Время UTC при отправке сообщения (задано службой.)
type

Определяет тип события. Должно быть сообщением для IMessage.
user

Для входящих сообщений это пользователь, отправляющий сообщение. По умолчанию это копия address.user, но вы можете настроить бот с помощью функции lookupUser, которая позволяет сопоставить входящего пользователя с внутренним идентификатором пользователя.
value

Открытое значение.
valueType

Тип объекта значения действия.

Сведения о свойстве

address

Сведения о маршрутизации адресов для события. Сохраните это поле в внешнем хранилище где-то, чтобы позже создать упреждающее сообщение пользователю.

address: IAddress

Значение свойства

IAddress

agent

Пакет SDK, обрабатывающий событие. Всегда будет "botbuilder".

agent: string

Значение свойства

string

attachmentLayout

Указание о том, как клиенты должны макетировать несколько вложений. Значение по умолчанию — list.

attachmentLayout?: string

Значение свойства

string

attachments

Для входящих сообщений содержит вложения, такие как изображения, отправленные пользователем. Для исходящих сообщений содержатся такие объекты, как карточки или изображения для отправки пользователю.

attachments?: IAttachment[]

Значение свойства

IAttachment[]

code

Код, указывающий, почему беседа закончилась.

code?: string

Значение свойства

string

deliveryMode

Указание доставки для сигнала получателю альтернативных путей доставки для действия. Режим доставки по умолчанию — "по умолчанию".

deliveryMode?: string

Значение свойства

string

entities

Структурированные объекты, передаваемые боту или пользователю.

entities?: any[]

Значение свойства

any[]

expriation

Время, в течение которого действие должно считаться "истекшим сроком действия" и не должно быть представлено получателю.

expriation?: string

Значение свойства

string

importance

Важность действия.

importance?: string

Значение свойства

string

inputHint

Подсказка для клиентов, которые дают им знать, ожидает ли бот дальнейших входных данных или нет. Встроенные запросы автоматически заполняют это значение для исходящих сообщений.

inputHint?: string

Значение свойства

string

label

Описательная метка для действия.

label?: string

Значение свойства

string

listenFor

Список фраз и ссылок на то, что системы приведения речи и языка должны прослушивать.

listenFor?: string[]

Значение свойства

string[]

localTimestamp

Местное время отправки сообщения (задано клиентом или ботом, ex: 2016-09-23T13:07:49.4714686-07:00.)

localTimestamp?: string

Значение свойства

string

localTimezone

Содержит имя часового пояса, в котором сообщение в локальном времени выражается в формате базы данных часового пояса IANA. Например, Америка/Los_Angeles.

localTimezone?: string

Значение свойства

string

name

Имя операции для вызова или имени события.

name?: string

Значение свойства

string

relatesTo

Ссылка на другую беседу или сообщение.

relatesTo?: IAddress

Значение свойства

IAddress

replyToId

Идентификатор события, с которое это обновление связано.

replyToId?: string

Значение свойства

string

semanticAction

Необязательное программное действие, сопровождающее этот запрос.

semanticAction?: ISemanticAction

Значение свойства

ISemanticAction

source

Исходный источник события (т. е. "facebook", "skype", "slack" и т. д.)

source: string

Значение свойства

string

sourceEvent

Исходное событие в собственной схеме источников. Для исходящих сообщений можно использовать для передачи данных о событиях источника, таких как пользовательские вложения.

sourceEvent: any

Значение свойства

any

speak

Произнесенное сообщение как язык разметки синтеза речи.

speak?: string

Значение свойства

string

summary

Текст, отображаемый в качестве резервного копирования и как краткое описание содержимого сообщения, например в списке последних бесед.

summary?: string

Значение свойства

string

text

Текст сообщения.

text?: string

Значение свойства

string

textFormat

Формат текстовых полей. Значение по умолчанию — Markdown.

textFormat?: string

Значение свойства

string

textHighlights

Коллекция фрагментов текста для выделения, когда действие содержит значение ReplyToId.

textHighlights?: ITextHighlight[]

Значение свойства

ITextHighlight[]

textLocale

Определяемый язык текста сообщения, если он известен.

textLocale?: string

Значение свойства

string

timestamp

Время UTC при отправке сообщения (задано службой.)

timestamp?: string

Значение свойства

string

type

Определяет тип события. Должно быть сообщением для IMessage.

type: string

Значение свойства

string

user

Для входящих сообщений это пользователь, отправляющий сообщение. По умолчанию это копия address.user, но вы можете настроить бот с помощью функции lookupUser, которая позволяет сопоставить входящего пользователя с внутренним идентификатором пользователя.

user: IIdentity

Значение свойства

IIdentity

value

Открытое значение.

value?: any

Значение свойства

any

valueType

Тип объекта значения действия.

valueType?: string

Значение свойства

string