共用方式為


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 for Invoke 活動的結構,其名稱為 'adaptiveCard/action'。

AdaptiveCardInvokeAction

使用 'adaptiveCard/action' 的名稱,定義抵達 Invoke 活動的 Activity.Value.Action 結構。

AdaptiveCardInvokeResponse

定義以 『adaptiveCard/action』 名稱叫用活動的結果傳回的結構。

AdaptiveCardInvokeValue

使用 'adaptiveCard/action' 名稱,定義抵達 Invoke 活動的 Activity.Value 中的結構。

AnimationCard

動畫卡(例如: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

表示 Bot 收到 invoke 活動時所傳回的回應。 此介面支持架構,並不適合直接為您的程式代碼呼叫。

MediaCard

媒體卡片

MediaEventValue

媒體事件的補充參數

MediaUrl

媒體 URL

Mention

提及資訊(實體類型:“mention”)

MessageReaction

Message reaction 物件

MicrosoftPayMethodData

Microsoft付款的 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

包含資源標識碼的回應

SearchInvokeOptions

提供 SearchInvokeValue 所需選項的相關信息

SearchInvokeResponse

定義以 『application/search』 名稱叫用活動的結果傳回的結構。

SearchInvokeValue

定義結構,此結構會以 『application/search』 名稱抵達 Activity.Value for Invoke 活動。

SemanticAction

表示程式設計動作的參考

SignInUrlResponse
SigninCard

代表登入要求的卡片

SuggestedActions

可執行的 SuggestedActions

TextHighlight

參考另一個字段內內容的子字串

Thing

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

傳遞至 Bot 令牌服務的狀態物件。

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