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	定义 Name 为“adaptiveCard/action”的 Invoke 活动到达的 Activity.Value.Authentication 中的结构。
AdaptiveCardInvokeAction	定义 Name 为“adaptiveCard/action”的 Invoke 活动的 Activity.Value.Action 中到达的结构。
AdaptiveCardInvokeResponse	定义作为 Invoke 活动的结果返回的结构，其名称为“adaptiveCard/action”。
AdaptiveCardInvokeValue	定义到达 Activity.Value 的 Invoke 活动的结构，名称为“adaptiveCard/action”。
AnimationCard	动画卡 (Ex：gif 或短视频剪辑)
Attachment	活动中的附件
AttachmentData	附件数据
AttachmentInfo	附件的元数据
AttachmentView	附件视图名称和大小
AudioCard	音频卡
BasicCard	基本卡
CardAction	可单击的操作
CardImage	卡上的图像
ChannelAccount	路由消息所需的频道帐户信息
ConversationAccount	对话的频道帐户信息
ConversationMembers	对话及其成员
ConversationParameters	用于创建新对话的参数
ConversationReference	与会话中的特定点相关的对象
ConversationResourceResponse	包含资源的响应
ConversationsResult	对话结果
Entity	与活动相关的元数据对象
ErrorModel	表示错误信息的对象
ErrorResponse	HTTP API 响应
ExpectedReplies	响应 DeliveryModes.ExpectReplies 的预期答复
Fact	键值对集。 本部分的优点是，键和值属性将使用默认样式信息呈现，并在它们之间使用一些分隔符。 因此，开发人员无需指定样式信息。
GeoCoordinates	GeoCoordinates (实体类型：“https://schema.org/GeoCoordinates")
HeroCard	具有单个大图像的英雄卡 (卡)
IStatusCodeError
InnerHttpError	表示内部 http 错误的对象
InvokeResponse	表示机器人在收到活动时返回的 invoke 响应。 此接口支持框架，不应直接为代码调用。
MediaCard	媒体卡
MediaEventValue	媒体事件的补充参数
MediaUrl	媒体 URL
Mention	提及信息 (实体类型：“提及”)
MessageReaction	消息反应对象
MicrosoftPayMethodData	Microsoft Pay的 W3C 付款方式数据
OAuthCard	表示通过 OAuth 执行登录请求的卡
PagedMembersResult	成员页。
PaymentAddress	付款请求中的地址
PaymentCurrencyAmount	提供货币金额
PaymentDetails	提供有关所请求事务的信息
PaymentDetailsModifier	提供基于付款方式标识符修改 PaymentDetails 的详细信息
PaymentItem	指示付款请求的用途以及请求的值
PaymentMethodData	指示一组受支持的付款方式以及这些方法的任何关联付款方式特定数据
PaymentOptions	提供有关付款请求所需选项的信息
PaymentRequest	付款请求
PaymentRequestComplete	完成付款请求时交付的有效负载
PaymentRequestCompleteResult	完成的付款请求的结果
PaymentRequestUpdate	付款请求的更新
PaymentRequestUpdateResult	付款请求更新调用操作的结果对象
PaymentResponse	当用户选择付款方式并批准付款请求时，将返回 PaymentResponse
PaymentShippingOption	描述寄送选项
Place	放置 (实体类型：“https://schema.org/Place")
ReceiptCard	收据卡
ReceiptItem	收据卡上的项目
ResourceResponse	包含资源 ID 的响应
SearchInvokeOptions	提供有关 SearchInvokeValue 所需选项的信息
SearchInvokeResponse	定义作为 Invoke 活动的结果返回的结构，其名称为“application/search”。
SearchInvokeValue	定义 Name 为“application/search”的 Invoke 活动的 Activity.Value 中到达的结构。
SemanticAction	表示对编程操作的引用
SignInUrlResponse
SigninCard	表示登录请求的卡
SuggestedActions	可以执行的 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	定义 Type 的值。 可能的值包括：“ViewAction”、“OpenUri”、“HttpPOST”、“ActionCard”
O365ConnectorCardInputType	定义 O365ConnectorCardInputType 的值。 可能的值包括：“textInput”、“dateInput”、“multichoiceInput”
Action	定义 Action 的值。 可能的值包括：“accept”、“decline”
ActivityImageType	定义 ActivityImageType 的值。 可能的值包括：“avatar”、“article”
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 的值。 可能的值包括：“team”、“channel”
Importance	定义 Importance 的值。 可能的值包括：“normal”、“high”、“urgent”
MessageType	定义 MessageType 的值。 可能的值包括：“message”
MessagingExtensionResultType	定义 MessagingExtensionResultType 的值。 可能的值包括：“result”、“auth”、“config”、“message”、“botMessagePreview”、“silentAuth”。
O365ConnectorCardInputBaseType	定义 O365ConnectorCardInputBaseType 的值。 可能的值包括：“textInput”、“dateInput”、“multichoiceInput”
Os	定义 Os 的值。 可能的值包括：“default”、“iOS”、“android”、“windows”
ReactionType	定义 ReactionType 的值。 可能的值包括：“like”、“heart”、“laugh”、“surprised”、“sad”、“angry”
Style	定义 Style 的值。 可能的值包括：“compact”、“expanded”
Type	定义 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”、“carousel”
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 的值。 可能的值包括：“user”、“bot”、“skill”
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