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

このインターフェイスは、アクティビティの日付の元の文字列値を保持するために使用されます。 アクティビティを受信すると、タイムスタンプは Dates に変換されます。 Javascript Date オブジェクトは UTC であるため、タイムゾーンオフセット値は失われます。

AdaptiveCardAuthentication

名前が 'adaptiveCard/action' の Activity.Value.Authentication for Invoke アクティビティに到着する構造体を定義します。

AdaptiveCardInvokeAction

呼び出しアクティビティの Activity.Value.Action に到着する構造体を、"adaptiveCard/action" の名前で定義します。

AdaptiveCardInvokeResponse

名前が 'adaptiveCard/action' の Invoke アクティビティの結果として返される構造体を定義します。

AdaptiveCardInvokeValue

名前が 'adaptiveCard/action' の Activity.Value for Invoke アクティビティに到着する構造体を定義します。

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

ヒーロー カード (1 枚の大きな画像を含むカード)

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

Payment Request Update 呼び出し操作の結果オブジェクト

PaymentResponse

ユーザーが支払い方法を選択し、支払い要求を承認すると、PaymentResponse が返されます

PaymentShippingOption

配送オプションについて説明します

Place

Place (エンティティの種類: "https://schema.org/Place")

ReceiptCard

領収書カード

ReceiptItem

領収書カードの項目

ResourceResponse

リソース ID を含む応答

SearchInvokeOptions

SearchInvokeValue に必要なオプションに関する情報を提供します

SearchInvokeResponse

名前が 'application/search' の Invoke アクティビティの結果として返される構造体を定義します。

SearchInvokeValue

'application/search' の名前を使用して、Activity.Value for Invoke アクティビティに到着する構造体を定義します。

SemanticAction

プログラムによるアクションへの参照を表します

SignInUrlResponse
SigninCard

サインイン要求を表すカード

SuggestedActions

実行できる SuggestedActions

TextHighlight

別のフィールド内のコンテンツの部分文字列を参照します

Thing

モノ (エンティティ型: "https://schema.org/Thing")

ThumbnailCard

サムネイル カード (1 つの小さなサムネイル画像を含むカード)

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 の値を定義します。 使用可能な値は次のとおりです: 'アバター'、'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

重要度の値を定義します。 指定できる値は、'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'、'怒っている' などがあります。

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'、'カルーセル' です。

Channels

チャネルの ChannelId の値を定義します。 可能な値は次のとおりです: '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