botframework-schema package
Kelas
| CallerIdConstants |
Konstanta yang digunakan untuk mengisi properti Activity.callerId. |
| SpeechConstants |
Menentukan konstanta yang dapat digunakan dalam pemrosesan interaksi ucapan. |
Antarmuka
| CommandResultValue |
Bidang nilai ICommandResultActivity berisi metadata yang terkait dengan hasil perintah. Payload data opsional yang dapat diperluas dapat disertakan jika ditentukan oleh nama aktivitas perintah. Kehadiran bidang kesalahan menunjukkan bahwa perintah asli gagal diselesaikan. |
| CommandValue |
Bidang nilai ICommandActivity berisi metadata yang terkait dengan perintah. Payload data opsional yang dapat diperluas dapat disertakan jika ditentukan oleh nama aktivitas perintah. |
| IActivity | |
| ICommandActivity |
Perintah eksternal asinkron. |
| ICommandResultActivity |
Hasil perintah eksternal asinkron. |
| IContactRelationUpdateActivity | |
| IConversationUpdateActivity | |
| IEndOfConversationActivity | |
| IEventActivity | |
| IInstallationUpdateActivity | |
| IInvokeActivity | |
| IMessageActivity | |
| IMessageReactionActivity | |
| IMessageUpdateActivity | |
| ISuggestionActivity | |
| ITraceActivity | |
| Activity |
Aktivitas adalah jenis komunikasi dasar untuk protokol Bot Framework 3.0. |
| ActivityTimestamps |
Antarmuka ini digunakan untuk mempertahankan nilai string asli tanggal pada Aktivitas. Saat Aktivitas diterima, tanda waktu dikonversi ke Tanggal. Karena bagaimana objek Tanggal Javascript adalah UTC, nilai offset zona waktu hilang. |
| AdaptiveCardAuthentication |
Menentukan struktur yang tiba di aktivitas Activity.Value.Authentication for Invoke dengan Nama 'adaptiveCard/action'. |
| AdaptiveCardInvokeAction |
Menentukan struktur yang tiba dalam aktivitas Activity.Value.Action for Invoke dengan Nama 'adaptiveCard/action'. |
| AdaptiveCardInvokeResponse |
Menentukan struktur yang dikembalikan sebagai hasil dari aktivitas Panggil dengan Nama 'adaptiveCard/action'. |
| AdaptiveCardInvokeValue |
Menentukan struktur yang tiba dalam aktivitas Activity.Value for Invoke dengan Nama 'adaptiveCard/action'. |
| AnimationCard |
Kartu animasi (Misalnya: gif atau klip video pendek) |
| Attachment |
Lampiran dalam aktivitas |
| AttachmentData |
Data lampiran |
| AttachmentInfo |
Metadata untuk lampiran |
| AttachmentView |
Nama dan ukuran Tampilan Lampiran |
| AudioCard |
Kartu audio |
| BasicCard |
Kartu dasar |
| CardAction |
Tindakan yang dapat diklik |
| CardImage |
Gambar pada kartu |
| ChannelAccount |
Informasi akun saluran yang diperlukan untuk merutekan pesan |
| ConversationAccount |
Informasi akun saluran untuk percakapan |
| ConversationMembers |
Percakapan dan anggotanya |
| ConversationParameters |
Parameter untuk membuat percakapan baru |
| ConversationReference |
Objek yang berkaitan dengan titik tertentu dalam percakapan |
| ConversationResourceResponse |
Respons yang berisi sumber daya |
| ConversationsResult |
Hasil percakapan |
| Entity |
Objek metadata yang berkaitan dengan aktivitas |
| ErrorModel |
Objek yang mewakili informasi kesalahan |
| ErrorResponse |
Respons API HTTP |
| ExpectedReplies |
Balasan yang Diharapkan sebagai respons terhadap DeliveryModes.ExpectReplies |
| Fact |
Sekumpulan pasangan kunci-nilai. Keuntungan dari bagian ini adalah bahwa properti kunci dan nilai akan dirender dengan informasi gaya default dengan beberapa pemisah di antaranya. Jadi tidak perlu pengembang menentukan informasi gaya. |
| GeoCoordinates |
GeoCoordinates (jenis entitas: "https://schema.org/GeoCoordinates") |
| HeroCard |
Kartu Hero (kartu dengan satu gambar besar) |
| IStatusCodeError | |
| InnerHttpError |
Objek yang mewakili kesalahan http dalam |
| InvokeResponse |
Mewakili respons yang dikembalikan oleh bot saat menerima aktivitas |
| MediaCard |
Kartu media |
| MediaEventValue |
Parameter tambahan untuk peristiwa media |
| MediaUrl |
Media URL |
| Mention |
Sebutkan informasi (jenis entitas: "sebutkan") |
| MessageReaction |
Objek reaksi pesan |
| MicrosoftPayMethodData |
Data Metode Pembayaran W3C untuk Microsoft Pay |
| OAuthCard |
Kartu yang mewakili permintaan untuk melakukan masuk melalui OAuth |
| PagedMembersResult |
Halaman anggota. |
| PaymentAddress |
Alamat dalam Permintaan Pembayaran |
| PaymentCurrencyAmount |
Memasok jumlah moneter |
| PaymentDetails |
Menyediakan informasi tentang transaksi yang diminta |
| PaymentDetailsModifier |
Menyediakan detail yang memodifikasi PaymentDetails berdasarkan pengidentifikasi metode pembayaran |
| PaymentItem |
Menunjukkan untuk apa permintaan pembayaran dan nilai yang diminta |
| PaymentMethodData |
Menunjukkan serangkaian metode pembayaran yang didukung dan data spesifik metode pembayaran terkait untuk metode tersebut |
| PaymentOptions |
Menyediakan informasi tentang opsi yang diinginkan untuk permintaan pembayaran |
| PaymentRequest |
Permintaan untuk melakukan pembayaran |
| PaymentRequestComplete |
Payload dikirimkan saat menyelesaikan permintaan pembayaran |
| PaymentRequestCompleteResult |
Hasil dari permintaan pembayaran yang telah selesai |
| PaymentRequestUpdate |
Pembaruan untuk permintaan pembayaran |
| PaymentRequestUpdateResult |
Objek hasil dari operasi pemanggilan Pembaruan Permintaan Pembayaran |
| PaymentResponse |
PaymentResponse dikembalikan saat pengguna telah memilih metode pembayaran dan menyetujui permintaan pembayaran |
| PaymentShippingOption |
Menjelaskan opsi pengiriman |
| Place |
Tempat (jenis entitas: "https://schema.org/Place") |
| ReceiptCard |
Kartu tanda terima |
| ReceiptItem |
Item pada kartu tanda terima |
| ResourceResponse |
Respons yang berisi ID sumber daya |
| SearchInvokeOptions |
Menyediakan informasi tentang opsi yang diinginkan untuk SearchInvokeValue |
| SearchInvokeResponse |
Menentukan struktur yang dikembalikan sebagai hasil dari aktivitas Panggil dengan Nama 'aplikasi/pencarian'. |
| SearchInvokeValue |
Menentukan struktur yang tiba dalam aktivitas Activity.Value for Invoke dengan Nama 'application/search'. |
| SemanticAction |
Mewakili referensi ke tindakan terprogram |
| SignInUrlResponse | |
| SigninCard |
Kartu yang mewakili permintaan untuk masuk |
| SuggestedActions |
SuggestedActions yang dapat dilakukan |
| TextHighlight |
Mengacu pada substring konten dalam bidang lain |
| Thing |
Hal (jenis entitas: "https://schema.org/Thing") |
| ThumbnailCard |
Kartu gambar mini (kartu dengan gambar mini kecil tunggal) |
| ThumbnailUrl |
URL Gambar Mini |
| TokenExchangeRequest | |
| TokenExchangeResource | |
| TokenRequest |
Permintaan untuk menerima token pengguna |
| TokenResponse |
Respons yang menyertakan token pengguna |
| Transcript |
Transkrip |
| VideoCard |
Kartu video |
| 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 |
Permintaan untuk bertukar token. |
| TokenExchangeInvokeResponse |
Objek respons dari pemanggilan pertukaran token. |
Alias Jenis
| IHandoffActivity | |
| IMessageDeleteActivity | |
| ITypingActivity | |
| TokenExchangeState |
Objek status diteruskan ke layanan token bot. |
| TokenStatus |
Status token tertentu. |
| FileDownloadInfoAttachment | |
| O365ConnectorCardActionType |
Menentukan nilai untuk Jenis. Nilai yang mungkin termasuk: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' |
| O365ConnectorCardInputType |
Menentukan nilai untuk O365ConnectorCardInputType. Nilai yang mungkin termasuk: 'textInput', 'dateInput', 'multichoiceInput' |
| Action |
Menentukan nilai untuk Tindakan. Nilai yang mungkin termasuk: 'terima', 'tolak' |
| ActivityImageType |
Menentukan nilai untuk ActivityImageType. Nilai yang mungkin termasuk: 'avatar', 'artikel' |
| ApplicationIdentityType |
Menentukan nilai untuk ApplicationIdentityType. Nilai yang mungkin termasuk: 'aadApplication', 'bot', 'tenantBot', 'office365Connector', 'webhook' |
| AttachmentLayout |
Menentukan nilai untuk AttachmentLayout. Nilai yang mungkin termasuk: 'list', 'grid' |
| BotMessagePreviewActionType |
Menentukan nilai untuk BotMessagePreviewActionType. Nilai yang mungkin termasuk: 'edit', 'kirim' |
| BotMessagePreviewType |
Menentukan nilai untuk BotMessagePreviewType. Nilai yang mungkin termasuk: 'pesan', 'lanjutkan' |
| CommandContext |
Menentukan nilai untuk CommandContext. Nilai yang mungkin termasuk: 'message', 'compose', 'commandbox' |
| ContentType |
Menentukan nilai untuk ContentType. Nilai yang mungkin termasuk: 'html', 'text' |
| ConversationIdentityType |
Menentukan nilai untuk ConversationIdentityType. Nilai yang mungkin termasuk: 'tim', 'saluran' |
| Importance |
Menentukan nilai untuk Kepentingan. Nilai yang mungkin termasuk: 'normal', 'high', 'urgent' |
| MessageType |
Menentukan nilai untuk MessageType. Nilai yang mungkin termasuk: 'pesan' |
| MessagingExtensionResultType |
Menentukan nilai untuk MessagingExtensionResultType. Nilai yang mungkin termasuk: 'result', 'auth', 'config', 'message', 'botMessagePreview', 'silentAuth'. |
| O365ConnectorCardInputBaseType |
Menentukan nilai untuk O365ConnectorCardInputBaseType. Nilai yang mungkin termasuk: 'textInput', 'dateInput', 'multichoiceInput' |
| Os |
Menentukan nilai untuk Os. Nilai yang mungkin termasuk: 'default', 'iOS', 'android', 'windows' |
| ReactionType |
Menentukan nilai untuk ReactionType. Nilai yang mungkin termasuk: 'like', 'heart', 'laugh', 'surprised', 'sad', 'angry' |
| Style |
Menentukan nilai untuk Gaya. Nilai yang mungkin termasuk: 'ringkas', 'diperluas' |
| Type |
Menentukan nilai untuk Jenis. Nilai yang mungkin termasuk: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' |
| Type1 | |
| Type2 | |
| Type3 | |
| UserIdentityType |
Menentukan nilai untuk UserIdentityType. Nilai yang mungkin termasuk: 'aadUser', 'onPremiseAadUser', 'anonymousGuest', 'federatedUser' |
Enum
| ActionTypes |
Menentukan nilai untuk ActionTypes. Nilai yang mungkin termasuk: 'openUrl', 'imBack', 'postBack', 'playAudio', 'playVideo', 'showImage', 'downloadFile', 'signin', 'call', messageBack', 'openApp' |
| ActivityEventNames |
Menentukan nilai untuk ActivityEventNames. Nilai yang mungkin termasuk: 'continueConversation', 'createConversation' |
| ActivityImportance |
Menentukan nilai untuk ActivityImportance. Nilai yang mungkin termasuk: 'rendah', 'normal', 'tinggi' |
| ActivityTypes |
Menentukan nilai untuk ActivityTypes. Nilai yang mungkin termasuk: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff' |
| AttachmentLayoutTypes |
Menentukan nilai untuk AttachmentLayoutTypes. Nilai yang mungkin termasuk: 'list', 'carousel' |
| Channels |
Menentukan nilai untuk ChannelIds untuk Saluran. Nilai yang mungkin termasuk: 'alexa', 'console', 'cortana', 'directline', 'directlinespeech', 'email', 'emulator', 'facebook', 'groupme', 'kik', 'line', 'msteams', 'onmichannel', 'outlook', 'skype', 'skypeforbusiness', 'slack', 'sms', 'telegram', 'test', 'twilio-sms', 'webchat' |
| ContactRelationUpdateActionTypes |
Menentukan nilai untuk ContactRelationUpdateActionTypes. Nilai yang mungkin termasuk: 'add', 'remove' |
| DeliveryModes |
Menentukan nilai untuk DeliveryModes. Nilai yang mungkin termasuk: 'normal', 'notification', 'expectReplies', 'ephemeral' |
| EndOfConversationCodes |
Menentukan nilai untuk EndOfConversationCodes. Nilai yang mungkin termasuk: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed' |
| InputHints |
Menentukan nilai untuk InputHints. Nilai yang mungkin termasuk: 'acceptingInput', 'ignoringInput', 'expectingInput' |
| InstallationUpdateActionTypes |
Menentukan nilai untuk InstallationUpdateActionTypes. Nilai yang mungkin termasuk: 'add', 'remove' |
| MessageReactionTypes |
Menentukan nilai untuk MessageReactionTypes. Nilai yang mungkin termasuk: 'like', 'plusOne' |
| RoleTypes |
Menentukan nilai untuk RoleTypes. Nilai yang mungkin termasuk: 'user', 'bot', 'skill' |
| SemanticActionStateTypes |
Menentukan nilai untuk SemanticActionStateTypes. Nilai yang mungkin termasuk: 'start', 'continue', 'done' |
| StatusCodes |
Menentukan nilai untuk StatusCodes. Nilai yang mungkin termasuk: 200, 400, 401, 404, 405, 409, 426, 500, 501, 502 |
| TextFormatTypes |
Menentukan nilai untuk TextFormatTypes. Nilai yang mungkin termasuk: 'markdown', 'plain', 'xml' |
Fungsi
Detail Fungsi
assertActivity(unknown, unknown[])
function assertActivity(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Mengembalikan
asserts
assertAttachment(unknown, unknown[])
function assertAttachment(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Mengembalikan
asserts
assertAttachmentInfo(unknown, unknown[])
function assertAttachmentInfo(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Mengembalikan
asserts
assertAttachmentView(unknown, unknown[])
function assertAttachmentView(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Mengembalikan
asserts
assertCardAction(unknown, unknown[])
function assertCardAction(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Mengembalikan
asserts
assertChannelAccount(unknown, unknown[])
function assertChannelAccount(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Mengembalikan
asserts
assertConversationAccount(unknown, unknown[])
function assertConversationAccount(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Mengembalikan
asserts
assertConversationReference(unknown, unknown[])
function assertConversationReference(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Mengembalikan
asserts
assertEntity(unknown, unknown[])
function assertEntity(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Mengembalikan
asserts
assertMessageReaction(unknown, unknown[])
function assertMessageReaction(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Mengembalikan
asserts
assertSemanticAction(unknown, unknown[])
function assertSemanticAction(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Mengembalikan
asserts
assertSuggestedActions(unknown, unknown[])
function assertSuggestedActions(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Mengembalikan
asserts
isActivity(unknown)
function isActivity(val: unknown): booleanParameter
- val
-
unknown
Mengembalikan
boolean
isAttachment(unknown)
function isAttachment(val: unknown): booleanParameter
- val
-
unknown
Mengembalikan
boolean
isAttachmentInfo(unknown)
function isAttachmentInfo(val: unknown): booleanParameter
- val
-
unknown
Mengembalikan
boolean
isAttachmentView(unknown)
function isAttachmentView(val: unknown): booleanParameter
- val
-
unknown
Mengembalikan
boolean
isCardAction(unknown)
function isCardAction(val: unknown): booleanParameter
- val
-
unknown
Mengembalikan
boolean
isChannelAccount(unknown)
function isChannelAccount(val: unknown): booleanParameter
- val
-
unknown
Mengembalikan
boolean
isConversationAccount(unknown)
function isConversationAccount(val: unknown): booleanParameter
- val
-
unknown
Mengembalikan
boolean
isConversationReference(unknown)
function isConversationReference(val: unknown): booleanParameter
- val
-
unknown
Mengembalikan
boolean
isEntity(unknown)
function isEntity(val: unknown): booleanParameter
- val
-
unknown
Mengembalikan
boolean
isMessageReaction(unknown)
function isMessageReaction(val: unknown): booleanParameter
- val
-
unknown
Mengembalikan
boolean
isSemanticAction(unknown)
function isSemanticAction(val: unknown): booleanParameter
- val
-
unknown
Mengembalikan
boolean
isSuggestedActions(unknown)
function isSuggestedActions(val: unknown): booleanParameter
- val
-
unknown
Mengembalikan
boolean