botbuilder-core package

Klassen

ActivityFactory	Die ActivityFactory zum Generieren von Text und verwendet dann einfache Markdownsemantik wie Chatdown zum Erstellen von Aktivität.
ActivityHandler	Ereignisausgebender Aktivitätshandler für Bots. Erweitert ActivityHandlerBase-.
ActivityHandlerBase	Definiert das Kernverhalten für ereignismittierende Aktivitätshandler für Bots.
AutoSaveStateMiddleware	Middleware, die alle Zustandsänderungen automatisch am Ende der Reihe speichert.
BotAdapter	Definiert das Kernverhalten eines Botadapters, der einen Bot mit einem Dienstendpunkt verbinden kann.
BotComponent	Definition eines BotComponents, das die Registrierung von Diensten, benutzerdefinierten Aktionen, Speicherbereichen und Adaptern ermöglicht. Um Ihre Komponenten dem System zur Verfügung zu stellen, leiten Sie von BotComponent ab und registrieren Dienste, um Funktionen hinzuzufügen. Diese Komponenten werden dann an geeigneten Stellen von den Systemen genutzt, die sie benötigen. Bei Verwendung von Composer wird configureServices automatisch von der Bot-Laufzeit für die Komponenten aufgerufen, solange die Komponenten in der Konfiguration registriert sind.
BotState	Basisklasse für die Frameworks-Status-Persistancebereiche.
BotStatePropertyAccessor	Eine BotState spezifische Implementierung der StatePropertyAccessor-Schnittstelle.
BotStateSet	Eine Sammlung von BotState Plugins, die parallel als einzelne Einheit geladen oder gespeichert werden sollen. Eine Implementierung dieser Klasse finden Sie unter AutoSaveStateMiddleware.
NullTelemetryClient	Ein Null-Bot-Telemetrieclient, der BotTelemetryClientimplementiert.
BrowserLocalStorage	Speicheranbieter, der den lokalen Browserspeicher verwendet.
BrowserSessionStorage	Speicheranbieter, der Browsersitzungsspeicher verwendet.
CardFactory	Stellt Methoden zum Formatieren der verschiedenen Kartentypen bereit, die ein Bot zurückgeben kann.
CloudAdapterBase	Ein Adapter, der das Bot Framework-Protokoll implementiert und in verschiedenen Cloudumgebungen sowohl öffentlich als auch privat gehostet werden kann.
ComponentRegistration	ComponentRegistration ist eine Signaturklasse zum Ermitteln von Ressourcen aus Komponenten.
ConfigurationBotFrameworkAuthentication	Erstellt eine BotFrameworkAuthentication Instanz aus einem Objekt mit den Authentifizierungswerten oder einer Configuration Instanz.
ConfigurationServiceClientCredentialFactory	ServiceClientCredentialsFactory, das eine ConfigurationServiceClientCredentialFactoryOptions- oder eine Configuration Instanz verwendet, um ServiceClientCredentials mit einer AppId und einem App-Kennwort zu erstellen.
ConversationState	Liest und schreibt den Unterhaltungszustand für Ihren Bot in den Speicher.
InvokeException	Eine benutzerdefinierte Ausnahme zum Aufrufen von Antwortfehlern.
MemoryStorage	Speicheranbieter auf Speicherbasis für einen Bot.
MemoryTranscriptStore	Der Speicher für die Speicheraufzeichnung speichert Transkripte im veränderliche Speicher in einer Karte.
MessageFactory	Eine Reihe von Hilfsfunktionen zur Unterstützung der Formatierung der verschiedenen Nachrichtentypen, die ein Bot zurückgeben kann.
MiddlewareSet	Eine Reihe von Middleware Plug-Ins.
PrivateConversationState	Liest und schreibt den Status "PrivateConversation" für Ihren Bot in den Speicher.
QueueStorage	Eine Basisklasse zum Enqueueing einer Aktivität für die spätere Verarbeitung.
RegisterClassMiddleware	Middleware zum Hinzufügen oder Registrieren eines Diensts mit dem aktuellen Turnkontext.
ShowTypingMiddleware	Middleware, die automatisch eine Eingabeanzeige für jede Nachricht sendet.
SkillConversationIdFactory	Eine SkillConversationIdFactory, die ConversationReference Instanzen speichert und abruft.
SkillConversationIdFactoryBase	Definiert die Methoden einer Fabrik, die zum Erstellen eindeutiger Unterhaltungs-IDs für Fähigkeitsunterhaltungen verwendet wird.
SkypeMentionNormalizeMiddleware	Middleware zum Patchen von Entitäten von Skype, da sie nicht den erwarteten Werten entsprechen. Bots, die mit Skype interagieren, sollten diese Middleware verwenden, wenn Erwähnungen verwendet werden.
StringUtils	Hilfsklasse mit Hilfsprogrammmethoden.
TelemetryConstants	Definiert Namen allgemeiner Eigenschaften für die Verwendung mit einem BotTelemetryClient--Objekt.
TelemetryLoggerMiddleware	Middleware zum Protokollieren eingehender, ausgehender, aktualisierter oder gelöschter Aktivitätsnachrichten. Verwendet die botTelemetryClient-Schnittstelle.
TestAdapter	Testadapter, der für Komponententests verwendet wird. Dieser Adapter kann verwendet werden, um das Senden von Nachrichten vom Benutzer an den Bot zu simulieren.
TestFlow	Unterstützungsklasse für TestAdapter, die die einfache Konstruktion einer Abfolge von Tests ermöglicht.
ConsoleTranscriptLogger	ConsoleTranscriptLogger schreibt Aktivitäten in die Konsolenausgabe.
TranscriptLoggerMiddleware	Protokolliert eingehende und ausgehende Aktivitäten in einem TranscriptStore.
TurnContext	Stellt Kontext für eine Drehung eines Bots bereit.
TurnContextStateCollection	Werte, die für die Lebensdauer der Drehung als Teil der TurnContext-beibehalten werden.
UserState	Liest und schreibt den Benutzerstatus ihres Bots in den Speicher.

Schnittstellen

CachedBotState	Statusinformationen zwischengespeichert vom Kontextobjekt durch eine BotState Instanz.
StatePropertyAccessor	Definiert Methoden für den Zugriff auf eine Zustandseigenschaft, die in einem BotState -Objekt erstellt wurde.
BotPageViewTelemetryClient
BotTelemetryClient
TelemetryDependency
TelemetryEvent
TelemetryException
TelemetryPageView
TelemetryTrace
CoreAppCredentials	CoreAppCredentials
CoreWebResource	Interne Schnittstelle, die die "WebResource" aus @azure/ms-rest-js darstellt
ExtendedUserTokenProvider	Schnittstelle für benutzertoken OAuth Single Sign On and Token Exchange APIs for BotAdapters
IntentScore	Score plus alle zusätzlichen Informationen zu einer Absicht.
Middleware	Schnittstelle, die von objektbasierter Middleware implementiert wird.
PropertyManager	Schnittstelle, die von Klassen implementiert wird, die fähig sind, Eigenschaftsaccessoren zu factoringen.
RecognizerResult	Von einer Erkennung zurückgegebener Wert.
BotFrameworkSkill	Registrierung für einen BotFrameworkHttpProtocol-basierten Skill-Endpunkt.
SkillConversationIdFactoryOptions
SkillConversationReference
Storage	Schnittstelle für einen Speicheranbieter, der einfache alte JSON-Objekte speichert und abruft.
StoreItem	Objekt, das im Speicher mit einem optionalen eTag gespeichert ist.
StoreItems	Zuordnung benannter StoreItem-Objekte.
PagedResult	Ergebnisseite.
TranscriptInfo	Metadaten für ein gespeichertes Transkript.
TranscriptLogger	Transkriptprotokollierung speichert Aktivitäten für Unterhaltungen zum Rückruf.
TranscriptStore	Transkriptprotokollierung speichert Aktivitäten für Unterhaltungen zum Rückruf.
IUserTokenProvider	Schnittstelle für OAuth-APIs für Benutzertoken für BotAdapters
TokenPollingSettings	Enthält Details für die Tokenabfragung.

Typaliase

BotHandler	Beschreibt einen Bot-Aktivitätsereignishandler zur Verwendung mit einem ActivityHandler-Objekt.
ConfigurationBotFrameworkAuthenticationOptions	Enthält Einstellungen zum Konfigurieren einer ConfigurationBotFrameworkAuthentication Instanz.
ConfigurationServiceClientCredentialFactoryOptions	Enthält Einstellungen zum Konfigurieren einer ConfigurationServiceClientCredentialFactory Instanz.
MiddlewareHandler	Signatur, die von funktionsbasierter Middleware implementiert wird. type MiddlewareHandler = (context: TurnContext, next: () => Promise<void>) => Promise<void>;
StorageKeyFactory	Rückruf zum Berechnen eines Speicherschlüssels. type StorageKeyFactory = (context: TurnContext) => Promise<string>;
TestActivityInspector	Signatur für eine Funktion, die verwendet werden kann, um einzelne Aktivitäten zu untersuchen, die von einem Bot zurückgegeben werden, der mithilfe der TestAdaptergetestet wird. type TestActivityInspector = (activity: Partial<Activity>, description: string) => void;
DeleteActivityHandler	Ein Handler, der an Löschaktivitätsereignissen für die aktuelle Drehung teilnehmen kann.
SendActivitiesHandler	Ein Handler, der an Sendeaktivitätsereignissen für die aktuelle Drehung teilnehmen kann.
UpdateActivityHandler	Ein Handler, der an Aktualisierungsaktivitätsereignissen für den aktuellen Turn teilnehmen kann.

Enumerationen

Severity

Definiert den Schweregrad für das Ereignis.

Functions

useBotState(BotAdapter, BotState[])	Fügt dem Adapter Middleware hinzu, um ein oder mehrere BotState-Objekte im Turnkontext zu registrieren. Die Middleware registriert die Zustandsobjekte im Turnkontext am Anfang jeder Drehung.
assertBotComponent(unknown, unknown[])
telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)	Protokolliert eine DialogView mithilfe der trackPageView--Methode für den BotTelemetryClient-, wenn BotPageViewTelemetryClient- implementiert wurde. Alternativ werden die Informationen über TrackTrace protokolliert.
createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)	Erstellt eine neue Instanz der ConfigurationBotFrameworkAuthentication Klasse.
createServiceClientCredentialFactoryFromConfiguration(Configuration)	Erstellt eine neue Instanz der ConfigurationServiceClientCredentialFactory Klasse.
assertStoreItems(unknown, unknown[])
calculateChangeHash(StoreItem)	Hilfsfunktion zum Berechnen eines Änderungshashs für eine StoreItem.

Details zur Funktion

useBotState(BotAdapter, BotState[])

Fügt dem Adapter Middleware hinzu, um ein oder mehrere BotState-Objekte im Turnkontext zu registrieren. Die Middleware registriert die Zustandsobjekte im Turnkontext am Anfang jeder Drehung.

function useBotState(botAdapter: BotAdapter, botStates: BotState[]): BotAdapter

Parameter

botAdapter

BotAdapter

Der Adapter, auf dem die Zustandsobjekte registriert werden sollen.

botStates

BotState[]

Die zu registrierenden Statusobjekte.

Gibt zurück

BotAdapter

Der aktualisierte Adapter.

assertBotComponent(unknown, unknown[])

Warnung

Diese API ist nun veraltet.

Use BotComponent.z.parse() instead.

function assertBotComponent(val: unknown, _args: unknown[]): asserts

Parameter

val

unknown

_args

unknown[]

Gibt zurück

asserts

telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)

Protokolliert eine DialogView mithilfe der trackPageView--Methode für den BotTelemetryClient-, wenn BotPageViewTelemetryClient- implementiert wurde. Alternativ werden die Informationen über TrackTrace protokolliert.

function telemetryTrackDialogView(telemetryClient: BotTelemetryClient, dialogName: string, properties?: [key: string]: any, metrics?: [key: string]: number)

Parameter

telemetryClient

BotTelemetryClient

TelemetryClient, der BotTelemetryClientimplementiert.

dialogName

string

Name des Dialogfelds zum Protokollieren des Eintrags /Start für.

properties

[key: string]: any

Benannte Zeichenfolgenwerte, die Sie zum Suchen und Klassifizieren von Ereignissen verwenden können.

metrics

[key: string]: number

Messungen, die diesem Ereignis zugeordnet sind.

createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

Erstellt eine neue Instanz der ConfigurationBotFrameworkAuthentication Klasse.

function createBotFrameworkAuthenticationFromConfiguration(configuration: Configuration, credentialsFactory?: ServiceClientCredentialsFactory, authConfiguration?: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions): BotFrameworkAuthentication

Parameter

configuration

Configuration

Eine Configuration Instanz.

credentialsFactory

ServiceClientCredentialsFactory

Eine ServiceClientCredentialsFactory Instanz.

authConfiguration

AuthenticationConfiguration

Ein Configuration-Objekt.

botFrameworkClientFetch

(input: RequestInfo, init?: RequestInit) => Promise<Response>

Eine benutzerdefinierte Fetch-Implementierung, die im BotFrameworkClient-verwendet werden soll.

connectorClientOptions

ConnectorClientOptions

Ein ConnectorClientOptions--Objekt.

Gibt zurück

BotFrameworkAuthentication

Eine ConfigurationBotFrameworkAuthentication Instanz.

Hinweise

Die Configuration-Instanz, die dem Konstruktor bereitgestellt wird, sollte über die gewünschten Authentifizierungswerte im Stammverzeichnis verfügen, wobei die Eigenschaften von ConfigurationBotFrameworkAuthenticationOptions als Schlüssel verwendet werden.

createServiceClientCredentialFactoryFromConfiguration(Configuration)

Erstellt eine neue Instanz der ConfigurationServiceClientCredentialFactory Klasse.

function createServiceClientCredentialFactoryFromConfiguration(configuration: Configuration): ConfigurationServiceClientCredentialFactory

Parameter

configuration

Configuration

Eine Configuration Instanz.

Gibt zurück

ConfigurationServiceClientCredentialFactory

Eine ConfigurationServiceClientCredentialFactory-Instanz.

Hinweise

Die Configuration-Instanz, die dem Konstruktor bereitgestellt wird, sollte über die gewünschten Authentifizierungswerte im Stammverzeichnis verfügen, wobei die Eigenschaften von ConfigurationServiceClientCredentialFactoryOptions als Schlüssel verwendet werden.

assertStoreItems(unknown, unknown[])

Warnung

Diese API ist nun veraltet.

Use zod.record(zod.unknown()) instead.

function assertStoreItems(val: unknown, _args: unknown[]): asserts

Parameter

val

unknown

_args

unknown[]

Gibt zurück

asserts

calculateChangeHash(StoreItem)

Hilfsfunktion zum Berechnen eines Änderungshashs für eine StoreItem.

function calculateChangeHash(item: StoreItem): string

Parameter

item

StoreItem

Element zum Berechnen des Änderungshashs für.

Gibt zurück

string

Hashzeichenfolge ändern

Hinweise

In diesem Beispiel wird ein Änderungshash für ein Objekt berechnet, das gelesen wurde, und schreibt ihn dann nur wieder heraus, wenn es geändert wurde:

// Calculate state objects initial hash
const hash = calculateChangeHash(state);

// Process the received activity
await processActivity(context, state);

// Save state if changed
if (calculateChangeHash(state) !== hash) {
   await storage.write({ 'botState': state });
}