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

Activity interface

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

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

Свойства

action

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

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

Вложения
callerId

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

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

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

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

Определяет беседу, к которой относится действие.
deliveryMode

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

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

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

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

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

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

Важность действия. Возможные значения: "низкий", "обычный", "высокий"
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. Например, Америка/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

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

action?: string

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

string

attachmentLayout

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

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

Указание доставки для сигнала получателю альтернативных путей доставки для действия. Режим доставки по умолчанию — "по умолчанию". Возможные значения: "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

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

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. Например, Америка/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