botframework-schema package

Классы

CallerIdConstants

Константы, используемые для заполнения свойства Activity.callerId.

SpeechConstants

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

Интерфейсы

CommandResultValue

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

CommandValue

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

IActivity
ICommandActivity

Асинхронная внешняя команда.

ICommandResultActivity

Результат асинхронной внешней команды.

IContactRelationUpdateActivity
IConversationUpdateActivity
IEndOfConversationActivity
IEventActivity
IInstallationUpdateActivity
IInvokeActivity
IMessageActivity
IMessageReactionActivity
IMessageUpdateActivity
ISuggestionActivity
ITraceActivity
Activity

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

ActivityTimestamps

Этот интерфейс используется для сохранения исходных строковых значений дат в действиях. При получении действия метки времени преобразуются в даты. Из-за того, что объекты JavaScript Date имеют формат UTC, значения смещения часового пояса теряются.

AdaptiveCardAuthentication

Определяет структуру, которая поступает в действие Activity.Value.Authentication для вызова с именем adaptiveCard/action.

AdaptiveCardInvokeAction

Определяет структуру, которая поступает в действие Activity.Value.Action для вызова с именем adaptiveCard/action.

AdaptiveCardInvokeResponse

Определяет структуру, возвращаемую в результате действия Invoke с именем adaptiveCard/action.

AdaptiveCardInvokeValue

Определяет структуру, которая поступает в действие Activity.Value для действия Invoke с именем adaptiveCard/action.

AnimationCard

Карточка анимации (например, gif или короткий видеоклип)

Attachment

Вложение в действии

AttachmentData

Данные вложения

AttachmentInfo

Метаданные для вложения

AttachmentView

Имя и размер представления вложения

AudioCard

Аудиоадаптер

BasicCard

Базовая карточка

CardAction

Действие с щелчком

CardImage

Изображение на карточке

ChannelAccount

Сведения об учетной записи канала, необходимые для маршрутизации сообщения

ConversationAccount

Сведения об учетной записи канала для беседы

ConversationMembers

Беседа и ее участники

ConversationParameters

Параметры для создания новой беседы

ConversationReference

Объект, связанный с определенной точкой диалога

ConversationResourceResponse

Ответ, содержащий ресурс

ConversationsResult

Результат бесед

Entity

Объект метаданных, относящийся к действию

ErrorModel

Объект, представляющий сведения об ошибке

ErrorResponse

Ответ API HTTP

ExpectedReplies

Ожидаемые ответы в ответ на DeliveryModes.ExpectReplies

Fact

Набор пар "ключ-значение". Преимущество этого раздела заключается в том, что свойства ключа и значения будут отображаться со сведениями о стиле по умолчанию с некоторыми разделителями между ними. Поэтому разработчику не нужно указывать сведения о стиле.

GeoCoordinates

GeoCoordinates (тип сущности: "https://schema.org/GeoCoordinates")

HeroCard

Карточка "Главный имиджевый баннер" (карточка с одним большим изображением)

IStatusCodeError
InnerHttpError

Объект, представляющий внутреннюю ошибку HTTP

InvokeResponse

Представляет ответ, возвращаемый ботом при получении invoke действия. Этот интерфейс поддерживает платформу и не предназначен для вызова непосредственно для кода.

MediaCard

Карточка мультимедиа

MediaEventValue

Дополнительный параметр для событий мультимедиа

MediaUrl

URL-адрес носителя

Mention

Сведения об упоминании (тип сущности: "упоминание")

MessageReaction

Объект реакции сообщения

MicrosoftPayMethodData

Данные метода оплаты W3C для Microsoft Pay

OAuthCard

Карточка, представляющая запрос на выполнение входа с помощью OAuth

PagedMembersResult

Страница элементов.

PaymentAddress

Адрес в запросе на оплату

PaymentCurrencyAmount

Поставляет денежные суммы

PaymentDetails

Предоставляет сведения о запрошенной транзакции.

PaymentDetailsModifier

Предоставляет сведения, изменяющие PaymentDetails на основе идентификатора метода оплаты.

PaymentItem

Указывает значение запроса на оплату и запрашиваемое значение.

PaymentMethodData

Указывает набор поддерживаемых методов оплаты и все связанные с ними данные для этих методов оплаты.

PaymentOptions

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

PaymentRequest

Запрос на оплату

PaymentRequestComplete

Полезные данные, доставленные при выполнении запроса на оплату

PaymentRequestCompleteResult

Результат выполнения запроса на оплату

PaymentRequestUpdate

Обновление запроса на оплату

PaymentRequestUpdateResult

Результирующий объект из операции вызова обновления запроса на оплату

PaymentResponse

PaymentResponse возвращается, когда пользователь выбрал метод оплаты и утвердил запрос на оплату.

PaymentShippingOption

Описание варианта доставки

Place

Place (тип сущности: "https://schema.org/Place")

ReceiptCard

Карточка квитанции

ReceiptItem

Элемент на карточке квитанции

ResourceResponse

Ответ, содержащий идентификатор ресурса

SearchInvokeOptions

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

SearchInvokeResponse

Определяет структуру, возвращаемую в результате действия Invoke с именем "приложение/поиск".

SearchInvokeValue

Определяет структуру, которая поступает в действие Activity.Value для действия Invoke с именем "application/search".

SemanticAction

Представляет ссылку на программное действие

SignInUrlResponse
SigninCard

Карточка, представляющая запрос на вход

SuggestedActions

Предлагаемые действия, которые можно выполнить

TextHighlight

Ссылается на подстроку содержимого в другом поле

Thing

Вещь (тип сущности: "https://schema.org/Thing")

ThumbnailCard

Карточка эскиза (карточка с одним маленьким эскизом)

ThumbnailUrl

URL-адрес эскиза

TokenExchangeRequest
TokenExchangeResource
TokenRequest

Запрос на получение маркера пользователя

TokenResponse

Ответ, содержащий маркер пользователя

Transcript

Запись

VideoCard

Видеоадаптер

MessageActionsPayloadBody
O365ConnectorCardActionBase
O365ConnectorCardInputBase
TeamsAttachment
AppBasedLinkQuery
CacheInfo
ChannelInfo
ConversationList
FileConsentCard
FileConsentCardResponse
FileDownloadInfo
FileInfoCard
FileUploadInfo
Meeting
MeetingDetails
MeetingDetailsBase
MeetingEndEventDetails
MeetingEventDetails
MeetingInfo
MeetingStartEventDetails
MessageActionsPayload
MessageActionsPayloadApp
MessageActionsPayloadAttachment
MessageActionsPayloadConversation
MessageActionsPayloadFrom
MessageActionsPayloadMention
MessageActionsPayloadReaction
MessageActionsPayloadUser
MessagingExtensionAction
MessagingExtensionActionResponse
MessagingExtensionAttachment
MessagingExtensionParameter
MessagingExtensionQuery
MessagingExtensionQueryOptions
MessagingExtensionResponse
MessagingExtensionResult
MessagingExtensionSuggestedAction
NotificationInfo
O365ConnectorCard
O365ConnectorCardActionCard
O365ConnectorCardActionQuery
O365ConnectorCardDateInput
O365ConnectorCardFact
O365ConnectorCardHttpPOST
O365ConnectorCardImage
O365ConnectorCardMultichoiceInput
O365ConnectorCardMultichoiceInputChoice
O365ConnectorCardOpenUri
O365ConnectorCardOpenUriTarget
O365ConnectorCardSection
O365ConnectorCardTextInput
O365ConnectorCardViewAction
SigninStateVerificationQuery
TabContext
TabEntityContext
TabRequest
TabResponse
TabResponseCard
TabResponseCards
TabResponsePayload
TabSubmit
TabSubmitData
TabSuggestedActions
TaskModuleCardResponse
TaskModuleContinueResponse
TaskModuleMessageResponse
TaskModuleRequest
TaskModuleRequestContext
TaskModuleResponse
TaskModuleResponseBase
TaskModuleTaskInfo
TeamDetails
TeamInfo
TeamsChannelAccount
TeamsChannelData
TeamsChannelDataSettings
TeamsMeetingInfo
TeamsMeetingParticipant
TeamsPagedMembersResult
TenantInfo
TokenExchangeInvokeRequest

Запрос на обмен маркером.

TokenExchangeInvokeResponse

Объект ответа вызова обмена маркерами.

Псевдонимы типа

IHandoffActivity
IMessageDeleteActivity
ITypingActivity
TokenExchangeState

Объект состояния, переданный в службу токенов бота.

TokenStatus

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

FileDownloadInfoAttachment
O365ConnectorCardActionType

Определяет значения для типа. Возможные значения: ViewAction, OpenUri, HttpPOST, ActionCard.

O365ConnectorCardInputType

Определяет значения для O365ConnectorCardInputType. Возможные значения: "textInput", "dateInput", "multichoiceInput"

Action

Определяет значения для action. Возможные значения: "принять", "отклонить"

ActivityImageType

Определяет значения для ActivityImageType. Возможные значения: "аватар", "статья"

ApplicationIdentityType

Определяет значения для ApplicationIdentityType. Возможные значения: aadApplication, bot, tenantBot, office365Connector, webhook.

AttachmentLayout

Определяет значения для AttachmentLayout. Возможные значения: "list", "grid"

BotMessagePreviewActionType

Определяет значения для BotMessagePreviewActionType. Возможные значения: "edit", "send"

BotMessagePreviewType

Определяет значения для BotMessagePreviewType. Возможные значения: "message", "continue"

CommandContext

Определяет значения для CommandContext. Возможные значения: "message", "compose", "commandbox"

ContentType

Определяет значения для ContentType. Возможные значения: "html", "text"

ConversationIdentityType

Определяет значения для ConversationIdentityType. Возможные значения: "команда", "канал"

Importance

Определяет значения для параметра Importance. Возможные значения: normal, high, urgent

MessageType

Определяет значения для MessageType. Возможные значения: "message"

MessagingExtensionResultType

Определяет значения для MessagingExtensionResultType. Возможные значения: "result", "auth", "config", "message", "botMessagePreview", "silentAuth".

O365ConnectorCardInputBaseType

Определяет значения для O365ConnectorCardInputBaseType. Возможные значения: "textInput", "dateInput", "multichoiceInput"

Os

Определяет значения для Ос. Возможные значения: "default", "iOS", "android", "windows"

ReactionType

Определяет значения для ReactionType. Возможные значения: "like", "heart", "laugh", "surprised", "sad", "angry"

Style

Определяет значения для style. Возможные значения: "compact", "expanded"

Type

Определяет значения для типа. Возможные значения: "ViewAction", "OpenUri", "HttpPOST", "ActionCard".

Type1
Type2
Type3
UserIdentityType

Определяет значения для UserIdentityType. Возможные значения: "aadUser", "onPremiseAadUser", "anonymousGuest", "federatedUser"

Перечисления

ActionTypes

Определяет значения для ActionTypes. Возможные значения: "openUrl", "imBack", "postBack", "playAudio", "playVideo", "showImage", "downloadFile", "signin", "call", messageBack, "openApp"

ActivityEventNames

Определяет значения для ActivityEventNames. Возможные значения: continueConversation, createConversation.

ActivityImportance

Определяет значения activityImportance. Возможные значения: low, normal, high

ActivityTypes

Определяет значения для ActivityTypes. Возможные значения: "message", "contactRelationUpdate", "conversationUpdate", "typing", "endOfConversation", "event", "invoke", "deleteUserData", "messageUpdate", "messageDelete", "installationUpdate", "messageReaction", "suggestion", "trace", "handoff"

AttachmentLayoutTypes

Определяет значения для AttachmentLayoutTypes. Возможные значения: "list", "карусель"

Channels

Определяет значения channelIds для каналов. Возможные значения: alexa, 'console', 'cortana', 'directline', 'directlinespeech', 'email', 'emulator', 'facebook', 'groupme', 'kik', 'line', 'msteams', 'onmichannel', 'outlook', 'skype', 'skypeforbusiness', 'slack', 'sms', 'telegram', 'test', 'twilio-sms', 'webchat'

ContactRelationUpdateActionTypes

Определяет значения для ContactRelationUpdateActionTypes. Возможные значения: "add", "remove"

DeliveryModes

Определяет значения для DeliveryModes. Возможные значения: "normal", "notification", "expectReplies", "ephemeral"

EndOfConversationCodes

Определяет значения для EndOfConversationCodes. Возможные значения: unknown, completedSuccessfully, userCancelled, botTimedOut, botIssuedInvalidMessage, channelFailed.

InputHints

Определяет значения для InputHints. Возможные значения: acceptingInput, ignoringInput, expectingInput.

InstallationUpdateActionTypes

Определяет значения для InstallationUpdateActionTypes. Возможные значения: "add", "remove"

MessageReactionTypes

Определяет значения для MessageReactionTypes. Возможные значения: like, plusOne

RoleTypes

Определяет значения для RoleTypes. Возможные значения: "пользователь", "бот", "навык"

SemanticActionStateTypes

Определяет значения для SemanticActionStateTypes. Возможные значения: start, continue, done.

StatusCodes

Определяет значения для StatusCodes. Возможные значения: 200, 400, 401, 404, 405, 409, 426, 500, 501, 502

TextFormatTypes

Определяет значения для TextFormatTypes. Возможные значения: "markdown", "plain", "xml"

Функции

assertActivity(unknown, unknown[])
assertAttachment(unknown, unknown[])
assertAttachmentInfo(unknown, unknown[])
assertAttachmentView(unknown, unknown[])
assertCardAction(unknown, unknown[])
assertChannelAccount(unknown, unknown[])
assertConversationAccount(unknown, unknown[])
assertConversationReference(unknown, unknown[])
assertEntity(unknown, unknown[])
assertMessageReaction(unknown, unknown[])
assertSemanticAction(unknown, unknown[])
assertSuggestedActions(unknown, unknown[])
isActivity(unknown)
isAttachment(unknown)
isAttachmentInfo(unknown)
isAttachmentView(unknown)
isCardAction(unknown)
isChannelAccount(unknown)
isConversationAccount(unknown)
isConversationReference(unknown)
isEntity(unknown)
isMessageReaction(unknown)
isSemanticAction(unknown)
isSuggestedActions(unknown)

Сведения о функции

assertActivity(unknown, unknown[])

function assertActivity(val: unknown, _args: unknown[]): asserts

Параметры

val

unknown

_args

unknown[]

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

asserts

assertAttachment(unknown, unknown[])

function assertAttachment(val: unknown, _args: unknown[]): asserts

Параметры

val

unknown

_args

unknown[]

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

asserts

assertAttachmentInfo(unknown, unknown[])

function assertAttachmentInfo(val: unknown, _args: unknown[]): asserts

Параметры

val

unknown

_args

unknown[]

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

asserts

assertAttachmentView(unknown, unknown[])

function assertAttachmentView(val: unknown, _args: unknown[]): asserts

Параметры

val

unknown

_args

unknown[]

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

asserts

assertCardAction(unknown, unknown[])

function assertCardAction(val: unknown, _args: unknown[]): asserts

Параметры

val

unknown

_args

unknown[]

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

asserts

assertChannelAccount(unknown, unknown[])

function assertChannelAccount(val: unknown, _args: unknown[]): asserts

Параметры

val

unknown

_args

unknown[]

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

asserts

assertConversationAccount(unknown, unknown[])

function assertConversationAccount(val: unknown, _args: unknown[]): asserts

Параметры

val

unknown

_args

unknown[]

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

asserts

assertConversationReference(unknown, unknown[])

function assertConversationReference(val: unknown, _args: unknown[]): asserts

Параметры

val

unknown

_args

unknown[]

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

asserts

assertEntity(unknown, unknown[])

function assertEntity(val: unknown, _args: unknown[]): asserts

Параметры

val

unknown

_args

unknown[]

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

asserts

assertMessageReaction(unknown, unknown[])

function assertMessageReaction(val: unknown, _args: unknown[]): asserts

Параметры

val

unknown

_args

unknown[]

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

asserts

assertSemanticAction(unknown, unknown[])

function assertSemanticAction(val: unknown, _args: unknown[]): asserts

Параметры

val

unknown

_args

unknown[]

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

asserts

assertSuggestedActions(unknown, unknown[])

function assertSuggestedActions(val: unknown, _args: unknown[]): asserts

Параметры

val

unknown

_args

unknown[]

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

asserts

isActivity(unknown)

function isActivity(val: unknown): boolean

Параметры

val

unknown

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

boolean

isAttachment(unknown)

function isAttachment(val: unknown): boolean

Параметры

val

unknown

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

boolean

isAttachmentInfo(unknown)

function isAttachmentInfo(val: unknown): boolean

Параметры

val

unknown

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

boolean

isAttachmentView(unknown)

function isAttachmentView(val: unknown): boolean

Параметры

val

unknown

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

boolean

isCardAction(unknown)

function isCardAction(val: unknown): boolean

Параметры

val

unknown

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

boolean

isChannelAccount(unknown)

function isChannelAccount(val: unknown): boolean

Параметры

val

unknown

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

boolean

isConversationAccount(unknown)

function isConversationAccount(val: unknown): boolean

Параметры

val

unknown

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

boolean

isConversationReference(unknown)

function isConversationReference(val: unknown): boolean

Параметры

val

unknown

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

boolean

isEntity(unknown)

function isEntity(val: unknown): boolean

Параметры

val

unknown

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

boolean

isMessageReaction(unknown)

function isMessageReaction(val: unknown): boolean

Параметры

val

unknown

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

boolean

isSemanticAction(unknown)

function isSemanticAction(val: unknown): boolean

Параметры

val

unknown

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

boolean

isSuggestedActions(unknown)

function isSuggestedActions(val: unknown): boolean

Параметры

val

unknown

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

boolean