botbuilder-core package

Klassen

ActivityFactory	Die ActivityFactory zum Generieren von Text und verwendet dann einfache Markdownsemantik wie Chatdown, um Aktivität zu erstellen.
ActivityHandler	Ereignisausgebender Aktivitätshandler für Bots. Erweitert ActivityHandlerBase.
ActivityHandlerBase	Definiert das Kernverhalten für Ereignis emittierende Aktivitätshandler für Bots.
AutoSaveStateMiddleware	Middleware, die alle Zustandsänderungen am Ende des Turnvorgangs automatisch speichert.
BotAdapter	Definiert das Kernverhalten eines Botadapters, der einen Bot mit einem Dienstendpunkt verbinden kann.
BotComponent	Definition einer BotComponent-Instanz, die die Registrierung von Diensten, benutzerdefinierten Aktionen, Speicherbereichen und Adaptern ermöglicht. Um Ihre Komponenten für das System verfügbar zu machen, das Sie von BotComponent ableiten, und registrieren Sie 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 für die Komponenten von der Botruntime aufgerufen, solange die Komponenten in der Konfiguration registriert sind.
BotState	Basisklasse für die Frameworks-Zustandsharrlichkeitsbereiche.
BotStatePropertyAccessor	Eine BotState bestimmte Implementierung der StatePropertyAccessor -Schnittstelle.
BotStateSet	Eine Sammlung von Plug-Ins BotState , die parallel als einzelne Einheit geladen oder gespeichert werden sollen. Eine Implementierung dieser Klasse finden Sie AutoSaveStateMiddleware unter .
NullTelemetryClient	Ein NULL-Bottelemetrieclient, der BotTelemetryClient implementiert.
BrowserLocalStorage	Speicheranbieter, der den lokalen Speicher des Browsers verwendet.
BrowserSessionStorage	Speicheranbieter, der browserbasierten Sitzungsspeicher 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 öffentlichen und privaten Cloudumgebungen 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 einen ConfigurationServiceClientCredentialFactoryOptions oder eine Konfigurationsinstanz verwendet, um ServiceClientCredentials mit einer AppId und einem App-Kennwort zu erstellen.
ConversationState	Liest und schreibt den Konversationszustand für Ihren Bot in den Speicher.
InvokeException	Eine benutzerdefinierte Ausnahme für Aufrufantwortfehler.
MemoryStorage	Speicherbasierter Speicheranbieter für einen Bot.
MemoryTranscriptStore	Der Speicher für Speichertranskripte speichert Transkripte im flüchtigen Speicher in einer Zuordnung.
MessageFactory	Eine Reihe von Hilfsfunktionen, die bei der Formatierung der verschiedenen Nachrichtentypen helfen, die ein Bot zurückgeben kann.
MiddlewareSet	Ein Satz von Plug-Ins Middleware .
PrivateConversationState	Liest und schreibt den PrivateConversation-Zustand für Ihren Bot in den Speicher.
QueueStorage	Eine Basisklasse zum Warteschlangen einer Activity zur späteren Verarbeitung.
RegisterClassMiddleware	Middleware zum Hinzufügen eines Objekts zu oder zum Registrieren eines Diensts mit dem aktuellen Turnkontext.
ShowTypingMiddleware	Middleware, die automatisch einen Eingabeindikator für jede Nachricht sendet.
SkillConversationIdFactory	Eine SkillConversationIdFactory, die ConversationReference-Instanzen speichert und abruft.
SkillConversationIdFactoryBase	Definiert die Methoden einer Factory, die zum Erstellen eindeutiger Konversations-IDs für Skillunterhaltungen verwendet wird.
SkypeMentionNormalizeMiddleware	Middleware zum Patchen erwähnt Entitäten aus Skype, da sie nicht den erwarteten Werten entsprechen. Bots, die mit Skype interagieren, sollten diese Middleware verwenden, wenn Erwähnungen verwendet werden.
StringUtils	Hilfsklasse, die Zeichenfolgen-Hilfsprogrammmethoden enthält.
TelemetryConstants	Definiert Namen allgemeiner Eigenschaften für die Verwendung mit einem BotTelemetryClient-Objekt .
TelemetryLoggerMiddleware	Middleware zum Protokollieren eingehender, ausgehender, aktualisierter oder gelöschter Aktivitätsmeldungen. 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 das einfache Erstellen einer Sequenz 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 Umdrehung eines Bots bereit.
TurnContextStateCollection	Werte, die für die Lebensdauer des Turns als Teil von TurnContext beibehalten werden.
UserState	Liest und schreibt den Benutzerzustand für Ihren Bot in den Speicher.

Schnittstellen

CachedBotState	Zustandsinformationen, die von einer BotState -Instanz aus dem Kontextobjekt zwischengespeichert werden.
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" von darstellt @azure/ms-rest-js
ExtendedUserTokenProvider	Schnittstelle für Benutzertoken OAuth Single Sign On und Token Exchange APIs für 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 Eigenschaftsaccessoren faktorieren können.
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 in Storage mit einem optionalen eTag gespeichert wird.
StoreItems	Zuordnung benannter StoreItem Objekte.
PagedResult	Seite der Ergebnisse.
TranscriptInfo	Metadaten für ein gespeichertes Transkript.
TranscriptLogger	Die Transkriptprotokollierung speichert Aktivitäten für Unterhaltungen für den Rückruf.
TranscriptStore	Die Transkriptprotokollierung speichert Aktivitäten für Unterhaltungen für den Rückruf.
IUserTokenProvider	Schnittstelle für Benutzertoken-OAuth-APIs für BotAdapters
TokenPollingSettings	Stellt Details zum Tokenabruf bereit.

Typaliase

BotHandler	Beschreibt einen Botaktivitätsereignishandler zur Verwendung mit einem ActivityHandler-Objekt .
ConfigurationBotFrameworkAuthenticationOptions	Enthält Einstellungen, die zum Konfigurieren einer ConfigurationBotFrameworkAuthentication-Instanz verwendet werden.
ConfigurationServiceClientCredentialFactoryOptions	Enthält Einstellungen, die zum Konfigurieren einer ConfigurationServiceClientCredentialFactory-Instanz verwendet werden.
MiddlewareHandler	Von funktionsbasierter Middleware implementierte Signatur. 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 TestAdaptermit getestet wird. type TestActivityInspector = (activity: Partial<Activity>, description: string) => void;
DeleteActivityHandler	Ein Handler, der an Löschaktivitätsereignissen für den aktuellen Turn teilnehmen kann.
SendActivitiesHandler	Ein Handler, der an Sendeaktivitätsereignissen für den aktuellen Turn teilnehmen kann.
UpdateActivityHandler	Ein Handler, der an Updateaktivitä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 Turn-Kontext zu registrieren. Die Middleware registriert die Zustandsobjekte im Turnkontext zu Beginn jedes Turns.
assertBotComponent(unknown, unknown[])
telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)	Protokolliert eine DialogView mithilfe der trackPageView-Methode im 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)	Hilfsprogrammfunktion zum Berechnen eines Änderungshashs für ein StoreItem.

Details zur Funktion

useBotState(BotAdapter, BotState[])

Fügt dem Adapter Middleware hinzu, um ein oder mehrere BotState-Objekte im Turn-Kontext zu registrieren. Die Middleware registriert die Zustandsobjekte im Turnkontext zu Beginn jedes Turns.

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

Parameter

botAdapter

BotAdapter

Der Adapter, auf dem die Zustandsobjekte registriert werden sollen.

botStates

BotState[]

Die zu registrierenden Zustandsobjekte.

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 im 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 BotTelemetryClient implementiert.

dialogName

string

Name des Dialogfelds, für das der Eintrag/Start protokolliert werden soll.

properties

[key: string]: any

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

metrics

[key: string]: number

Diesem Ereignis zugeordnete Messungen.

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 Konfigurationsinstanz .

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 für den Konstruktor bereitgestellte Konfigurationsinstanz sollte über die gewünschten Authentifizierungswerte im Stamm verfügbar sein, 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 Konfigurationsinstanz .

Gibt zurück

ConfigurationServiceClientCredentialFactory

Eine ConfigurationServiceClientCredentialFactory-Instanz .

Hinweise

Die konfigurationsinstanz , die für den 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)

Hilfsprogrammfunktion zum Berechnen eines Änderungshashs für ein StoreItem.

function calculateChangeHash(item: StoreItem): string

Parameter

item

StoreItem

Element, für das der Änderungshash berechnet werden soll.

Gibt zurück

string

Hashzeichenfolge ändern

Hinweise

In diesem Beispiel wird ein Änderungshash für ein Objekt berechnet, das eingelesen wurde, und es dann nur wieder herausgeschrieben, 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 });
}