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

Activity interface

  • Ссылка
Пакет:
botframework-schema

Действие — это базовый тип связи для протокола Bot Framework 3.0.

Свойства

action

Указывает, был ли добавлен или удален получатель contactRelationUpdate из списка контактов отправителя.
attachmentLayout

Указание макета для нескольких вложений. По умолчанию: list. Возможные значения: "list", "карусель"
attachments

Вложения
callerId

Строка, содержащая универсальный код ресурса (URI), определяющий вызывающий объект бота. Это поле не предназначено для передачи по сети. Оно заполняется ботами и клиентами на основе доступных для криптографической проверки данных, которые подтверждают подлинность вызывающих объектов (например, маркеров).
channelData

Содержит содержимое для конкретного канала.
channelId

Содержит идентификатор, однозначно определяющий канал. Задается каналом.
code

Код для действий endOfConversation, указывающий, почему беседа закончилась. Возможные значения: unknown, completedSuccessfully, userCancelled, botTimedOut, botIssuedInvalidMessage, channelFailed.
conversation

Идентифицирует беседу, к которой принадлежит действие.
deliveryMode

Указание, определяющее альтернативные пути доставки действия получателю. Режим доставки по умолчанию — "default". Возможные значения: "normal", "notification", "expectReplies", "ephemeral"
entities

Представляет сущности, упомянутые в сообщении.
expiration

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

Идентифицирует отправителя сообщения.
historyDisclosed

Указывает, раскрывается ли предыдущий журнал канала.
id

Содержит идентификатор, который однозначно идентифицирует действие в канале.
importance

Важность действия. Возможные значения: "low", "normal", "high"
inputHint

Указывает, принимает ли бот, ожидает или игнорирует введенные пользователем данные после доставки сообщения клиенту. Возможные значения: acceptingInput, ignoringInput, expectingInput.
label

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

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

Имя языкового стандарта для содержимого текстового поля. Имя языкового стандарта представляет собой сочетание двух- или трехбуквенный код языка и региональных параметров ISO 639, связанный с языком, и двухбуквенный код субкультуры ISO 3166, связанный со страной или регионом. Имя языкового стандарта также может соответствовать допустимому тегу языка BCP-47.
localTimestamp

Содержит локальную дату и время сообщения, выраженные в формате ISO-8601. Например, 2016-09-23T13:07:49.4714686-07:00.
localTimezone

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

Коллекция участников, добавленных в беседу.
membersRemoved

Коллекция элементов, удаленных из беседы.
name

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

Коллекция реакций, добавленных в диалог.
reactionsRemoved

Коллекция реакций, удаленных из диалога.
recipient

Определяет получателя сообщения.
relatesTo

Ссылка на другую беседу или действие.
replyToId

Содержит идентификатор сообщения, на которое это сообщение является ответом.
semanticAction

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

Содержит URL-адрес, указывающий конечную точку службы канала. Задается каналом.
speak

Текст для озвучки.
suggestedActions

Предлагаемые действия для действия.
summary

Текст, отображаемый, если каналу не удается отобразить карточки.
text

Текстовое содержимое сообщения.
textFormat

Формат текстовых полей Default:markdown. Возможные значения: "markdown", "plain", "xml"
textHighlights

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

Содержит дату и время отправки сообщения в формате UTC, выраженные в формате ISO-8601.
topicName

Обновленное имя темы беседы.
type

Содержит тип действия. Возможные значения: "message", "contactRelationUpdate", "conversationUpdate", "typeing", "endOfConversation", "event", "invoke", "deleteUserData", "messageUpdate", "messageDelete", "installationUpdate", "messageReaction", "suggestion", "trace", "handoff"
value

Значение , связанное с действием.
valueType

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

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

action

Указывает, был ли добавлен или удален получатель contactRelationUpdate из списка контактов отправителя.

action?: string

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

string

attachmentLayout

Указание макета для нескольких вложений. По умолчанию: list. Возможные значения: "list", "карусель"

attachmentLayout?: AttachmentLayoutTypes | string

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

AttachmentLayoutTypes | string

attachments

Вложения

attachments?: Attachment[]

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

Attachment[]

callerId

Строка, содержащая универсальный код ресурса (URI), определяющий вызывающий объект бота. Это поле не предназначено для передачи по сети. Оно заполняется ботами и клиентами на основе доступных для криптографической проверки данных, которые подтверждают подлинность вызывающих объектов (например, маркеров).

callerId: string

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

string

channelData

Содержит содержимое для конкретного канала.

channelData?: any

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

any

channelId

Содержит идентификатор, однозначно определяющий канал. Задается каналом.

channelId: string

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

string

code

Код для действий endOfConversation, указывающий, почему беседа закончилась. Возможные значения: unknown, completedSuccessfully, userCancelled, botTimedOut, botIssuedInvalidMessage, channelFailed.

code?: EndOfConversationCodes | string

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

EndOfConversationCodes | string

conversation

Идентифицирует беседу, к которой принадлежит действие.

conversation: ConversationAccount

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

ConversationAccount

deliveryMode

Указание, определяющее альтернативные пути доставки действия получателю. Режим доставки по умолчанию — "default". Возможные значения: "normal", "notification", "expectReplies", "ephemeral"

deliveryMode?: DeliveryModes | string

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

DeliveryModes | string

entities

Представляет сущности, упомянутые в сообщении.

entities?: Entity[]

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

Entity[]

expiration

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

expiration?: Date

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

Date

from

Идентифицирует отправителя сообщения.

from: ChannelAccount

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

ChannelAccount

historyDisclosed

Указывает, раскрывается ли предыдущий журнал канала.

historyDisclosed?: boolean

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

boolean

id

Содержит идентификатор, который однозначно идентифицирует действие в канале.

id?: string

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

string

importance

Важность действия. Возможные значения: "low", "normal", "high"

importance?: ActivityImportance | string

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

ActivityImportance | string

inputHint

Указывает, принимает ли бот, ожидает или игнорирует введенные пользователем данные после доставки сообщения клиенту. Возможные значения: acceptingInput, ignoringInput, expectingInput.

inputHint?: InputHints | string

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

InputHints | string

label

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

label: string

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

string

listenFor

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

listenFor: string[]

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

string[]

locale

Имя языкового стандарта для содержимого текстового поля. Имя языкового стандарта представляет собой сочетание двух- или трехбуквенный код языка и региональных параметров ISO 639, связанный с языком, и двухбуквенный код субкультуры ISO 3166, связанный со страной или регионом. Имя языкового стандарта также может соответствовать допустимому тегу языка BCP-47.

locale?: string

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

string

localTimestamp

Содержит локальную дату и время сообщения, выраженные в формате ISO-8601. Например, 2016-09-23T13:07:49.4714686-07:00.

localTimestamp?: Date

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

Date

localTimezone

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

localTimezone: string

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

string

membersAdded

Коллекция участников, добавленных в беседу.

membersAdded?: ChannelAccount[]

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

ChannelAccount[]

membersRemoved

Коллекция элементов, удаленных из беседы.

membersRemoved?: ChannelAccount[]

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

ChannelAccount[]

name

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

name?: ActivityEventNames | string

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

ActivityEventNames | string

reactionsAdded

Коллекция реакций, добавленных в диалог.

reactionsAdded?: MessageReaction[]

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

MessageReaction[]

reactionsRemoved

Коллекция реакций, удаленных из диалога.

reactionsRemoved?: MessageReaction[]

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

MessageReaction[]

recipient

Определяет получателя сообщения.

recipient: ChannelAccount

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

ChannelAccount

relatesTo

Ссылка на другую беседу или действие.

relatesTo?: ConversationReference

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

ConversationReference

replyToId

Содержит идентификатор сообщения, на которое это сообщение является ответом.

replyToId?: string

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

string

semanticAction

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

semanticAction?: SemanticAction

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

SemanticAction

serviceUrl

Содержит URL-адрес, указывающий конечную точку службы канала. Задается каналом.

serviceUrl: string

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

string

speak

Текст для озвучки.

speak?: string

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

string

suggestedActions

Предлагаемые действия для действия.

suggestedActions?: SuggestedActions

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

SuggestedActions

summary

Текст, отображаемый, если каналу не удается отобразить карточки.

summary?: string

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

string

text

Текстовое содержимое сообщения.

text: string

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

string

textFormat

Формат текстовых полей Default:markdown. Возможные значения: "markdown", "plain", "xml"

textFormat?: TextFormatTypes | string

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

TextFormatTypes | string

textHighlights

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

textHighlights?: TextHighlight[]

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

TextHighlight[]

timestamp

Содержит дату и время отправки сообщения в формате UTC, выраженные в формате ISO-8601.

timestamp?: Date

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

Date

topicName

Обновленное имя темы беседы.

topicName?: string

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

string

type

Содержит тип действия. Возможные значения: "message", "contactRelationUpdate", "conversationUpdate", "typeing", "endOfConversation", "event", "invoke", "deleteUserData", "messageUpdate", "messageDelete", "installationUpdate", "messageReaction", "suggestion", "trace", "handoff"

type: ActivityTypes | string

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

ActivityTypes | string

value

Значение , связанное с действием.

value?: any

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

any

valueType

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

valueType: string

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

string