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 Namen der Befehlsaktivität definiert wird. 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 Namen der Befehlsaktivität definiert wird. |
| IActivity | |
| ICommandActivity |
Asynchroner externer Befehl. |
| ICommandResultActivity |
Ergebnis des asynchronen externen Befehls. |
| 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. Aufgrund der Utc-Eigenschaft von Javascript Date-Objekten gehen Die Zeitzonenoffsetwerte verloren. |
| AdaptiveCardAuthentication |
Definiert die Struktur, die in der Aktivität Activity.Value.Authentication für Invoke mit dem Namen "adaptiveCard/action" eingeht. |
| AdaptiveCardInvokeAction |
Definiert die Struktur, die in der Aktivität Activity.Value.Action für Invoke mit dem Namen "adaptiveCard/action" eingeht. |
| AdaptiveCardInvokeResponse |
Definiert die Struktur, die als Ergebnis einer Invoke-Aktivität mit dem Namen "adaptiveCard/action" zurückgegeben wird. |
| AdaptiveCardInvokeValue |
Definiert die Struktur, die in der Aktivität Activity.Value für Invoke 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 ihre 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 von 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 |
Satz von Schlüssel-Wert-Paaren. Der Vorteil dieses Abschnitts besteht darin, dass Schlüssel- und Werteigenschaften mit Standardformatinformationen mit einem Trennzeichen zwischen ihnen gerendert werden. Daher ist es für entwickler nicht erforderlich, Stilinformationen anzugeben. |
| GeoCoordinates |
GeoCoordinates (Entitätstyp: "https://schema.org/GeoCoordinates") |
| HeroCard |
Eine Hero-Karte (Karte mit einem einzelnen, großen Bild) |
| IStatusCodeError | |
| InnerHttpError |
Objekt, das einen inneren HTTP-Fehler darstellt |
| InvokeResponse |
Stellt eine Antwort dar, die von einem Bot zurückgegeben wird, wenn er 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 mit Mitgliedern. |
| PaymentAddress |
Adresse innerhalb einer Zahlungsanforderung |
| PaymentCurrencyAmount |
Lieferung von Geldbeträgen |
| PaymentDetails |
Stellt Informationen zur angeforderten Transaktion bereit. |
| PaymentDetailsModifier |
Stellt Details bereit, die paymentDetails basierend auf der Zahlungsmethoden-ID ändern. |
| PaymentItem |
Gibt an, wofür die Zahlungsanforderung gilt und nach welchem Wert gefragt wird. |
| PaymentMethodData |
Gibt eine Reihe von unterstützten Zahlungsmethoden und alle zugehörigen zahlungsmethodenspezifischen Daten für diese Methoden an. |
| PaymentOptions |
Stellt Informationen zu den gewünschten Optionen für die Zahlungsanforderung bereit. |
| PaymentRequest |
Eine Zahlungsanforderung |
| PaymentRequestComplete |
Beim Ausfüllen einer Zahlungsanforderung übermittelte Nutzlast |
| PaymentRequestCompleteResult |
Ergebnis einer abgeschlossenen Zahlungsanforderung |
| PaymentRequestUpdate |
Eine Aktualisierung einer Zahlungsanforderung |
| PaymentRequestUpdateResult |
Ein Ergebnisobjekt aus einem Aufrufvorgang für eine Zahlungsanforderungsaktualisierung |
| PaymentResponse |
Ein 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 mit einer Ressourcen-ID |
| SearchInvokeOptions |
Stellt Informationen zu den gewünschten Optionen für ein SearchInvokeValue bereit. |
| SearchInvokeResponse |
Definiert die Struktur, die als Ergebnis einer Invoke-Aktivität mit dem Namen "application/search" zurückgegeben wird. |
| SearchInvokeValue |
Definiert die Struktur, die in der Aktivität Activity.Value für Invoke mit dem Namen "application/search" eingeht. |
| SemanticAction |
Stellt einen Verweis auf eine programmgesteuerte Aktion dar. |
| SignInUrlResponse | |
| SigninCard |
Eine Karte, die eine Anmeldeanforderung darstellt |
| SuggestedActions |
SuggestedActions, die ausgeführt werden können |
| TextHighlight |
Bezieht sich auf eine Teilzeichenfolge des Inhalts innerhalb eines anderen Felds. |
| Thing |
Thing (Entitätstyp: "https://schema.org/Thing") |
| ThumbnailCard |
Eine Miniaturansichtskarte (Karte mit einem einzelnen, kleinen Miniaturbild) |
| ThumbnailUrl |
URL der Miniaturansicht |
| TokenExchangeRequest | |
| TokenExchangeResource | |
| TokenRequest |
Eine Anforderung zum Empfangen eines Benutzertokens |
| TokenResponse |
Eine Antwort, die ein Benutzertoken enthält |
| Transcript |
Textaufzeichnung |
| 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 Tokenaustauschaufrufs. |
Typaliase
| IHandoffActivity | |
| IMessageDeleteActivity | |
| ITypingActivity | |
| TokenExchangeState |
State-Objekt, das an den Bottokendienst übergeben wird. |
| TokenStatus |
Der Status eines bestimmten Tokens. |
| FileDownloadInfoAttachment | |
| O365ConnectorCardActionType |
Definiert Werte für Type. Mögliche Werte: "ViewAction", "OpenUri", "HttpPOST", "ActionCard" |
| O365ConnectorCardInputType |
Definiert Werte für O365ConnectorCardInputType. Mögliche Werte: "textInput", "dateInput", "multichoiceInput" |
| Action |
Definiert Werte für Action. Mögliche Werte: "accept", "decline" |
| ActivityImageType |
Definiert Werte für ActivityImageType. Mögliche Werte: "avatar", "article" |
| ApplicationIdentityType |
Definiert Werte für ApplicationIdentityType. Mögliche Werte: "aadApplication", "bot", "tenantBot", "office365Connector", "webhook" |
| AttachmentLayout |
Definiert Werte für AttachmentLayout. Mögliche Werte: "list", "grid" |
| BotMessagePreviewActionType |
Definiert Werte für BotMessagePreviewActionType. Mögliche Werte: "bearbeiten", "senden" |
| BotMessagePreviewType |
Definiert Werte für BotMessagePreviewType. Mögliche Werte: "message", "continue" |
| CommandContext |
Definiert Werte für CommandContext. Mögliche Werte: "message", "compose", "commandbox" |
| ContentType |
Definiert Werte für ContentType. Mögliche Werte: "html", "text" |
| ConversationIdentityType |
Definiert Werte für ConversationIdentityType. Mögliche Werte: "team", "channel" |
| Importance |
Definiert Werte für Wichtigkeit. Mögliche Werte: "normal", "high", "urgent" |
| MessageType |
Definiert Werte für MessageType. Mögliche Werte: "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: "textInput", "dateInput", "multichoiceInput" |
| Os |
Definiert Werte für Os. Mögliche Werte: "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: "compact", "expanded" |
| Type |
Definiert Werte für Type. Mögliche Werte: "ViewAction", "OpenUri", "HttpPOST", "ActionCard" |
| Type1 | |
| Type2 | |
| Type3 | |
| UserIdentityType |
Definiert Werte für UserIdentityType. Mögliche Werte: "aadUser", "onPremiseAadUser", "anonymousGuest", "federatedUser" |
Enumerationen
| ActionTypes |
Definiert Werte für ActionTypes. Mögliche Werte: "openUrl", "imBack", "postBack", "playAudio", "playVideo", "showImage", "downloadFile", "signin", "call", messageBack", "openApp" |
| ActivityEventNames |
Definiert Werte für ActivityEventNames. Mögliche Werte: "continueConversation", "createConversation" |
| ActivityImportance |
Definiert Werte für ActivityImportance. Mögliche Werte: "low", "normal", "high" |
| ActivityTypes |
Definiert Werte für ActivityTypes. Mögliche Werte: "message", "contactRelationUpdate", "conversationUpdate", "typing", "endOfConversation", "event", "invoke", "deleteUserData", "messageUpdate", "messageDelete", "installationUpdate", "messageReaction", "suggestion", "trace", "handoff" |
| AttachmentLayoutTypes |
Definiert Werte für AttachmentLayoutTypes. Mögliche Werte: "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: "add", "remove" |
| DeliveryModes |
Definiert Werte für DeliveryModes. Mögliche Werte: "normal", "notification", "expectReplies", "ephemeral" |
| EndOfConversationCodes |
Definiert Werte für EndOfConversationCodes. Mögliche Werte: "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: "add", "remove" |
| MessageReactionTypes |
Definiert Werte für MessageReactionTypes. Mögliche Werte: "like", "plusOne" |
| RoleTypes |
Definiert Werte für RoleTypes. Mögliche Werte: "user", "bot", "skill" |
| SemanticActionStateTypes |
Definiert Werte für SemanticActionStateTypes. Mögliche Werte: "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: "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