botbuilder package

Klassen

BotFrameworkAdapter
BotFrameworkHttpClient
ChannelServiceHandler
ChannelServiceHandlerBase	Die ChannelServiceHandlerBase implementiert DIE API, um Aktivitäten an eine Fähigkeit weiterzuleiten und das Routing von ChannelAPI-Aufrufen von Skill über den Bot/Adapter zu implementieren.
ChannelServiceRoutes	Leitet die API-Aufrufe mit den ChannelServiceHandler-Methoden weiter.
CloudAdapter	Ein Adapter, der das Bot Framework-Protokoll implementiert und in verschiedenen Cloudumgebungs-Umgebungen sowohl öffentlich als auch privat gehostet werden kann.
CloudChannelServiceHandler	Eine Klasse zur Unterstützung bei der Implementierung des Bot Framework-Protokolls mithilfe BotFrameworkAuthentication.
EventFactory	Enthält Hilfsmethoden zum Erstellen verschiedener Ereignistypen.
FileTranscriptStore	Der Dateitranskriptspeicher speichert Transkripte im Dateisystem mit jeder Aktivität als Datei.
HandoffEventNames	Definiert Werte für Übergabeereignisnamen.
InspectionMiddleware	InspectionMiddleware zur Emulatorüberprüfung von Laufzeitaktivitäten und BotState.
InspectionState	InspectionState für die Verwendung durch die InspectionMiddleware zur Emulatorüberprüfung von Laufzeitaktivitäten und BotState.
RouteConstants	Konstanten, die den API-Pfad darstellen, der unmittelbar auf den BasePath folgt. Diese sind derzeit intern, aber wir werden sie in Zukunft erneut öffentlich machen. Beispiel RouteConstants.Activities = '/v3/conversations/:conversationId/activities'.
SetSpeakMiddleware	Unterstützen Sie die DirectLine-Sprach- und Telefoniekanäle, um sicherzustellen, dass die entsprechenden SSML-Tags für die Activity Speak-Eigenschaft festgelegt sind.
CloudSkillHandler	Ein Bot Framework-Handler für Fähigkeiten.
SkillHandler
SkillHandlerImpl
SkillHttpClient	Ein BotFrameworkHttpClient spezialisiert auf Fähigkeiten, die die Generation der Unterhaltungs-ID kapseln.
StatusCodeError	Erweitert den Fehler, um spezielle Fehlermeldungen bereitzustellen.
StreamingHttpClient	Eine Implementierung von HttpClient, die Kompatibilität mit Streamingverbindungen hinzufügt.
TokenResolver	Sucht in Aktivitätsanlagen nach OAuthCards und führt entsprechende Aktionen aus.
TeamsSSOTokenExchangeMiddleware	Wenn der Aktivitätsname signin/tokenExchange ist, versucht diese Middleware, das Token auszutauschen und den eingehenden Anruf zu deduplizieren, um sicherzustellen, dass nur eine Exchange-Anforderung verarbeitet wird. Wenn ein Benutzer bei mehreren Teams-Clients angemeldet ist, kann der Bot von jedem Client ein "signin/tokenExchange" empfangen. Jede Tokenaustauschanforderung für eine bestimmte Benutzeranmeldung hat eine identische activity.value.id. Nur eine dieser Tokenaustauschanforderungen sollte vom Bot verarbeitet werden. Die anderen geben StatusCodes.PRECONDITION_FAILEDzurück. Für einen verteilten Bot in der Produktion erfordert dies einen verteilten Speicher, der sicherstellt, dass nur ein Tokenaustausch verarbeitet wird. Diese Middleware unterstützt CosmosDb-Speicher in Botbuilder-azure oder MemoryStorage für die lokale Entwicklung.
TeamsActivityHandler	Fügt Unterstützung für microsoft Teams-spezifische Ereignisse und Interaktionen hinzu.
TeamsInfo	Stellt Hilfsmethoden für die Ereignisse und Interaktionen bereit, die in Microsoft Teams auftreten.

Schnittstellen

BotFrameworkAdapterSettings
BotFrameworkHttpAdapter
WebServer	Schnittstelle, die eine Express-Anwendung oder einen Restify-Server darstellt.
ConnectorClientBuilder	Abstraktion zum Erstellen von Connectorclients.
Request	Stellt eine Node.js HTTP-Anforderung dar, einschließlich der minimalen Verwendungseigenschaften. Kompatibel mit Restify, Express und Node.js Kern-HTTP.
Response
WebRequest	Stellt ein Express- oder Restify-Anforderungsobjekt dar. Diese Schnittstelle unterstützt das Framework und soll nicht direkt für Ihren Code aufgerufen werden.
WebResponse	Stellt ein Express- oder Restify-Antwortobjekt dar. Diese Schnittstelle unterstützt das Framework und soll nicht direkt für Ihren Code aufgerufen werden.

Typaliase

RouteHandler

Functions

validateAndFixActivity(Activity)	Überprüft ein Activity und formatiert die Zeitstempelfelder.
teamsGetChannelId(Activity)	Methoden zur Aktivitätshilfsmethode für Teams.
teamsGetSelectedChannelId(Activity)	Ruft die ausgewählte Kanal-ID des Teams aus der aktuellen Aktivität ab.
teamsGetTeamId(Activity)	Ruft die Team-ID aus der aktuellen Activityab.
teamsGetTeamInfo(Activity)	Ruft das TeamsInfo -Objekt aus dem aktuellen Activityab.
teamsGetTeamMeetingInfo(Activity)	Ruft das TeamsMeetingInfo -Objekt aus dem aktuellen Activityab.
teamsGetTenant(Activity)	Ruft das TenantInfo -Objekt aus dem aktuellen Activityab.
teamsNotifyUser(Partial<Activity>, boolean, string)	Konfiguriert die aktuelle Aktivitäts-, um eine Benachrichtigung in Teams zu generieren.

Details zur Funktion

validateAndFixActivity(Activity)

Überprüft ein Activity und formatiert die Zeitstempelfelder.

function validateAndFixActivity(activity: Activity): Activity

Parameter

activity

Activity

(xref:botbuilder-core. Aktivität) zu überprüfen.

Gibt zurück

Activity

Die Aktivität.

teamsGetChannelId(Activity)

Methoden zur Aktivitätshilfsmethode für Teams.

function teamsGetChannelId(activity: Activity): string | null

Parameter

activity

Activity

Die aktuelle Aktivität.

Gibt zurück

string | null

Die aktuelle AktivitätKanal-ID des Teams oder NULL.

teamsGetSelectedChannelId(Activity)

Ruft die ausgewählte Kanal-ID des Teams aus der aktuellen Aktivität ab.

function teamsGetSelectedChannelId(activity: Activity): string

Parameter

activity

Activity

Die aktuelle Aktivität.

Gibt zurück

string

Der ausgewählte Kanal der aktuellen Aktivität oder leere Zeichenfolge des Teams.

teamsGetTeamId(Activity)

Ruft die Team-ID aus der aktuellen Activityab.

function teamsGetTeamId(activity: Activity): string | null

Parameter

activity

Activity

Die aktuelle Aktivität.

Gibt zurück

string | null

Die aktuelle Aktivität"Team-ID" oder "NULL".

teamsGetTeamInfo(Activity)

Ruft das TeamsInfo -Objekt aus dem aktuellen Activityab.

function teamsGetTeamInfo(activity: Activity): TeamInfo | null

Parameter

activity

Activity

Die aktuelle Aktivität.

Gibt zurück

TeamInfo | null

Die aktuelle Aktivität'Teaminformationen' oder NULL.

teamsGetTeamMeetingInfo(Activity)

Ruft das TeamsMeetingInfo -Objekt aus dem aktuellen Activityab.

function teamsGetTeamMeetingInfo(activity: Activity): TeamsMeetingInfo | null

Parameter

activity

Activity

Die aktuelle Aktivität.

Gibt zurück

TeamsMeetingInfo | null

Die aktuelle AktivitätTeambesprechungsinformationen oder NULL.

teamsGetTenant(Activity)

Ruft das TenantInfo -Objekt aus dem aktuellen Activityab.

function teamsGetTenant(activity: Activity): TenantInfo | null

Parameter

activity

Activity

Die aktuelle Aktivität.

Gibt zurück

TenantInfo | null

Die aktuelle AktivitätMandanteninformationen oder NULL.

teamsNotifyUser(Partial<Activity>, boolean, string)

Konfiguriert die aktuelle Aktivitäts-, um eine Benachrichtigung in Teams zu generieren.

function teamsNotifyUser(activity: Partial<Activity>, alertInMeeting?: boolean, externalResourceUrl?: string)

Parameter

activity

Partial<Activity>

Die aktuelle Aktivität.

alertInMeeting

boolean

An einen Besprechungschat gesendet, bewirkt dies, dass der Teams-Client sie in einem Benachrichtigungspopup sowie im Chatthread rendert.

externalResourceUrl

string

URL zu externer Ressource. Muss in den gültigen Domänen des Manifests enthalten sein.