botbuilder package

Klassen

BotFrameworkAdapter
BotFrameworkHttpClient
ChannelServiceHandler
ChannelServiceHandlerBase	ChannelServiceHandlerBase implementiert die API, um Aktivitäten an einen Skill weiterzuleiten, und implementiert das Routing von ChannelAPI-Aufrufen vom Skill über den Bot/Adapter.
ChannelServiceRoutes	Leitet die API-Aufrufe mit den ChannelServiceHandler-Methoden weiter.
CloudAdapter	Ein Adapter, der das Bot Framework-Protokoll implementiert und in verschiedenen cloudbasierten Umgebungen gehostet werden kann, sowohl öffentlich als auch privat.
CloudChannelServiceHandler	Eine Klasse, die bei der Implementierung des Bot Framework-Protokolls mithilfe von BotFrameworkAuthentication hilft.
EventFactory	Enthält Hilfsprogrammmethoden 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 für die Emulatorüberprüfung von Laufzeitaktivitäten und BotState.
InspectionState	InspectionState zur Verwendung durch die InspectionMiddleware für die 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 neu bewerten. Beispiel RouteConstants.Activities = '/v3/conversations/:conversationId/activities'.
SetSpeakMiddleware	Unterstützen Sie die DirectLine-Sprach- und Telefonkanäle, um sicherzustellen, dass die entsprechenden SSML-Tags für die Activity Speak-Eigenschaft festgelegt sind.
CloudSkillHandler	Ein Bot Framework-Handler für Skills.
SkillHandler
SkillHandlerImpl
SkillHttpClient	Ein Für Skills spezialisiertes BotFrameworkHttpClient, das die Generierung der Konversations-ID kapselt.
StatusCodeError	Erweitert Fehler, um spezielle Fehlermeldungen bereitzustellen.
StreamingHttpClient	Eine Implementierung von HttpClient , die Kompatibilität mit Streamingverbindungen erhöht.
TokenResolver	Sucht in Aktivitätsanlagen nach OAuthCards und ergreift entsprechende Aktionen.
TeamsSSOTokenExchangeMiddleware	Wenn der Aktivitätsname signin/tokenExchange lautet, versucht diese Middleware, das Token auszutauschen und den eingehenden Aufruf 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 weist eine identische activity.value.id auf. Nur eine dieser Tokenaustauschanforderungen sollte vom Bot verarbeitet werden. Die anderen geben StatusCodes.PRECONDITION_FAILED zurück. Für einen verteilten Bot in der Produktion erfordert dies einen verteilten Speicher, um sicherzustellen, 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 Anzahl von Nutzungseigenschaften. 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 eine Aktivität und formatiert die Zeitstempelfelder.
teamsGetChannelId(Activity)	Aktivitätshilfsmethoden 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 Aktivität ab.
teamsGetTeamInfo(Activity)	Ruft das TeamsInfo-Objekt aus der aktuellen Aktivität ab.
teamsGetTeamMeetingInfo(Activity)	Ruft das TeamsMeetingInfo-Objekt aus der aktuellen Activity ab.
teamsGetTenant(Activity)	Ruft das TenantInfo-Objekt aus der aktuellen Activity ab.
teamsNotifyUser(Partial<Activity>, boolean, string)	Konfiguriert die aktuelle Aktivität , um eine Benachrichtigung in Teams zu generieren.

Details zur Funktion

validateAndFixActivity(Activity)

Überprüft eine Aktivität und formatiert die Zeitstempelfelder.

function validateAndFixActivity(activity: Activity): Activity

Parameter

activity

Activity

(xref:botbuilder-core. Aktivität), die überprüft werden soll.

Gibt zurück

Activity

Die -Aktivität.

teamsGetChannelId(Activity)

Aktivitätshilfsmethoden für Teams.

function teamsGetChannelId(activity: Activity): string | null

Parameter

activity

Activity

Die aktuelle Aktivität.

Gibt zurück

string | null

Die Kanal-ID des aktuellen Aktivitätsteams 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 oder eine leere Zeichenfolge des Teams der aktuellen Aktivität.

teamsGetTeamId(Activity)

Ruft die Team-ID aus der aktuellen Aktivität ab.

function teamsGetTeamId(activity: Activity): string | null

Parameter

activity

Activity

Die aktuelle Aktivität.

Gibt zurück

string | null

Die ID des aktuellen Aktivitätsteams oder NULL.

teamsGetTeamInfo(Activity)

Ruft das TeamsInfo-Objekt aus der aktuellen Aktivität ab.

function teamsGetTeamInfo(activity: Activity): TeamInfo | null

Parameter

activity

Activity

Die aktuelle Aktivität.

Gibt zurück

TeamInfo | null

Die Informationen des aktuellen Aktivitätsteams oder NULL.

teamsGetTeamMeetingInfo(Activity)

Ruft das TeamsMeetingInfo-Objekt aus der aktuellen Activity ab.

function teamsGetTeamMeetingInfo(activity: Activity): TeamsMeetingInfo | null

Parameter

activity

Activity

Die aktuelle Aktivität.

Gibt zurück

TeamsMeetingInfo | null

Die Teambesprechungsinformationen der aktuellen Aktivität oder NULL.

teamsGetTenant(Activity)

Ruft das TenantInfo-Objekt aus der aktuellen Activity ab.

function teamsGetTenant(activity: Activity): TenantInfo | null

Parameter

activity

Activity

Die aktuelle Aktivität.

Gibt zurück

TenantInfo | null

Die Mandanteninformationen der aktuellen Aktivität oder NULL.

teamsNotifyUser(Partial<Activity>, boolean, string)

Konfiguriert die aktuelle Aktivität , 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

Dies wird an einen Besprechungschat gesendet und bewirkt, dass der Teams-Client ihn sowohl in einem Benachrichtigungs-Popup als auch im Chatthread rendert.

externalResourceUrl

string

Url zu einer externen Ressource. Muss in den gültigen Domänen des Manifests enthalten sein.