botframework-schema package
Klassen
| CallerIdConstants |
Konstanten, die zum Auffüllen der Activity.callerId-Eigenschaft verwendet werden. |
| SpeechConstants |
Definiert Konstanten, die bei der Verarbeitung von Sprachinteraktionen verwendet werden können. |
Schnittstellen
| CommandResultValue |
Das Wertfeld einer ICommandResultActivity enthält Metadaten im Zusammenhang mit einem Befehlsergebnis. Eine optionale erweiterbare Datennutzlast kann eingeschlossen werden, wenn sie durch den Befehlsaktivitätsnamen definiert ist. Das Vorhandensein eines Fehlerfelds gibt an, dass der ursprüngliche Befehl nicht abgeschlossen werden konnte. |
| CommandValue |
Das Wertfeld einer ICommandActivity enthält Metadaten im Zusammenhang mit einem Befehl. Eine optionale erweiterbare Datennutzlast kann eingeschlossen werden, wenn sie durch den Befehlsaktivitätsnamen definiert ist. |
| IActivity | |
| ICommandActivity |
Asynchroner externer Befehl. |
| ICommandResultActivity |
Ergebnis asynchroner externer Befehle. |
| IContactRelationUpdateActivity | |
| IConversationUpdateActivity | |
| IEndOfConversationActivity | |
| IEventActivity | |
| IInstallationUpdateActivity | |
| IInvokeActivity | |
| IMessageActivity | |
| IMessageReactionActivity | |
| IMessageUpdateActivity | |
| ISuggestionActivity | |
| ITraceActivity | |
| Activity |
Eine Aktivität ist der grundlegende Kommunikationstyp für das Bot Framework 3.0-Protokoll. |
| ActivityTimestamps |
Diese Schnittstelle wird verwendet, um die ursprünglichen Zeichenfolgenwerte von Datumsangaben für Aktivitäten beizubehalten. Wenn eine Aktivität empfangen wird, werden Zeitstempel in Datumsangaben konvertiert. Da Javascript Date-Objekte UTC sind, gehen Offsetwerte für Zeitzonen verloren. |
| AdaptiveCardAuthentication |
Definiert die Struktur, die in der Aktivität "Activity.Value.Authentication for Invoke" mit dem Namen "adaptiveCard/action" eingeht. |
| AdaptiveCardInvokeAction |
Definiert die Struktur, die in "Activity.Value.Action" für "Invoke"-Aktivität mit dem Namen "adaptiveCard/action" eingeht. |
| AdaptiveCardInvokeResponse |
Definiert die Struktur, die als Ergebnis einer Aufrufaktivität mit dem Namen "adaptiveCard/action" zurückgegeben wird. |
| AdaptiveCardInvokeValue |
Definiert die Struktur, die in "Activity.Value" für "Invoke"-Aktivität mit dem Namen "adaptiveCard/action" eingeht. |
| AnimationCard |
Eine Animationskarte (z. B. GIF oder kurzer Videoclip) |
| Attachment |
Eine Anlage innerhalb einer Aktivität |
| AttachmentData |
Anlagendaten |
| AttachmentInfo |
Metadaten für eine Anlage |
| AttachmentView |
Name und Größe der Anlagenansicht |
| AudioCard |
Audiokarte |
| BasicCard |
Eine einfache Karte |
| CardAction |
Eine klickbare Aktion |
| CardImage |
Ein Bild auf einer Karte |
| ChannelAccount |
Kanalkontoinformationen, die zum Weiterleiten einer Nachricht erforderlich sind |
| ConversationAccount |
Kanalkontoinformationen für eine Unterhaltung |
| ConversationMembers |
Unterhaltung und deren Mitglieder |
| ConversationParameters |
Parameter zum Erstellen einer neuen Unterhaltung |
| ConversationReference |
Ein Objekt, das sich auf einen bestimmten Punkt in einer Unterhaltung bezieht |
| ConversationResourceResponse |
Eine Antwort, die eine Ressource enthält |
| ConversationsResult |
Ergebnis der Unterhaltungen |
| Entity |
Metadatenobjekt, das sich auf eine Aktivität bezieht |
| ErrorModel |
Objekt, das Fehlerinformationen darstellt |
| ErrorResponse |
Eine HTTP-API-Antwort |
| ExpectedReplies |
Erwartete Antworten als Antwort auf DeliveryModes.ExpectReplies |
| Fact |
Set of key-value pairs. Der Vorteil dieses Abschnitts besteht darin, dass Schlüssel- und Werteigenschaften mit Standardformatinformationen mit einigen Trennzeichen dazwischen gerendert werden. Daher ist es nicht erforderlich, dass Entwickler Formatinformationen angeben müssen. |
| GeoCoordinates |
GeoCoordinates (Entitätstyp: "https://schema.org/GeoCoordinates") |
| HeroCard |
Eine Hero-Karte (Karte mit einem einzigen, großen Bild) |
| IStatusCodeError | |
| InnerHttpError |
Objekt, das inneren HTTP-Fehler darstellt |
| InvokeResponse |
Stellt eine Antwort dar, die von einem Bot zurückgegeben wird, wenn sie eine |
| MediaCard |
Medienkarte |
| MediaEventValue |
Ergänzender Parameter für Medienereignisse |
| MediaUrl |
Medien-URL |
| Mention |
Erwähnungsinformationen (Entitätstyp: "Erwähnung") |
| MessageReaction |
Nachrichtenreaktionsobjekt |
| MicrosoftPayMethodData |
W3C-Zahlungsmethodendaten für Microsoft Pay |
| OAuthCard |
Eine Karte, die eine Anforderung zum Durchführen einer Anmeldung über OAuth darstellt |
| PagedMembersResult |
Seite der Mitglieder. |
| PaymentAddress |
Adresse innerhalb einer Zahlungsanfrage |
| PaymentCurrencyAmount |
Liefert Geldbeträge |
| PaymentDetails |
Stellt Informationen zur angeforderten Transaktion bereit. |
| PaymentDetailsModifier |
Enthält Details, die die PaymentDetails basierend auf der Zahlungsmethoden-ID ändern. |
| PaymentItem |
Gibt an, wofür die Zahlungsanforderung gilt und welcher Wert angefordert wird. |
| PaymentMethodData |
Gibt eine Reihe unterstützter Zahlungsmethoden und alle zugehörigen spezifischen Zahlungsmethoden für diese Methoden an. |
| PaymentOptions |
Stellt Informationen zu den für die Zahlungsanforderung gewünschten Optionen bereit. |
| PaymentRequest |
Eine Anforderung zur Zahlung |
| PaymentRequestComplete |
Nutzlast, die beim Ausfüllen einer Zahlungsanforderung übermittelt wird |
| PaymentRequestCompleteResult |
Ergebnis einer abgeschlossenen Zahlungsanforderung |
| PaymentRequestUpdate |
Aktualisierung einer Zahlungsanfrage |
| PaymentRequestUpdateResult |
Ein Ergebnisobjekt aus einem Aufrufvorgang für zahlungsanforderungsaktualisierungen |
| PaymentResponse |
Eine PaymentResponse wird zurückgegeben, wenn ein Benutzer eine Zahlungsmethode ausgewählt und eine Zahlungsanforderung genehmigt hat. |
| PaymentShippingOption |
Beschreibt eine Versandoption |
| Place |
Place (Entitätstyp: "https://schema.org/Place") |
| ReceiptCard |
Eine Belegkarte |
| ReceiptItem |
Ein Element auf einer Belegkarte |
| ResourceResponse |
Eine Antwort, die eine Ressourcen-ID enthält |
| SearchInvokeOptions |
Enthält Informationen zu den gewünschten Optionen für eine SearchInvokeValue- |
| SearchInvokeResponse |
Definiert die Struktur, die als Ergebnis einer Aufrufaktivität mit dem Namen "application/search" zurückgegeben wird. |
| SearchInvokeValue |
Definiert die Struktur, die in "Activity.Value" für "Invoke"-Aktivität mit dem Namen "application/search" eingeht. |
| SemanticAction |
Stellt einen Verweis auf eine programmgesteuerte Aktion dar. |
| SignInUrlResponse | |
| SigninCard |
Eine Karte, die eine Anforderung zum Anmelden darstellt |
| SuggestedActions |
SuggestedActions, die ausgeführt werden können |
| TextHighlight |
Verweist auf eine Teilzeichenfolge von Inhalt innerhalb eines anderen Felds |
| Thing |
Thing (Entitätstyp: "https://schema.org/Thing") |
| ThumbnailCard |
Eine Miniaturansichtskarte (Karte mit einem einzelnen, kleinen Miniaturbild) |
| ThumbnailUrl |
Miniaturansichts-URL |
| TokenExchangeRequest | |
| TokenExchangeResource | |
| TokenRequest |
Eine Anforderung zum Empfangen eines Benutzertokens |
| TokenResponse |
Eine Antwort, die ein Benutzertoken enthält |
| Transcript |
Abschrift |
| VideoCard |
Grafikkarte |
| 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 |
Eine Anforderung zum Austauschen eines Tokens. |
| TokenExchangeInvokeResponse |
Das Antwortobjekt eines Tokenaustausch-Aufrufs. |
Typaliase
| IHandoffActivity | |
| IMessageDeleteActivity | |
| ITypingActivity | |
| TokenExchangeState |
State-Objekt, das an den Bot-Tokendienst übergeben wird. |
| TokenStatus |
Der Status eines bestimmten Tokens. |
| FileDownloadInfoAttachment | |
| O365ConnectorCardActionType |
Definiert Werte für Type. Mögliche Werte sind: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' |
| O365ConnectorCardInputType |
Definiert Werte für O365ConnectorCardInputType. Mögliche Werte sind: 'textInput', 'dateInput', 'multichoiceInput' |
| Action |
Definiert Werte für Action. Mögliche Werte sind: "annehmen", "ablehnen" |
| ActivityImageType |
Definiert Werte für ActivityImageType. Mögliche Werte sind: "Avatar", "Artikel" |
| ApplicationIdentityType |
Definiert Werte für ApplicationIdentityType. Mögliche Werte sind: 'aadApplication', 'bot', 'tenantBot', 'office365Connector', 'webhook' |
| AttachmentLayout |
Definiert Werte für AttachmentLayout. Mögliche Werte sind: 'list', 'grid' |
| BotMessagePreviewActionType |
Definiert Werte für BotMessagePreviewActionType. Mögliche Werte sind: 'edit', 'send' |
| BotMessagePreviewType |
Definiert Werte für BotMessagePreviewType. Mögliche Werte sind: 'message', 'continue' |
| CommandContext |
Definiert Werte für CommandContext. Mögliche Werte sind: 'message', 'compose', 'commandbox' |
| ContentType |
Definiert Werte für ContentType. Mögliche Werte sind: 'html', 'text' |
| ConversationIdentityType |
Definiert Werte für ConversationIdentityType. Mögliche Werte sind: "Team", "Kanal" |
| Importance |
Definiert Werte für Wichtigkeit. Mögliche Werte sind: "normal", "hoch", "dringend" |
| MessageType |
Definiert Werte für MessageType. Mögliche Werte sind: "message" |
| MessagingExtensionResultType |
Definiert Werte für MessagingExtensionResultType. Mögliche Werte sind: 'result', 'auth', 'config', 'message', 'botMessagePreview', 'silentAuth'. |
| O365ConnectorCardInputBaseType |
Definiert Werte für O365ConnectorCardInputBaseType. Mögliche Werte sind: 'textInput', 'dateInput', 'multichoiceInput' |
| Os |
Definiert Werte für Das Betriebssystem. Mögliche Werte sind: "default", "iOS", "android", "windows" |
| ReactionType |
Definiert Werte für ReactionType. Mögliche Werte sind: "like", "heart", "laugh", "surprised", "sad", "angry" |
| Style |
Definiert Werte für Style. Mögliche Werte sind: "compact", "expanded" |
| Type |
Definiert Werte für Type. Mögliche Werte sind: 'ViewAction', 'OpenUri', 'HttpPOST', 'ActionCard' |
| Type1 | |
| Type2 | |
| Type3 | |
| UserIdentityType |
Definiert Werte für UserIdentityType. Mögliche Werte sind: 'aadUser', 'onPremiseAadUser', 'anonymousGuest', 'federatedUser' |
Enumerationen
| ActionTypes |
Definiert Werte für ActionTypes. Mögliche Werte sind: 'openUrl', 'imBack', 'postBack', 'playAudio', 'playVideo', 'showImage', 'downloadFile', 'signin', 'call', messageBack', 'openApp' |
| ActivityEventNames |
Definiert Werte für ActivityEventNames. Mögliche Werte sind: 'continueConversation', 'createConversation' |
| ActivityImportance |
Definiert Werte für ActivityImportance. Mögliche Werte sind: "niedrig", "normal", "high" |
| ActivityTypes |
Definiert Werte für ActivityTypes. Mögliche Werte sind: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff' |
| AttachmentLayoutTypes |
Definiert Werte für AttachmentLayoutTypes. Mögliche Werte sind: 'list', 'Karussell' |
| Channels |
Definiert Werte für ChannelIds für Kanäle. Mögliche Werte sind: "alexa", 'console', 'cortana', 'directline', 'directlinespeech', 'email', 'emulator', 'facebook', 'groupme', 'kik', 'line', 'msteams', 'onmichannel', 'outlook', 'skype', 'skypeforbusiness', 'slack', 'sms', 'telegram', 'test', 'twilio-sms', 'webchat' |
| ContactRelationUpdateActionTypes |
Definiert Werte für ContactRelationUpdateActionTypes. Mögliche Werte sind: "add", "remove" |
| DeliveryModes |
Definiert Werte für DeliveryModes. Mögliche Werte sind: "normal", "notification", "expectReplies", "ephemeral" |
| EndOfConversationCodes |
Definiert Werte für EndOfConversationCodes. Mögliche Werte sind: "unknown", "completedSuccessfully", "userCancelled", "botTimedOut", "botIssuedInvalidMessage", "channelFailed" |
| InputHints |
Definiert Werte für InputHints. Mögliche Werte sind: 'acceptingInput', 'ignoringInput', 'expectingInput' |
| InstallationUpdateActionTypes |
Definiert Werte für InstallationUpdateActionTypes. Mögliche Werte sind: "add", "remove" |
| MessageReactionTypes |
Definiert Werte für MessageReactionTypes. Mögliche Werte sind: "like", "plusOne" |
| RoleTypes |
Definiert Werte für RoleTypes. Mögliche Werte sind: "User", "bot", "skill" |
| SemanticActionStateTypes |
Definiert Werte für SemanticActionStateTypes. Mögliche Werte sind: "start", "continue", "done" |
| StatusCodes |
Definiert Werte für StatusCodes. Mögliche Werte sind: 200, 400, 401, 404, 405, 409, 426, 500, 501, 502 |
| TextFormatTypes |
Definiert Werte für TextFormatTypes. Mögliche Werte sind: "markdown", "plain", "xml" |
Functions
Details zur Funktion
assertActivity(unknown, unknown[])
function assertActivity(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Gibt zurück
asserts
assertAttachment(unknown, unknown[])
function assertAttachment(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Gibt zurück
asserts
assertAttachmentInfo(unknown, unknown[])
function assertAttachmentInfo(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Gibt zurück
asserts
assertAttachmentView(unknown, unknown[])
function assertAttachmentView(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Gibt zurück
asserts
assertCardAction(unknown, unknown[])
function assertCardAction(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Gibt zurück
asserts
assertChannelAccount(unknown, unknown[])
function assertChannelAccount(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Gibt zurück
asserts
assertConversationAccount(unknown, unknown[])
function assertConversationAccount(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Gibt zurück
asserts
assertConversationReference(unknown, unknown[])
function assertConversationReference(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Gibt zurück
asserts
assertEntity(unknown, unknown[])
function assertEntity(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Gibt zurück
asserts
assertMessageReaction(unknown, unknown[])
function assertMessageReaction(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Gibt zurück
asserts
assertSemanticAction(unknown, unknown[])
function assertSemanticAction(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Gibt zurück
asserts
assertSuggestedActions(unknown, unknown[])
function assertSuggestedActions(val: unknown, _args: unknown[]): assertsParameter
- val
-
unknown
- _args
-
unknown[]
Gibt zurück
asserts
isActivity(unknown)
function isActivity(val: unknown): booleanParameter
- val
-
unknown
Gibt zurück
boolean
isAttachment(unknown)
function isAttachment(val: unknown): booleanParameter
- val
-
unknown
Gibt zurück
boolean
isAttachmentInfo(unknown)
function isAttachmentInfo(val: unknown): booleanParameter
- val
-
unknown
Gibt zurück
boolean
isAttachmentView(unknown)
function isAttachmentView(val: unknown): booleanParameter
- val
-
unknown
Gibt zurück
boolean
isCardAction(unknown)
function isCardAction(val: unknown): booleanParameter
- val
-
unknown
Gibt zurück
boolean
isChannelAccount(unknown)
function isChannelAccount(val: unknown): booleanParameter
- val
-
unknown
Gibt zurück
boolean
isConversationAccount(unknown)
function isConversationAccount(val: unknown): booleanParameter
- val
-
unknown
Gibt zurück
boolean
isConversationReference(unknown)
function isConversationReference(val: unknown): booleanParameter
- val
-
unknown
Gibt zurück
boolean
isEntity(unknown)
function isEntity(val: unknown): booleanParameter
- val
-
unknown
Gibt zurück
boolean
isMessageReaction(unknown)
function isMessageReaction(val: unknown): booleanParameter
- val
-
unknown
Gibt zurück
boolean
isSemanticAction(unknown)
function isSemanticAction(val: unknown): booleanParameter
- val
-
unknown
Gibt zurück
boolean
isSuggestedActions(unknown)
function isSuggestedActions(val: unknown): booleanParameter
- val
-
unknown
Gibt zurück
boolean