다음을 통해 공유


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

이름이 'adaptiveCard/action'인 Activity.Value.Authentication for Invoke 작업에 도착하는 구조를 정의합니다.

AdaptiveCardInvokeAction

이름이 'adaptiveCard/action'인 Activity.Value.Action for Invoke 작업에 도착하는 구조를 정의합니다.

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

Hero 카드(단일 큰 이미지가 있는 카드)

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

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

축소판 그림 카드(작은 썸네일 이미지가 있는 카드)

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에 대한 값을 정의합니다. 가능한 값은 다음과 같습니다 : '좋아요', '마음', '웃음', '놀랐다', '슬픈', '화가'

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

채널의 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